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/allclasses-frame.html | 332 +++ apidocs/allclasses-noframe.html | 332 +++ apidocs/com/amazon/carbonado/Alias.html | 229 ++ apidocs/com/amazon/carbonado/AlternateKeys.html | 237 +++ apidocs/com/amazon/carbonado/Authoritative.html | 183 ++ apidocs/com/amazon/carbonado/Automatic.html | 181 ++ .../amazon/carbonado/ConfigurationException.html | 311 +++ .../com/amazon/carbonado/ConstraintException.html | 315 +++ .../amazon/carbonado/CorruptEncodingException.html | 395 ++++ apidocs/com/amazon/carbonado/Cursor.html | 431 ++++ apidocs/com/amazon/carbonado/Derived.html | 264 +++ .../amazon/carbonado/FetchDeadlockException.html | 349 +++ apidocs/com/amazon/carbonado/FetchException.html | 309 +++ .../carbonado/FetchInterruptedException.html | 348 +++ .../amazon/carbonado/FetchMultipleException.html | 349 +++ .../com/amazon/carbonado/FetchNoneException.html | 349 +++ .../amazon/carbonado/FetchTimeoutException.html | 348 +++ apidocs/com/amazon/carbonado/Independent.html | 193 ++ apidocs/com/amazon/carbonado/Index.html | 213 ++ apidocs/com/amazon/carbonado/Indexes.html | 239 +++ apidocs/com/amazon/carbonado/IsolationLevel.html | 510 +++++ apidocs/com/amazon/carbonado/Join.html | 314 +++ apidocs/com/amazon/carbonado/Key.html | 217 ++ .../carbonado/MalformedArgumentException.html | 349 +++ .../amazon/carbonado/MalformedFilterException.html | 371 ++++ .../amazon/carbonado/MalformedTypeException.html | 354 ++++ .../com/amazon/carbonado/MismatchException.html | 393 ++++ apidocs/com/amazon/carbonado/Name.html | 228 ++ .../carbonado/NonDurableCommitException.html | 313 +++ apidocs/com/amazon/carbonado/Nullable.html | 177 ++ .../amazon/carbonado/OptimisticLockException.html | 427 ++++ apidocs/com/amazon/carbonado/PartitionKey.html | 228 ++ .../amazon/carbonado/PersistDeadlockException.html | 349 +++ .../amazon/carbonado/PersistDeniedException.html | 311 +++ apidocs/com/amazon/carbonado/PersistException.html | 310 +++ .../carbonado/PersistInterruptedException.html | 350 +++ .../amazon/carbonado/PersistMultipleException.html | 349 +++ .../com/amazon/carbonado/PersistNoneException.html | 349 +++ .../amazon/carbonado/PersistTimeoutException.html | 348 +++ apidocs/com/amazon/carbonado/PrimaryKey.html | 225 ++ apidocs/com/amazon/carbonado/Query.Controller.html | 307 +++ apidocs/com/amazon/carbonado/Query.Timeout.html | 493 +++++ apidocs/com/amazon/carbonado/Query.html | 1431 +++++++++++++ apidocs/com/amazon/carbonado/Repository.html | 422 ++++ .../com/amazon/carbonado/RepositoryBuilder.html | 399 ++++ .../com/amazon/carbonado/RepositoryException.html | 499 +++++ apidocs/com/amazon/carbonado/Sequence.html | 224 ++ apidocs/com/amazon/carbonado/Storable.html | 1116 ++++++++++ apidocs/com/amazon/carbonado/Storage.html | 415 ++++ apidocs/com/amazon/carbonado/SupportException.html | 311 +++ apidocs/com/amazon/carbonado/Transaction.html | 446 ++++ apidocs/com/amazon/carbonado/Trigger.Abort.html | 291 +++ apidocs/com/amazon/carbonado/Trigger.html | 971 +++++++++ apidocs/com/amazon/carbonado/TriggerFactory.html | 223 ++ .../carbonado/UniqueConstraintException.html | 317 +++ .../amazon/carbonado/UnsupportedTypeException.html | 320 +++ apidocs/com/amazon/carbonado/Version.html | 189 ++ .../carbonado/adapter/AdapterDefinition.html | 317 +++ .../carbonado/adapter/DateTimeAdapter.Adapter.html | 1052 +++++++++ .../amazon/carbonado/adapter/DateTimeAdapter.html | 231 ++ .../adapter/PrimitiveArrayAdapter.Adapter.html | 455 ++++ .../carbonado/adapter/PrimitiveArrayAdapter.html | 161 ++ .../carbonado/adapter/TextAdapter.Adapter.html | 370 ++++ .../com/amazon/carbonado/adapter/TextAdapter.html | 253 +++ .../adapter/TrueFalseAdapter.Adapter.html | 470 +++++ .../amazon/carbonado/adapter/TrueFalseAdapter.html | 230 ++ .../carbonado/adapter/YesNoAdapter.Adapter.html | 470 +++++ .../com/amazon/carbonado/adapter/YesNoAdapter.html | 230 ++ .../adapter/class-use/AdapterDefinition.html | 185 ++ .../adapter/class-use/DateTimeAdapter.Adapter.html | 117 + .../adapter/class-use/DateTimeAdapter.html | 159 ++ .../class-use/PrimitiveArrayAdapter.Adapter.html | 117 + .../adapter/class-use/PrimitiveArrayAdapter.html | 159 ++ .../adapter/class-use/TextAdapter.Adapter.html | 117 + .../carbonado/adapter/class-use/TextAdapter.html | 159 ++ .../class-use/TrueFalseAdapter.Adapter.html | 117 + .../adapter/class-use/TrueFalseAdapter.html | 159 ++ .../adapter/class-use/YesNoAdapter.Adapter.html | 117 + .../carbonado/adapter/class-use/YesNoAdapter.html | 159 ++ .../amazon/carbonado/adapter/package-frame.html | 33 + .../amazon/carbonado/adapter/package-summary.html | 219 ++ .../com/amazon/carbonado/adapter/package-tree.html | 143 ++ .../com/amazon/carbonado/adapter/package-use.html | 180 ++ .../amazon/carbonado/capability/Capability.html | 172 ++ .../capability/GroupAccessCapability.html | 220 ++ .../amazon/carbonado/capability/GroupMembers.html | 215 ++ .../com/amazon/carbonado/capability/IndexInfo.html | 294 +++ .../carbonado/capability/IndexInfoCapability.html | 225 ++ .../carbonado/capability/RemoteProcedure.Call.html | 383 ++++ .../capability/RemoteProcedure.Reply.html | 330 +++ .../capability/RemoteProcedure.Request.html | 288 +++ .../carbonado/capability/RemoteProcedure.html | 268 +++ .../capability/RemoteProcedureCapability.html | 237 +++ .../capability/ResyncCapability.Listener.html | 561 +++++ .../carbonado/capability/ResyncCapability.html | 300 +++ .../carbonado/capability/ShutdownCapability.html | 277 +++ .../capability/StorableInfoCapability.html | 265 +++ .../carbonado/capability/class-use/Capability.html | 478 +++++ .../class-use/GroupAccessCapability.html | 117 + .../capability/class-use/GroupMembers.html | 161 ++ .../carbonado/capability/class-use/IndexInfo.html | 266 +++ .../capability/class-use/IndexInfoCapability.html | 117 + .../capability/class-use/RemoteProcedure.Call.html | 186 ++ .../class-use/RemoteProcedure.Reply.html | 186 ++ .../class-use/RemoteProcedure.Request.html | 162 ++ .../capability/class-use/RemoteProcedure.html | 161 ++ .../class-use/RemoteProcedureCapability.html | 117 + .../class-use/ResyncCapability.Listener.html | 165 ++ .../capability/class-use/ResyncCapability.html | 117 + .../capability/class-use/ShutdownCapability.html | 161 ++ .../class-use/StorableInfoCapability.html | 117 + .../amazon/carbonado/capability/package-frame.html | 36 + .../carbonado/capability/package-summary.html | 238 +++ .../amazon/carbonado/capability/package-tree.html | 157 ++ .../amazon/carbonado/capability/package-use.html | 420 ++++ apidocs/com/amazon/carbonado/class-use/Alias.html | 320 +++ .../amazon/carbonado/class-use/AlternateKeys.html | 170 ++ .../amazon/carbonado/class-use/Authoritative.html | 190 ++ .../com/amazon/carbonado/class-use/Automatic.html | 117 + .../class-use/ConfigurationException.html | 338 +++ .../carbonado/class-use/ConstraintException.html | 163 ++ .../class-use/CorruptEncodingException.html | 595 ++++++ apidocs/com/amazon/carbonado/class-use/Cursor.html | 908 ++++++++ .../com/amazon/carbonado/class-use/Derived.html | 117 + .../class-use/FetchDeadlockException.html | 117 + .../amazon/carbonado/class-use/FetchException.html | 2152 +++++++++++++++++++ .../class-use/FetchInterruptedException.html | 117 + .../class-use/FetchMultipleException.html | 117 + .../carbonado/class-use/FetchNoneException.html | 232 ++ .../carbonado/class-use/FetchTimeoutException.html | 159 ++ .../amazon/carbonado/class-use/Independent.html | 291 +++ apidocs/com/amazon/carbonado/class-use/Index.html | 117 + .../com/amazon/carbonado/class-use/Indexes.html | 117 + .../amazon/carbonado/class-use/IsolationLevel.html | 398 ++++ apidocs/com/amazon/carbonado/class-use/Join.html | 117 + apidocs/com/amazon/carbonado/class-use/Key.html | 117 + .../class-use/MalformedArgumentException.html | 169 ++ .../class-use/MalformedFilterException.html | 117 + .../class-use/MalformedTypeException.html | 162 ++ .../carbonado/class-use/MismatchException.html | 117 + apidocs/com/amazon/carbonado/class-use/Name.html | 117 + .../class-use/NonDurableCommitException.html | 117 + .../com/amazon/carbonado/class-use/Nullable.html | 272 +++ .../class-use/OptimisticLockException.html | 117 + .../amazon/carbonado/class-use/PartitionKey.html | 117 + .../class-use/PersistDeadlockException.html | 117 + .../class-use/PersistDeniedException.html | 117 + .../carbonado/class-use/PersistException.html | 1392 ++++++++++++ .../class-use/PersistInterruptedException.html | 117 + .../class-use/PersistMultipleException.html | 117 + .../carbonado/class-use/PersistNoneException.html | 167 ++ .../class-use/PersistTimeoutException.html | 117 + .../com/amazon/carbonado/class-use/PrimaryKey.html | 297 +++ .../carbonado/class-use/Query.Controller.html | 559 +++++ .../amazon/carbonado/class-use/Query.Timeout.html | 191 ++ apidocs/com/amazon/carbonado/class-use/Query.html | 584 +++++ .../com/amazon/carbonado/class-use/Repository.html | 708 +++++++ .../carbonado/class-use/RepositoryBuilder.html | 437 ++++ .../carbonado/class-use/RepositoryException.html | 1140 ++++++++++ .../com/amazon/carbonado/class-use/Sequence.html | 117 + .../com/amazon/carbonado/class-use/Storable.html | 2131 +++++++++++++++++++ .../com/amazon/carbonado/class-use/Storage.html | 346 +++ .../carbonado/class-use/SupportException.html | 713 +++++++ .../amazon/carbonado/class-use/Transaction.html | 414 ++++ .../amazon/carbonado/class-use/Trigger.Abort.html | 184 ++ .../com/amazon/carbonado/class-use/Trigger.html | 341 +++ .../amazon/carbonado/class-use/TriggerFactory.html | 250 +++ .../class-use/UniqueConstraintException.html | 117 + .../class-use/UnsupportedTypeException.html | 117 + .../com/amazon/carbonado/class-use/Version.html | 279 +++ .../carbonado/constraint/ConstraintDefinition.html | 288 +++ .../constraint/FloatConstraint.Constraint.html | 330 +++ .../carbonado/constraint/FloatConstraint.html | 289 +++ .../constraint/IntegerConstraint.Constraint.html | 343 +++ .../carbonado/constraint/IntegerConstraint.html | 293 +++ .../constraint/LengthConstraint.Constraint.html | 404 ++++ .../carbonado/constraint/LengthConstraint.html | 247 +++ .../constraint/TextConstraint.Constraint.html | 326 +++ .../carbonado/constraint/TextConstraint.html | 249 +++ .../constraint/class-use/ConstraintDefinition.html | 179 ++ .../class-use/FloatConstraint.Constraint.html | 117 + .../constraint/class-use/FloatConstraint.html | 159 ++ .../class-use/IntegerConstraint.Constraint.html | 117 + .../constraint/class-use/IntegerConstraint.html | 187 ++ .../class-use/LengthConstraint.Constraint.html | 117 + .../constraint/class-use/LengthConstraint.html | 159 ++ .../class-use/TextConstraint.Constraint.html | 117 + .../constraint/class-use/TextConstraint.html | 159 ++ .../amazon/carbonado/constraint/package-frame.html | 31 + .../carbonado/constraint/package-summary.html | 206 ++ .../amazon/carbonado/constraint/package-tree.html | 141 ++ .../amazon/carbonado/constraint/package-use.html | 197 ++ .../amazon/carbonado/cursor/AbstractCursor.html | 430 ++++ .../amazon/carbonado/cursor/ArraySortBuffer.html | 395 ++++ .../amazon/carbonado/cursor/ControllerCursor.html | 317 +++ .../amazon/carbonado/cursor/DifferenceCursor.html | 341 +++ .../com/amazon/carbonado/cursor/EmptyCursor.html | 401 ++++ .../amazon/carbonado/cursor/FetchAheadCursor.html | 331 +++ .../amazon/carbonado/cursor/FilteredCursor.html | 436 ++++ .../com/amazon/carbonado/cursor/GroupedCursor.html | 488 +++++ .../carbonado/cursor/IntersectionCursor.html | 341 +++ .../amazon/carbonado/cursor/IteratorCursor.html | 348 +++ .../com/amazon/carbonado/cursor/LimitCursor.html | 366 ++++ .../amazon/carbonado/cursor/MergeSortBuffer.html | 546 +++++ .../carbonado/cursor/MultiTransformedCursor.html | 388 ++++ .../amazon/carbonado/cursor/SingletonCursor.html | 475 +++++ .../com/amazon/carbonado/cursor/SkipCursor.html | 366 ++++ .../com/amazon/carbonado/cursor/SortBuffer.html | 274 +++ .../com/amazon/carbonado/cursor/SortedCursor.html | 476 +++++ .../cursor/SymmetricDifferenceCursor.html | 364 ++++ .../amazon/carbonado/cursor/ThrottledCursor.html | 362 ++++ .../amazon/carbonado/cursor/TransformedCursor.html | 387 ++++ .../com/amazon/carbonado/cursor/UnionCursor.html | 341 +++ .../carbonado/cursor/class-use/AbstractCursor.html | 278 +++ .../cursor/class-use/ArraySortBuffer.html | 117 + .../cursor/class-use/ControllerCursor.html | 117 + .../cursor/class-use/DifferenceCursor.html | 117 + .../carbonado/cursor/class-use/EmptyCursor.html | 117 + .../cursor/class-use/FetchAheadCursor.html | 117 + .../carbonado/cursor/class-use/FilteredCursor.html | 117 + .../carbonado/cursor/class-use/GroupedCursor.html | 117 + .../cursor/class-use/IntersectionCursor.html | 117 + .../carbonado/cursor/class-use/IteratorCursor.html | 117 + .../carbonado/cursor/class-use/LimitCursor.html | 117 + .../cursor/class-use/MergeSortBuffer.html | 117 + .../cursor/class-use/MultiTransformedCursor.html | 117 + .../cursor/class-use/SingletonCursor.html | 117 + .../carbonado/cursor/class-use/SkipCursor.html | 117 + .../carbonado/cursor/class-use/SortBuffer.html | 244 +++ .../carbonado/cursor/class-use/SortedCursor.html | 117 + .../class-use/SymmetricDifferenceCursor.html | 117 + .../cursor/class-use/ThrottledCursor.html | 117 + .../cursor/class-use/TransformedCursor.html | 117 + .../carbonado/cursor/class-use/UnionCursor.html | 117 + .../com/amazon/carbonado/cursor/package-frame.html | 43 + .../amazon/carbonado/cursor/package-summary.html | 284 +++ .../com/amazon/carbonado/cursor/package-tree.html | 176 ++ .../com/amazon/carbonado/cursor/package-use.html | 207 ++ apidocs/com/amazon/carbonado/filter/AndFilter.html | 392 ++++ .../amazon/carbonado/filter/BinaryOpFilter.html | 322 +++ .../com/amazon/carbonado/filter/ClosedFilter.html | 589 ++++++ .../com/amazon/carbonado/filter/ExistsFilter.html | 509 +++++ .../amazon/carbonado/filter/Filter.NotJoined.html | 301 +++ apidocs/com/amazon/carbonado/filter/Filter.html | 1151 ++++++++++ .../com/amazon/carbonado/filter/FilterValues.html | 677 ++++++ .../com/amazon/carbonado/filter/OpenFilter.html | 589 ++++++ apidocs/com/amazon/carbonado/filter/OrFilter.html | 392 ++++ .../amazon/carbonado/filter/PropertyFilter.html | 609 ++++++ apidocs/com/amazon/carbonado/filter/RelOp.html | 425 ++++ apidocs/com/amazon/carbonado/filter/Visitor.html | 355 ++++ .../carbonado/filter/class-use/AndFilter.html | 160 ++ .../carbonado/filter/class-use/BinaryOpFilter.html | 167 ++ .../carbonado/filter/class-use/ClosedFilter.html | 196 ++ .../carbonado/filter/class-use/ExistsFilter.html | 181 ++ .../filter/class-use/Filter.NotJoined.html | 169 ++ .../amazon/carbonado/filter/class-use/Filter.html | 1076 ++++++++++ .../carbonado/filter/class-use/FilterValues.html | 742 +++++++ .../carbonado/filter/class-use/OpenFilter.html | 196 ++ .../carbonado/filter/class-use/OrFilter.html | 160 ++ .../carbonado/filter/class-use/PropertyFilter.html | 279 +++ .../amazon/carbonado/filter/class-use/RelOp.html | 219 ++ .../amazon/carbonado/filter/class-use/Visitor.html | 192 ++ .../com/amazon/carbonado/filter/package-frame.html | 33 + .../amazon/carbonado/filter/package-summary.html | 220 ++ .../com/amazon/carbonado/filter/package-tree.html | 158 ++ .../com/amazon/carbonado/filter/package-use.html | 302 +++ .../com/amazon/carbonado/gen/CodeBuilderUtil.html | 792 +++++++ .../amazon/carbonado/gen/CommonMethodNames.html | 1091 ++++++++++ .../carbonado/gen/DelegateStorableGenerator.html | 245 +++ .../com/amazon/carbonado/gen/DelegateSupport.html | 298 +++ .../carbonado/gen/DetachedStorableFactory.html | 267 +++ .../com/amazon/carbonado/gen/MasterFeature.html | 501 +++++ .../carbonado/gen/MasterStorableGenerator.html | 363 ++++ .../com/amazon/carbonado/gen/MasterSupport.html | 246 +++ .../amazon/carbonado/gen/StorableCopier.From.html | 228 ++ .../com/amazon/carbonado/gen/StorableCopier.html | 370 ++++ .../amazon/carbonado/gen/StorableGenerator.html | 755 +++++++ .../amazon/carbonado/gen/StorablePropertyMap.html | 461 ++++ .../com/amazon/carbonado/gen/StorableSupport.html | 237 +++ .../com/amazon/carbonado/gen/TriggerSupport.html | 326 +++ .../carbonado/gen/class-use/CodeBuilderUtil.html | 117 + .../carbonado/gen/class-use/CommonMethodNames.html | 117 + .../gen/class-use/DelegateStorableGenerator.html | 117 + .../carbonado/gen/class-use/DelegateSupport.html | 117 + .../gen/class-use/DetachedStorableFactory.html | 117 + .../carbonado/gen/class-use/MasterFeature.html | 193 ++ .../gen/class-use/MasterStorableGenerator.html | 117 + .../carbonado/gen/class-use/MasterSupport.html | 213 ++ .../gen/class-use/StorableCopier.From.html | 159 ++ .../carbonado/gen/class-use/StorableCopier.html | 159 ++ .../carbonado/gen/class-use/StorableGenerator.html | 117 + .../gen/class-use/StorablePropertyMap.html | 160 ++ .../carbonado/gen/class-use/StorableSupport.html | 225 ++ .../carbonado/gen/class-use/TriggerSupport.html | 219 ++ .../com/amazon/carbonado/gen/package-frame.html | 39 + .../com/amazon/carbonado/gen/package-summary.html | 249 +++ apidocs/com/amazon/carbonado/gen/package-tree.html | 170 ++ apidocs/com/amazon/carbonado/gen/package-use.html | 250 +++ .../com/amazon/carbonado/info/ChainedProperty.html | 625 ++++++ apidocs/com/amazon/carbonado/info/Direction.html | 388 ++++ .../com/amazon/carbonado/info/OrderedProperty.html | 444 ++++ .../com/amazon/carbonado/info/StorableIndex.html | 791 +++++++ .../com/amazon/carbonado/info/StorableInfo.html | 522 +++++ .../carbonado/info/StorableIntrospector.html | 319 +++ apidocs/com/amazon/carbonado/info/StorableKey.html | 245 +++ .../amazon/carbonado/info/StorableProperty.html | 929 ++++++++ .../carbonado/info/StorablePropertyAdapter.html | 432 ++++ .../carbonado/info/StorablePropertyAnnotation.html | 324 +++ .../carbonado/info/StorablePropertyConstraint.html | 264 +++ .../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 ++ .../com/amazon/carbonado/info/package-frame.html | 36 + .../com/amazon/carbonado/info/package-summary.html | 230 ++ .../com/amazon/carbonado/info/package-tree.html | 163 ++ apidocs/com/amazon/carbonado/info/package-use.html | 443 ++++ apidocs/com/amazon/carbonado/layout/Layout.html | 580 +++++ .../amazon/carbonado/layout/LayoutCapability.html | 253 +++ .../com/amazon/carbonado/layout/LayoutFactory.html | 421 ++++ .../com/amazon/carbonado/layout/LayoutOptions.html | 307 +++ .../amazon/carbonado/layout/LayoutProperty.html | 410 ++++ .../com/amazon/carbonado/layout/LayoutSync.html | 268 +++ .../com/amazon/carbonado/layout/StoredLayout.html | 456 ++++ .../carbonado/layout/StoredLayoutEquivalence.html | 354 ++++ .../carbonado/layout/StoredLayoutProperty.html | 543 +++++ .../com/amazon/carbonado/layout/Unevolvable.html | 171 ++ .../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 ++ .../com/amazon/carbonado/layout/package-frame.html | 32 + .../amazon/carbonado/layout/package-summary.html | 230 ++ .../com/amazon/carbonado/layout/package-tree.html | 156 ++ .../com/amazon/carbonado/layout/package-use.html | 252 +++ apidocs/com/amazon/carbonado/lob/AbstractBlob.html | 523 +++++ apidocs/com/amazon/carbonado/lob/AbstractClob.html | 406 ++++ apidocs/com/amazon/carbonado/lob/Blob.html | 564 +++++ apidocs/com/amazon/carbonado/lob/BlobClob.html | 482 +++++ .../com/amazon/carbonado/lob/ByteArrayBlob.html | 487 +++++ .../com/amazon/carbonado/lob/CharArrayClob.html | 509 +++++ apidocs/com/amazon/carbonado/lob/Clob.html | 447 ++++ apidocs/com/amazon/carbonado/lob/FileBlob.html | 468 ++++ apidocs/com/amazon/carbonado/lob/Lob.html | 249 +++ apidocs/com/amazon/carbonado/lob/StringClob.html | 516 +++++ .../carbonado/lob/class-use/AbstractBlob.html | 167 ++ .../carbonado/lob/class-use/AbstractClob.html | 174 ++ .../com/amazon/carbonado/lob/class-use/Blob.html | 379 ++++ .../amazon/carbonado/lob/class-use/BlobClob.html | 117 + .../carbonado/lob/class-use/ByteArrayBlob.html | 117 + .../carbonado/lob/class-use/CharArrayClob.html | 117 + .../com/amazon/carbonado/lob/class-use/Clob.html | 362 ++++ .../amazon/carbonado/lob/class-use/FileBlob.html | 117 + .../com/amazon/carbonado/lob/class-use/Lob.html | 251 +++ .../amazon/carbonado/lob/class-use/StringClob.html | 117 + .../com/amazon/carbonado/lob/package-frame.html | 32 + .../com/amazon/carbonado/lob/package-summary.html | 234 ++ apidocs/com/amazon/carbonado/lob/package-tree.html | 151 ++ apidocs/com/amazon/carbonado/lob/package-use.html | 293 +++ apidocs/com/amazon/carbonado/package-frame.html | 86 + apidocs/com/amazon/carbonado/package-summary.html | 545 +++++ apidocs/com/amazon/carbonado/package-tree.html | 248 +++ apidocs/com/amazon/carbonado/package-use.html | 1352 ++++++++++++ apidocs/com/amazon/carbonado/qe/AbstractQuery.html | 767 +++++++ .../amazon/carbonado/qe/AbstractQueryExecutor.html | 479 +++++ apidocs/com/amazon/carbonado/qe/BoundaryType.html | 347 +++ .../com/amazon/carbonado/qe/CompositeScore.html | 509 +++++ .../carbonado/qe/DelegatedQueryExecutor.html | 557 +++++ .../qe/DelegatedQueryExecutorFactory.html | 298 +++ apidocs/com/amazon/carbonado/qe/EmptyQuery.html | 1051 +++++++++ .../amazon/carbonado/qe/FilteredQueryExecutor.html | 404 ++++ .../com/amazon/carbonado/qe/FilteringScore.html | 932 ++++++++ .../qe/FullScanQueryExecutor.Support.html | 297 +++ .../amazon/carbonado/qe/FullScanQueryExecutor.html | 446 ++++ .../carbonado/qe/IndexedQueryAnalyzer.Result.html | 518 +++++ .../amazon/carbonado/qe/IndexedQueryAnalyzer.html | 316 +++ .../carbonado/qe/IndexedQueryExecutor.Support.html | 375 ++++ .../amazon/carbonado/qe/IndexedQueryExecutor.html | 436 ++++ .../amazon/carbonado/qe/IterableQueryExecutor.html | 386 ++++ .../amazon/carbonado/qe/JoinedQueryExecutor.html | 374 ++++ .../carbonado/qe/KeyQueryExecutor.Support.html | 254 +++ .../com/amazon/carbonado/qe/KeyQueryExecutor.html | 421 ++++ apidocs/com/amazon/carbonado/qe/OrderingList.html | 559 +++++ apidocs/com/amazon/carbonado/qe/OrderingScore.html | 547 +++++ apidocs/com/amazon/carbonado/qe/QueryEngine.html | 329 +++ apidocs/com/amazon/carbonado/qe/QueryExecutor.html | 437 ++++ .../amazon/carbonado/qe/QueryExecutorCache.html | 300 +++ .../amazon/carbonado/qe/QueryExecutorFactory.html | 239 +++ apidocs/com/amazon/carbonado/qe/QueryFactory.html | 241 +++ apidocs/com/amazon/carbonado/qe/QueryHint.html | 320 +++ apidocs/com/amazon/carbonado/qe/QueryHints.html | 387 ++++ .../com/amazon/carbonado/qe/RepositoryAccess.html | 238 +++ .../qe/SortedQueryExecutor.ArraySortSupport.html | 296 +++ .../qe/SortedQueryExecutor.MergeSortSupport.html | 296 +++ .../carbonado/qe/SortedQueryExecutor.Support.html | 241 +++ .../amazon/carbonado/qe/SortedQueryExecutor.html | 494 +++++ apidocs/com/amazon/carbonado/qe/StandardQuery.html | 1368 ++++++++++++ .../amazon/carbonado/qe/StandardQueryFactory.html | 535 +++++ .../com/amazon/carbonado/qe/StorableIndexSet.html | 565 +++++ apidocs/com/amazon/carbonado/qe/StorageAccess.html | 305 +++ .../carbonado/qe/UnionQueryAnalyzer.Result.html | 271 +++ .../amazon/carbonado/qe/UnionQueryAnalyzer.html | 350 +++ .../amazon/carbonado/qe/UnionQueryExecutor.html | 434 ++++ .../carbonado/qe/class-use/AbstractQuery.html | 167 ++ .../qe/class-use/AbstractQueryExecutor.html | 205 ++ .../carbonado/qe/class-use/BoundaryType.html | 206 ++ .../carbonado/qe/class-use/CompositeScore.html | 275 +++ .../qe/class-use/DelegatedQueryExecutor.html | 117 + .../class-use/DelegatedQueryExecutorFactory.html | 117 + .../amazon/carbonado/qe/class-use/EmptyQuery.html | 117 + .../qe/class-use/FilteredQueryExecutor.html | 117 + .../carbonado/qe/class-use/FilteringScore.html | 246 +++ .../class-use/FullScanQueryExecutor.Support.html | 173 ++ .../qe/class-use/FullScanQueryExecutor.html | 117 + .../qe/class-use/IndexedQueryAnalyzer.Result.html | 225 ++ .../qe/class-use/IndexedQueryAnalyzer.html | 117 + .../qe/class-use/IndexedQueryExecutor.Support.html | 175 ++ .../qe/class-use/IndexedQueryExecutor.html | 117 + .../qe/class-use/IterableQueryExecutor.html | 117 + .../qe/class-use/JoinedQueryExecutor.html | 117 + .../qe/class-use/KeyQueryExecutor.Support.html | 175 ++ .../carbonado/qe/class-use/KeyQueryExecutor.html | 117 + .../carbonado/qe/class-use/OrderingList.html | 577 +++++ .../carbonado/qe/class-use/OrderingScore.html | 226 ++ .../amazon/carbonado/qe/class-use/QueryEngine.html | 117 + .../carbonado/qe/class-use/QueryExecutor.html | 331 +++ .../carbonado/qe/class-use/QueryExecutorCache.html | 117 + .../qe/class-use/QueryExecutorFactory.html | 213 ++ .../carbonado/qe/class-use/QueryFactory.html | 202 ++ .../amazon/carbonado/qe/class-use/QueryHint.html | 208 ++ .../amazon/carbonado/qe/class-use/QueryHints.html | 325 +++ .../carbonado/qe/class-use/RepositoryAccess.html | 186 ++ .../SortedQueryExecutor.ArraySortSupport.html | 117 + .../SortedQueryExecutor.MergeSortSupport.html | 117 + .../qe/class-use/SortedQueryExecutor.Support.html | 193 ++ .../qe/class-use/SortedQueryExecutor.html | 117 + .../carbonado/qe/class-use/StandardQuery.html | 180 ++ .../qe/class-use/StandardQueryFactory.html | 161 ++ .../carbonado/qe/class-use/StorableIndexSet.html | 159 ++ .../carbonado/qe/class-use/StorageAccess.html | 162 ++ .../qe/class-use/UnionQueryAnalyzer.Result.html | 161 ++ .../carbonado/qe/class-use/UnionQueryAnalyzer.html | 117 + .../carbonado/qe/class-use/UnionQueryExecutor.html | 117 + apidocs/com/amazon/carbonado/qe/package-frame.html | 63 + .../com/amazon/carbonado/qe/package-summary.html | 398 ++++ apidocs/com/amazon/carbonado/qe/package-tree.html | 223 ++ apidocs/com/amazon/carbonado/qe/package-use.html | 265 +++ .../carbonado/raw/CompressedEncodingStrategy.html | 352 ++++ .../raw/CompressedStorableCodecFactory.html | 329 +++ .../com/amazon/carbonado/raw/CompressionType.html | 332 +++ .../raw/CustomStorableCodec.InstanceFactory.html | 236 +++ .../amazon/carbonado/raw/CustomStorableCodec.html | 603 ++++++ .../carbonado/raw/CustomStorableCodecFactory.html | 386 ++++ apidocs/com/amazon/carbonado/raw/DataDecoder.html | 879 ++++++++ apidocs/com/amazon/carbonado/raw/DataEncoder.html | 920 ++++++++ .../carbonado/raw/GenericEncodingStrategy.html | 1000 +++++++++ .../carbonado/raw/GenericInstanceFactory.html | 250 +++ .../amazon/carbonado/raw/GenericPropertyInfo.html | 324 +++ .../raw/GenericStorableCodec.Decoder.html | 222 ++ .../raw/GenericStorableCodec.SearchKeyFactory.html | 313 +++ .../amazon/carbonado/raw/GenericStorableCodec.html | 702 ++++++ .../carbonado/raw/GenericStorableCodecFactory.html | 406 ++++ .../com/amazon/carbonado/raw/GzipCompressor.html | 294 +++ apidocs/com/amazon/carbonado/raw/KeyDecoder.html | 936 ++++++++ apidocs/com/amazon/carbonado/raw/KeyEncoder.html | 1086 ++++++++++ apidocs/com/amazon/carbonado/raw/RawCursor.html | 854 ++++++++ .../amazon/carbonado/raw/RawStorableGenerator.html | 365 ++++ apidocs/com/amazon/carbonado/raw/RawSupport.html | 452 ++++ apidocs/com/amazon/carbonado/raw/RawUtil.html | 286 +++ .../com/amazon/carbonado/raw/StorableCodec.html | 529 +++++ .../amazon/carbonado/raw/StorableCodecFactory.html | 291 +++ .../amazon/carbonado/raw/StorablePropertyInfo.html | 474 +++++ .../raw/class-use/CompressedEncodingStrategy.html | 117 + .../class-use/CompressedStorableCodecFactory.html | 117 + .../carbonado/raw/class-use/CompressionType.html | 197 ++ .../CustomStorableCodec.InstanceFactory.html | 117 + .../raw/class-use/CustomStorableCodec.html | 205 ++ .../raw/class-use/CustomStorableCodecFactory.html | 117 + .../carbonado/raw/class-use/DataDecoder.html | 117 + .../carbonado/raw/class-use/DataEncoder.html | 117 + .../raw/class-use/GenericEncodingStrategy.html | 192 ++ .../raw/class-use/GenericInstanceFactory.html | 117 + .../raw/class-use/GenericPropertyInfo.html | 160 ++ .../class-use/GenericStorableCodec.Decoder.html | 164 ++ .../GenericStorableCodec.SearchKeyFactory.html | 163 ++ .../raw/class-use/GenericStorableCodec.html | 171 ++ .../raw/class-use/GenericStorableCodecFactory.html | 162 ++ .../carbonado/raw/class-use/GzipCompressor.html | 117 + .../amazon/carbonado/raw/class-use/KeyDecoder.html | 117 + .../amazon/carbonado/raw/class-use/KeyEncoder.html | 117 + .../amazon/carbonado/raw/class-use/RawCursor.html | 117 + .../raw/class-use/RawStorableGenerator.html | 117 + .../amazon/carbonado/raw/class-use/RawSupport.html | 289 +++ .../amazon/carbonado/raw/class-use/RawUtil.html | 117 + .../carbonado/raw/class-use/StorableCodec.html | 193 ++ .../raw/class-use/StorableCodecFactory.html | 217 ++ .../raw/class-use/StorablePropertyInfo.html | 210 ++ .../com/amazon/carbonado/raw/package-frame.html | 50 + .../com/amazon/carbonado/raw/package-summary.html | 319 +++ apidocs/com/amazon/carbonado/raw/package-tree.html | 190 ++ apidocs/com/amazon/carbonado/raw/package-use.html | 236 +++ .../repo/indexed/IndexEntryAccessCapability.html | 226 ++ .../carbonado/repo/indexed/IndexEntryAccessor.html | 346 +++ .../repo/indexed/IndexedRepositoryBuilder.html | 616 ++++++ .../carbonado/repo/indexed/StoredIndexInfo.html | 375 ++++ .../amazon/carbonado/repo/indexed/Unindexed.html | 171 ++ .../class-use/IndexEntryAccessCapability.html | 117 + .../repo/indexed/class-use/IndexEntryAccessor.html | 163 ++ .../class-use/IndexedRepositoryBuilder.html | 117 + .../repo/indexed/class-use/StoredIndexInfo.html | 117 + .../repo/indexed/class-use/Unindexed.html | 189 ++ .../carbonado/repo/indexed/package-frame.html | 27 + .../carbonado/repo/indexed/package-summary.html | 187 ++ .../carbonado/repo/indexed/package-tree.html | 162 ++ .../amazon/carbonado/repo/indexed/package-use.html | 185 ++ .../amazon/carbonado/repo/jdbc/JDBCBlobLoader.html | 215 ++ .../amazon/carbonado/repo/jdbc/JDBCClobLoader.html | 215 ++ .../repo/jdbc/JDBCConnectionCapability.html | 370 ++++ .../carbonado/repo/jdbc/JDBCRepositoryBuilder.html | 947 +++++++++ .../carbonado/repo/jdbc/JDBCStorableInfo.html | 423 ++++ .../repo/jdbc/JDBCStorableIntrospector.html | 297 +++ .../carbonado/repo/jdbc/JDBCStorableProperty.html | 554 +++++ .../amazon/carbonado/repo/jdbc/JDBCSupport.html | 348 +++ .../carbonado/repo/jdbc/LoggingDataSource.html | 447 ++++ .../carbonado/repo/jdbc/SimpleDataSource.html | 501 +++++ .../repo/jdbc/class-use/JDBCBlobLoader.html | 161 ++ .../repo/jdbc/class-use/JDBCClobLoader.html | 161 ++ .../jdbc/class-use/JDBCConnectionCapability.html | 177 ++ .../repo/jdbc/class-use/JDBCRepositoryBuilder.html | 117 + .../repo/jdbc/class-use/JDBCStorableInfo.html | 165 ++ .../jdbc/class-use/JDBCStorableIntrospector.html | 117 + .../repo/jdbc/class-use/JDBCStorableProperty.html | 203 ++ .../carbonado/repo/jdbc/class-use/JDBCSupport.html | 117 + .../repo/jdbc/class-use/LoggingDataSource.html | 117 + .../repo/jdbc/class-use/SimpleDataSource.html | 117 + .../amazon/carbonado/repo/jdbc/package-frame.html | 32 + .../carbonado/repo/jdbc/package-summary.html | 218 ++ .../amazon/carbonado/repo/jdbc/package-tree.html | 191 ++ .../amazon/carbonado/repo/jdbc/package-use.html | 177 ++ .../amazon/carbonado/repo/logging/CommonsLog.html | 299 +++ apidocs/com/amazon/carbonado/repo/logging/Log.html | 228 ++ .../repo/logging/LogAccessCapability.html | 216 ++ .../repo/logging/LoggingRepositoryBuilder.html | 484 +++++ .../repo/logging/class-use/CommonsLog.html | 117 + .../carbonado/repo/logging/class-use/Log.html | 195 ++ .../logging/class-use/LogAccessCapability.html | 117 + .../class-use/LoggingRepositoryBuilder.html | 117 + .../carbonado/repo/logging/package-frame.html | 26 + .../carbonado/repo/logging/package-summary.html | 177 ++ .../carbonado/repo/logging/package-tree.html | 144 ++ .../amazon/carbonado/repo/logging/package-use.html | 154 ++ .../carbonado/repo/map/MapRepositoryBuilder.html | 481 +++++ .../repo/map/class-use/MapRepositoryBuilder.html | 117 + .../amazon/carbonado/repo/map/package-frame.html | 20 + .../amazon/carbonado/repo/map/package-summary.html | 147 ++ .../amazon/carbonado/repo/map/package-tree.html | 134 ++ .../com/amazon/carbonado/repo/map/package-use.html | 117 + .../replicated/ReplicatedRepositoryBuilder.html | 473 +++++ .../class-use/ReplicatedRepositoryBuilder.html | 117 + .../carbonado/repo/replicated/package-frame.html | 20 + .../carbonado/repo/replicated/package-summary.html | 151 ++ .../carbonado/repo/replicated/package-tree.html | 134 ++ .../carbonado/repo/replicated/package-use.html | 117 + .../carbonado/repo/sleepycat/BDBPanicHandler.html | 217 ++ .../carbonado/repo/sleepycat/BDBProduct.html | 392 ++++ .../BDBRepositoryBuilder.DatabaseHook.html | 237 +++ .../repo/sleepycat/BDBRepositoryBuilder.html | 2121 +++++++++++++++++++ .../repo/sleepycat/CheckpointCapability.html | 291 +++ .../sleepycat/CompactionCapability.Result.html | 264 +++ .../repo/sleepycat/CompactionCapability.html | 244 +++ .../repo/sleepycat/EnvironmentCapability.html | 284 +++ .../repo/sleepycat/HotBackupCapability.Backup.html | 309 +++ .../repo/sleepycat/HotBackupCapability.html | 333 +++ .../repo/sleepycat/StoredDatabaseInfo.html | 537 +++++ .../repo/sleepycat/class-use/BDBPanicHandler.html | 177 ++ .../repo/sleepycat/class-use/BDBProduct.html | 198 ++ .../BDBRepositoryBuilder.DatabaseHook.html | 177 ++ .../sleepycat/class-use/BDBRepositoryBuilder.html | 117 + .../sleepycat/class-use/CheckpointCapability.html | 117 + .../class-use/CompactionCapability.Result.html | 162 ++ .../sleepycat/class-use/CompactionCapability.html | 117 + .../sleepycat/class-use/EnvironmentCapability.html | 117 + .../class-use/HotBackupCapability.Backup.html | 181 ++ .../sleepycat/class-use/HotBackupCapability.html | 117 + .../sleepycat/class-use/StoredDatabaseInfo.html | 117 + .../carbonado/repo/sleepycat/package-frame.html | 36 + .../carbonado/repo/sleepycat/package-summary.html | 228 ++ .../carbonado/repo/sleepycat/package-tree.html | 162 ++ .../carbonado/repo/sleepycat/package-use.html | 169 ++ .../sequence/AbstractSequenceValueProducer.html | 363 ++++ .../carbonado/sequence/SequenceCapability.html | 229 ++ .../carbonado/sequence/SequenceValueGenerator.html | 512 +++++ .../carbonado/sequence/SequenceValueProducer.html | 345 +++ .../sequence/SequenceValueProducerPool.html | 347 +++ .../amazon/carbonado/sequence/StoredSequence.html | 343 +++ .../class-use/AbstractSequenceValueProducer.html | 162 ++ .../sequence/class-use/SequenceCapability.html | 161 ++ .../sequence/class-use/SequenceValueGenerator.html | 117 + .../sequence/class-use/SequenceValueProducer.html | 264 +++ .../class-use/SequenceValueProducerPool.html | 117 + .../sequence/class-use/StoredSequence.html | 117 + .../amazon/carbonado/sequence/package-frame.html | 28 + .../amazon/carbonado/sequence/package-summary.html | 192 ++ .../amazon/carbonado/sequence/package-tree.html | 153 ++ .../com/amazon/carbonado/sequence/package-use.html | 209 ++ .../amazon/carbonado/spi/AbstractRepository.html | 759 +++++++ .../carbonado/spi/AbstractRepositoryBuilder.html | 405 ++++ .../carbonado/spi/BelatedRepositoryCreator.html | 361 ++++ .../carbonado/spi/BelatedStorageCreator.html | 343 +++ .../amazon/carbonado/spi/ExceptionTransformer.html | 387 ++++ .../com/amazon/carbonado/spi/IndexInfoImpl.html | 393 ++++ apidocs/com/amazon/carbonado/spi/LobEngine.html | 560 +++++ .../com/amazon/carbonado/spi/RAFInputStream.html | 370 ++++ .../com/amazon/carbonado/spi/RAFOutputStream.html | 351 +++ .../com/amazon/carbonado/spi/RepairExecutor.html | 271 +++ apidocs/com/amazon/carbonado/spi/StoragePool.html | 333 +++ .../com/amazon/carbonado/spi/StoredLob.Block.html | 373 ++++ apidocs/com/amazon/carbonado/spi/StoredLob.html | 425 ++++ .../com/amazon/carbonado/spi/StoredSequence.html | 320 +++ .../com/amazon/carbonado/spi/TriggerManager.html | 1324 ++++++++++++ .../carbonado/spi/TriggerManagerCapability.html | 222 ++ .../spi/class-use/AbstractRepository.html | 117 + .../spi/class-use/AbstractRepositoryBuilder.html | 295 +++ .../spi/class-use/BelatedRepositoryCreator.html | 117 + .../spi/class-use/BelatedStorageCreator.html | 117 + .../spi/class-use/ExceptionTransformer.html | 161 ++ .../carbonado/spi/class-use/IndexInfoImpl.html | 117 + .../amazon/carbonado/spi/class-use/LobEngine.html | 117 + .../carbonado/spi/class-use/RAFInputStream.html | 117 + .../carbonado/spi/class-use/RAFOutputStream.html | 117 + .../carbonado/spi/class-use/RepairExecutor.html | 117 + .../carbonado/spi/class-use/StoragePool.html | 117 + .../carbonado/spi/class-use/StoredLob.Block.html | 117 + .../amazon/carbonado/spi/class-use/StoredLob.html | 117 + .../carbonado/spi/class-use/StoredSequence.html | 117 + .../carbonado/spi/class-use/TriggerManager.html | 161 ++ .../spi/class-use/TriggerManagerCapability.html | 117 + .../com/amazon/carbonado/spi/package-frame.html | 38 + .../com/amazon/carbonado/spi/package-summary.html | 254 +++ apidocs/com/amazon/carbonado/spi/package-tree.html | 176 ++ apidocs/com/amazon/carbonado/spi/package-use.html | 303 +++ .../carbonado/synthetic/ClassFileBuilder.html | 347 +++ .../SyntheticBuilder.ClassNameProvider.html | 233 ++ .../carbonado/synthetic/SyntheticBuilder.html | 413 ++++ .../amazon/carbonado/synthetic/SyntheticIndex.html | 206 ++ .../amazon/carbonado/synthetic/SyntheticKey.html | 206 ++ .../carbonado/synthetic/SyntheticProperty.html | 570 +++++ .../carbonado/synthetic/SyntheticPropertyList.html | 289 +++ .../synthetic/SyntheticStorableBuilder.html | 621 ++++++ .../SyntheticStorableReferenceAccess.html | 346 +++ .../SyntheticStorableReferenceBuilder.html | 727 +++++++ .../synthetic/class-use/ClassFileBuilder.html | 168 ++ .../SyntheticBuilder.ClassNameProvider.html | 173 ++ .../synthetic/class-use/SyntheticBuilder.html | 169 ++ .../synthetic/class-use/SyntheticIndex.html | 170 ++ .../synthetic/class-use/SyntheticKey.html | 184 ++ .../synthetic/class-use/SyntheticProperty.html | 251 +++ .../synthetic/class-use/SyntheticPropertyList.html | 168 ++ .../class-use/SyntheticStorableBuilder.html | 117 + .../SyntheticStorableReferenceAccess.html | 162 ++ .../SyntheticStorableReferenceBuilder.html | 117 + .../amazon/carbonado/synthetic/package-frame.html | 32 + .../carbonado/synthetic/package-summary.html | 216 ++ .../amazon/carbonado/synthetic/package-tree.html | 145 ++ .../amazon/carbonado/synthetic/package-use.html | 192 ++ .../amazon/carbonado/txn/TransactionManager.html | 573 +++++ .../amazon/carbonado/txn/TransactionMonitor.html | 239 +++ .../com/amazon/carbonado/txn/TransactionPair.html | 502 +++++ .../com/amazon/carbonado/txn/TransactionScope.html | 392 ++++ .../txn/class-use/TransactionManager.html | 161 ++ .../txn/class-use/TransactionMonitor.html | 157 ++ .../carbonado/txn/class-use/TransactionPair.html | 117 + .../carbonado/txn/class-use/TransactionScope.html | 193 ++ .../com/amazon/carbonado/txn/package-frame.html | 26 + .../com/amazon/carbonado/txn/package-summary.html | 175 ++ apidocs/com/amazon/carbonado/txn/package-tree.html | 136 ++ apidocs/com/amazon/carbonado/txn/package-use.html | 187 ++ .../com/amazon/carbonado/util/AbstractPool.html | 348 +++ .../amazon/carbonado/util/AnnotationBuilder.html | 934 ++++++++ .../carbonado/util/AnnotationDescParser.html | 291 +++ .../carbonado/util/AnnotationDescPrinter.html | 988 +++++++++ .../amazon/carbonado/util/AnnotationPrinter.html | 956 +++++++++ .../amazon/carbonado/util/AnnotationVisitor.html | 903 ++++++++ apidocs/com/amazon/carbonado/util/Appender.html | 228 ++ .../carbonado/util/BelatedCreationException.html | 289 +++ .../com/amazon/carbonado/util/BelatedCreator.html | 371 ++++ apidocs/com/amazon/carbonado/util/Comparators.html | 270 +++ .../carbonado/util/ConversionComparator.html | 302 +++ apidocs/com/amazon/carbonado/util/Converter.html | 453 ++++ .../carbonado/util/QuickConstructorGenerator.html | 314 +++ .../com/amazon/carbonado/util/SoftValuedCache.html | 478 +++++ .../com/amazon/carbonado/util/TaskQueueThread.html | 402 ++++ apidocs/com/amazon/carbonado/util/Throttle.html | 300 +++ .../com/amazon/carbonado/util/ThrowUnchecked.html | 495 +++++ .../carbonado/util/class-use/AbstractPool.html | 190 ++ .../util/class-use/AnnotationBuilder.html | 117 + .../util/class-use/AnnotationDescParser.html | 117 + .../util/class-use/AnnotationDescPrinter.html | 117 + .../util/class-use/AnnotationPrinter.html | 117 + .../util/class-use/AnnotationVisitor.html | 175 ++ .../amazon/carbonado/util/class-use/Appender.html | 335 +++ .../util/class-use/BelatedCreationException.html | 117 + .../carbonado/util/class-use/BelatedCreator.html | 167 ++ .../carbonado/util/class-use/Comparators.html | 117 + .../util/class-use/ConversionComparator.html | 117 + .../amazon/carbonado/util/class-use/Converter.html | 164 ++ .../util/class-use/QuickConstructorGenerator.html | 117 + .../carbonado/util/class-use/SoftValuedCache.html | 162 ++ .../carbonado/util/class-use/TaskQueueThread.html | 117 + .../amazon/carbonado/util/class-use/Throttle.html | 117 + .../carbonado/util/class-use/ThrowUnchecked.html | 117 + .../com/amazon/carbonado/util/package-frame.html | 42 + .../com/amazon/carbonado/util/package-summary.html | 270 +++ .../com/amazon/carbonado/util/package-tree.html | 172 ++ apidocs/com/amazon/carbonado/util/package-use.html | 316 +++ apidocs/constant-values.html | 814 +++++++ apidocs/deprecated-list.html | 218 ++ apidocs/help-doc.html | 222 ++ apidocs/index-files/index-1.html | 949 +++++++++ apidocs/index-files/index-10.html | 167 ++ apidocs/index-files/index-11.html | 152 ++ apidocs/index-files/index-12.html | 341 +++ apidocs/index-files/index-13.html | 355 ++++ apidocs/index-files/index-14.html | 283 +++ apidocs/index-files/index-15.html | 346 +++ apidocs/index-files/index-16.html | 442 ++++ apidocs/index-files/index-17.html | 230 ++ apidocs/index-files/index-18.html | 416 ++++ apidocs/index-files/index-19.html | 1331 ++++++++++++ apidocs/index-files/index-2.html | 415 ++++ apidocs/index-files/index-20.html | 611 ++++++ apidocs/index-files/index-21.html | 238 +++ apidocs/index-files/index-22.html | 481 +++++ apidocs/index-files/index-23.html | 338 +++ apidocs/index-files/index-24.html | 136 ++ apidocs/index-files/index-3.html | 1109 ++++++++++ apidocs/index-files/index-4.html | 622 ++++++ apidocs/index-files/index-5.html | 764 +++++++ apidocs/index-files/index-6.html | 588 ++++++ apidocs/index-files/index-7.html | 2226 ++++++++++++++++++++ apidocs/index-files/index-8.html | 273 +++ apidocs/index-files/index-9.html | 765 +++++++ apidocs/index.html | 68 + apidocs/overview-frame.html | 43 + apidocs/overview-summary.html | 319 +++ apidocs/overview-tree.html | 717 +++++++ apidocs/package-list | 23 + apidocs/resources/background.gif | Bin 0 -> 2313 bytes apidocs/resources/tab.gif | Bin 0 -> 291 bytes apidocs/resources/titlebar.gif | Bin 0 -> 10701 bytes apidocs/resources/titlebar_end.gif | Bin 0 -> 849 bytes apidocs/serialized-form.html | 903 ++++++++ apidocs/stylesheet.css | 474 +++++ docs/CarbonadoGuide.pdf | Bin 0 -> 481887 bytes 767 files changed, 231688 insertions(+) create mode 100644 apidocs/allclasses-frame.html create mode 100644 apidocs/allclasses-noframe.html create mode 100644 apidocs/com/amazon/carbonado/Alias.html create mode 100644 apidocs/com/amazon/carbonado/AlternateKeys.html create mode 100644 apidocs/com/amazon/carbonado/Authoritative.html create mode 100644 apidocs/com/amazon/carbonado/Automatic.html create mode 100644 apidocs/com/amazon/carbonado/ConfigurationException.html create mode 100644 apidocs/com/amazon/carbonado/ConstraintException.html create mode 100644 apidocs/com/amazon/carbonado/CorruptEncodingException.html create mode 100644 apidocs/com/amazon/carbonado/Cursor.html create mode 100644 apidocs/com/amazon/carbonado/Derived.html create mode 100644 apidocs/com/amazon/carbonado/FetchDeadlockException.html create mode 100644 apidocs/com/amazon/carbonado/FetchException.html create mode 100644 apidocs/com/amazon/carbonado/FetchInterruptedException.html create mode 100644 apidocs/com/amazon/carbonado/FetchMultipleException.html create mode 100644 apidocs/com/amazon/carbonado/FetchNoneException.html create mode 100644 apidocs/com/amazon/carbonado/FetchTimeoutException.html create mode 100644 apidocs/com/amazon/carbonado/Independent.html create mode 100644 apidocs/com/amazon/carbonado/Index.html create mode 100644 apidocs/com/amazon/carbonado/Indexes.html create mode 100644 apidocs/com/amazon/carbonado/IsolationLevel.html create mode 100644 apidocs/com/amazon/carbonado/Join.html create mode 100644 apidocs/com/amazon/carbonado/Key.html create mode 100644 apidocs/com/amazon/carbonado/MalformedArgumentException.html create mode 100644 apidocs/com/amazon/carbonado/MalformedFilterException.html create mode 100644 apidocs/com/amazon/carbonado/MalformedTypeException.html create mode 100644 apidocs/com/amazon/carbonado/MismatchException.html create mode 100644 apidocs/com/amazon/carbonado/Name.html create mode 100644 apidocs/com/amazon/carbonado/NonDurableCommitException.html create mode 100644 apidocs/com/amazon/carbonado/Nullable.html create mode 100644 apidocs/com/amazon/carbonado/OptimisticLockException.html create mode 100644 apidocs/com/amazon/carbonado/PartitionKey.html create mode 100644 apidocs/com/amazon/carbonado/PersistDeadlockException.html create mode 100644 apidocs/com/amazon/carbonado/PersistDeniedException.html create mode 100644 apidocs/com/amazon/carbonado/PersistException.html create mode 100644 apidocs/com/amazon/carbonado/PersistInterruptedException.html create mode 100644 apidocs/com/amazon/carbonado/PersistMultipleException.html create mode 100644 apidocs/com/amazon/carbonado/PersistNoneException.html create mode 100644 apidocs/com/amazon/carbonado/PersistTimeoutException.html create mode 100644 apidocs/com/amazon/carbonado/PrimaryKey.html create mode 100644 apidocs/com/amazon/carbonado/Query.Controller.html create mode 100644 apidocs/com/amazon/carbonado/Query.Timeout.html create mode 100644 apidocs/com/amazon/carbonado/Query.html create mode 100644 apidocs/com/amazon/carbonado/Repository.html create mode 100644 apidocs/com/amazon/carbonado/RepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/RepositoryException.html create mode 100644 apidocs/com/amazon/carbonado/Sequence.html create mode 100644 apidocs/com/amazon/carbonado/Storable.html create mode 100644 apidocs/com/amazon/carbonado/Storage.html create mode 100644 apidocs/com/amazon/carbonado/SupportException.html create mode 100644 apidocs/com/amazon/carbonado/Transaction.html create mode 100644 apidocs/com/amazon/carbonado/Trigger.Abort.html create mode 100644 apidocs/com/amazon/carbonado/Trigger.html create mode 100644 apidocs/com/amazon/carbonado/TriggerFactory.html create mode 100644 apidocs/com/amazon/carbonado/UniqueConstraintException.html create mode 100644 apidocs/com/amazon/carbonado/UnsupportedTypeException.html create mode 100644 apidocs/com/amazon/carbonado/Version.html create mode 100644 apidocs/com/amazon/carbonado/adapter/AdapterDefinition.html create mode 100644 apidocs/com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/DateTimeAdapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/TextAdapter.Adapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/TextAdapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/TrueFalseAdapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/YesNoAdapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/class-use/AdapterDefinition.html create mode 100644 apidocs/com/amazon/carbonado/adapter/class-use/DateTimeAdapter.Adapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/class-use/DateTimeAdapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.Adapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/class-use/TextAdapter.Adapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/class-use/TextAdapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/class-use/TrueFalseAdapter.Adapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/class-use/TrueFalseAdapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/class-use/YesNoAdapter.Adapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/class-use/YesNoAdapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/adapter/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/adapter/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/adapter/package-use.html create mode 100644 apidocs/com/amazon/carbonado/capability/Capability.html create mode 100644 apidocs/com/amazon/carbonado/capability/GroupAccessCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/GroupMembers.html create mode 100644 apidocs/com/amazon/carbonado/capability/IndexInfo.html create mode 100644 apidocs/com/amazon/carbonado/capability/IndexInfoCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/RemoteProcedure.Call.html create mode 100644 apidocs/com/amazon/carbonado/capability/RemoteProcedure.Reply.html create mode 100644 apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html create mode 100644 apidocs/com/amazon/carbonado/capability/RemoteProcedure.html create mode 100644 apidocs/com/amazon/carbonado/capability/RemoteProcedureCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/ResyncCapability.Listener.html create mode 100644 apidocs/com/amazon/carbonado/capability/ResyncCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/ShutdownCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/StorableInfoCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/Capability.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/GroupAccessCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/GroupMembers.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/IndexInfo.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/IndexInfoCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Call.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Reply.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Request.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedureCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.Listener.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/ShutdownCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/StorableInfoCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/capability/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/capability/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/capability/package-use.html create mode 100644 apidocs/com/amazon/carbonado/class-use/Alias.html create mode 100644 apidocs/com/amazon/carbonado/class-use/AlternateKeys.html create mode 100644 apidocs/com/amazon/carbonado/class-use/Authoritative.html create mode 100644 apidocs/com/amazon/carbonado/class-use/Automatic.html create mode 100644 apidocs/com/amazon/carbonado/class-use/ConfigurationException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/ConstraintException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/CorruptEncodingException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/Cursor.html create mode 100644 apidocs/com/amazon/carbonado/class-use/Derived.html create mode 100644 apidocs/com/amazon/carbonado/class-use/FetchDeadlockException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/FetchException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/FetchInterruptedException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/FetchMultipleException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/FetchNoneException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/FetchTimeoutException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/Independent.html create mode 100644 apidocs/com/amazon/carbonado/class-use/Index.html create mode 100644 apidocs/com/amazon/carbonado/class-use/Indexes.html create mode 100644 apidocs/com/amazon/carbonado/class-use/IsolationLevel.html create mode 100644 apidocs/com/amazon/carbonado/class-use/Join.html create mode 100644 apidocs/com/amazon/carbonado/class-use/Key.html create mode 100644 apidocs/com/amazon/carbonado/class-use/MalformedArgumentException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/MalformedFilterException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/MalformedTypeException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/MismatchException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/Name.html create mode 100644 apidocs/com/amazon/carbonado/class-use/NonDurableCommitException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/Nullable.html create mode 100644 apidocs/com/amazon/carbonado/class-use/OptimisticLockException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/PartitionKey.html create mode 100644 apidocs/com/amazon/carbonado/class-use/PersistDeadlockException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/PersistDeniedException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/PersistException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/PersistInterruptedException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/PersistMultipleException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/PersistNoneException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/PersistTimeoutException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/PrimaryKey.html create mode 100644 apidocs/com/amazon/carbonado/class-use/Query.Controller.html create mode 100644 apidocs/com/amazon/carbonado/class-use/Query.Timeout.html create mode 100644 apidocs/com/amazon/carbonado/class-use/Query.html create mode 100644 apidocs/com/amazon/carbonado/class-use/Repository.html create mode 100644 apidocs/com/amazon/carbonado/class-use/RepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/class-use/RepositoryException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/Sequence.html create mode 100644 apidocs/com/amazon/carbonado/class-use/Storable.html create mode 100644 apidocs/com/amazon/carbonado/class-use/Storage.html create mode 100644 apidocs/com/amazon/carbonado/class-use/SupportException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/Transaction.html create mode 100644 apidocs/com/amazon/carbonado/class-use/Trigger.Abort.html create mode 100644 apidocs/com/amazon/carbonado/class-use/Trigger.html create mode 100644 apidocs/com/amazon/carbonado/class-use/TriggerFactory.html create mode 100644 apidocs/com/amazon/carbonado/class-use/UniqueConstraintException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/UnsupportedTypeException.html create mode 100644 apidocs/com/amazon/carbonado/class-use/Version.html create mode 100644 apidocs/com/amazon/carbonado/constraint/ConstraintDefinition.html create mode 100644 apidocs/com/amazon/carbonado/constraint/FloatConstraint.Constraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/FloatConstraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/IntegerConstraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/LengthConstraint.Constraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/LengthConstraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/TextConstraint.Constraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/TextConstraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/class-use/ConstraintDefinition.html create mode 100644 apidocs/com/amazon/carbonado/constraint/class-use/FloatConstraint.Constraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/class-use/FloatConstraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/class-use/IntegerConstraint.Constraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/class-use/IntegerConstraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/class-use/LengthConstraint.Constraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/class-use/LengthConstraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/class-use/TextConstraint.Constraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/class-use/TextConstraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/constraint/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/constraint/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/constraint/package-use.html create mode 100644 apidocs/com/amazon/carbonado/cursor/AbstractCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/ArraySortBuffer.html create mode 100644 apidocs/com/amazon/carbonado/cursor/ControllerCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/DifferenceCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/EmptyCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/FetchAheadCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/FilteredCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/GroupedCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/IntersectionCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/IteratorCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/LimitCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/MergeSortBuffer.html create mode 100644 apidocs/com/amazon/carbonado/cursor/MultiTransformedCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/SingletonCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/SkipCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/SortBuffer.html create mode 100644 apidocs/com/amazon/carbonado/cursor/SortedCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/ThrottledCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/TransformedCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/UnionCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/AbstractCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/ArraySortBuffer.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/ControllerCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/DifferenceCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/EmptyCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/FetchAheadCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/FilteredCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/GroupedCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/IntersectionCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/IteratorCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/LimitCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/MergeSortBuffer.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/MultiTransformedCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/SingletonCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/SkipCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/SortBuffer.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/SortedCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/SymmetricDifferenceCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/ThrottledCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/TransformedCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/UnionCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/cursor/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/cursor/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/cursor/package-use.html create mode 100644 apidocs/com/amazon/carbonado/filter/AndFilter.html create mode 100644 apidocs/com/amazon/carbonado/filter/BinaryOpFilter.html create mode 100644 apidocs/com/amazon/carbonado/filter/ClosedFilter.html create mode 100644 apidocs/com/amazon/carbonado/filter/ExistsFilter.html create mode 100644 apidocs/com/amazon/carbonado/filter/Filter.NotJoined.html create mode 100644 apidocs/com/amazon/carbonado/filter/Filter.html create mode 100644 apidocs/com/amazon/carbonado/filter/FilterValues.html create mode 100644 apidocs/com/amazon/carbonado/filter/OpenFilter.html create mode 100644 apidocs/com/amazon/carbonado/filter/OrFilter.html create mode 100644 apidocs/com/amazon/carbonado/filter/PropertyFilter.html create mode 100644 apidocs/com/amazon/carbonado/filter/RelOp.html create mode 100644 apidocs/com/amazon/carbonado/filter/Visitor.html create mode 100644 apidocs/com/amazon/carbonado/filter/class-use/AndFilter.html create mode 100644 apidocs/com/amazon/carbonado/filter/class-use/BinaryOpFilter.html create mode 100644 apidocs/com/amazon/carbonado/filter/class-use/ClosedFilter.html create mode 100644 apidocs/com/amazon/carbonado/filter/class-use/ExistsFilter.html create mode 100644 apidocs/com/amazon/carbonado/filter/class-use/Filter.NotJoined.html create mode 100644 apidocs/com/amazon/carbonado/filter/class-use/Filter.html create mode 100644 apidocs/com/amazon/carbonado/filter/class-use/FilterValues.html create mode 100644 apidocs/com/amazon/carbonado/filter/class-use/OpenFilter.html create mode 100644 apidocs/com/amazon/carbonado/filter/class-use/OrFilter.html create mode 100644 apidocs/com/amazon/carbonado/filter/class-use/PropertyFilter.html create mode 100644 apidocs/com/amazon/carbonado/filter/class-use/RelOp.html create mode 100644 apidocs/com/amazon/carbonado/filter/class-use/Visitor.html create mode 100644 apidocs/com/amazon/carbonado/filter/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/filter/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/filter/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/filter/package-use.html create mode 100644 apidocs/com/amazon/carbonado/gen/CodeBuilderUtil.html create mode 100644 apidocs/com/amazon/carbonado/gen/CommonMethodNames.html create mode 100644 apidocs/com/amazon/carbonado/gen/DelegateStorableGenerator.html create mode 100644 apidocs/com/amazon/carbonado/gen/DelegateSupport.html create mode 100644 apidocs/com/amazon/carbonado/gen/DetachedStorableFactory.html create mode 100644 apidocs/com/amazon/carbonado/gen/MasterFeature.html create mode 100644 apidocs/com/amazon/carbonado/gen/MasterStorableGenerator.html create mode 100644 apidocs/com/amazon/carbonado/gen/MasterSupport.html create mode 100644 apidocs/com/amazon/carbonado/gen/StorableCopier.From.html create mode 100644 apidocs/com/amazon/carbonado/gen/StorableCopier.html create mode 100644 apidocs/com/amazon/carbonado/gen/StorableGenerator.html create mode 100644 apidocs/com/amazon/carbonado/gen/StorablePropertyMap.html create mode 100644 apidocs/com/amazon/carbonado/gen/StorableSupport.html create mode 100644 apidocs/com/amazon/carbonado/gen/TriggerSupport.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/CodeBuilderUtil.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/CommonMethodNames.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/DelegateStorableGenerator.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/DelegateSupport.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/DetachedStorableFactory.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/MasterFeature.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/MasterStorableGenerator.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/MasterSupport.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/StorableCopier.From.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/StorableCopier.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/StorableGenerator.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/StorablePropertyMap.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/StorableSupport.html create mode 100644 apidocs/com/amazon/carbonado/gen/class-use/TriggerSupport.html create mode 100644 apidocs/com/amazon/carbonado/gen/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/gen/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/gen/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/gen/package-use.html create mode 100644 apidocs/com/amazon/carbonado/info/ChainedProperty.html create mode 100644 apidocs/com/amazon/carbonado/info/Direction.html create mode 100644 apidocs/com/amazon/carbonado/info/OrderedProperty.html create mode 100644 apidocs/com/amazon/carbonado/info/StorableIndex.html create mode 100644 apidocs/com/amazon/carbonado/info/StorableInfo.html create mode 100644 apidocs/com/amazon/carbonado/info/StorableIntrospector.html create mode 100644 apidocs/com/amazon/carbonado/info/StorableKey.html create mode 100644 apidocs/com/amazon/carbonado/info/StorableProperty.html create mode 100644 apidocs/com/amazon/carbonado/info/StorablePropertyAdapter.html create mode 100644 apidocs/com/amazon/carbonado/info/StorablePropertyAnnotation.html create mode 100644 apidocs/com/amazon/carbonado/info/StorablePropertyConstraint.html 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 create mode 100644 apidocs/com/amazon/carbonado/info/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/info/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/info/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/info/package-use.html create mode 100644 apidocs/com/amazon/carbonado/layout/Layout.html create mode 100644 apidocs/com/amazon/carbonado/layout/LayoutCapability.html create mode 100644 apidocs/com/amazon/carbonado/layout/LayoutFactory.html create mode 100644 apidocs/com/amazon/carbonado/layout/LayoutOptions.html create mode 100644 apidocs/com/amazon/carbonado/layout/LayoutProperty.html create mode 100644 apidocs/com/amazon/carbonado/layout/LayoutSync.html create mode 100644 apidocs/com/amazon/carbonado/layout/StoredLayout.html create mode 100644 apidocs/com/amazon/carbonado/layout/StoredLayoutEquivalence.html create mode 100644 apidocs/com/amazon/carbonado/layout/StoredLayoutProperty.html create mode 100644 apidocs/com/amazon/carbonado/layout/Unevolvable.html 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 create mode 100644 apidocs/com/amazon/carbonado/layout/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/layout/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/layout/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/layout/package-use.html create mode 100644 apidocs/com/amazon/carbonado/lob/AbstractBlob.html create mode 100644 apidocs/com/amazon/carbonado/lob/AbstractClob.html create mode 100644 apidocs/com/amazon/carbonado/lob/Blob.html create mode 100644 apidocs/com/amazon/carbonado/lob/BlobClob.html create mode 100644 apidocs/com/amazon/carbonado/lob/ByteArrayBlob.html create mode 100644 apidocs/com/amazon/carbonado/lob/CharArrayClob.html create mode 100644 apidocs/com/amazon/carbonado/lob/Clob.html create mode 100644 apidocs/com/amazon/carbonado/lob/FileBlob.html create mode 100644 apidocs/com/amazon/carbonado/lob/Lob.html create mode 100644 apidocs/com/amazon/carbonado/lob/StringClob.html create mode 100644 apidocs/com/amazon/carbonado/lob/class-use/AbstractBlob.html create mode 100644 apidocs/com/amazon/carbonado/lob/class-use/AbstractClob.html create mode 100644 apidocs/com/amazon/carbonado/lob/class-use/Blob.html create mode 100644 apidocs/com/amazon/carbonado/lob/class-use/BlobClob.html create mode 100644 apidocs/com/amazon/carbonado/lob/class-use/ByteArrayBlob.html create mode 100644 apidocs/com/amazon/carbonado/lob/class-use/CharArrayClob.html create mode 100644 apidocs/com/amazon/carbonado/lob/class-use/Clob.html create mode 100644 apidocs/com/amazon/carbonado/lob/class-use/FileBlob.html create mode 100644 apidocs/com/amazon/carbonado/lob/class-use/Lob.html create mode 100644 apidocs/com/amazon/carbonado/lob/class-use/StringClob.html create mode 100644 apidocs/com/amazon/carbonado/lob/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/lob/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/lob/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/lob/package-use.html create mode 100644 apidocs/com/amazon/carbonado/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/package-use.html create mode 100644 apidocs/com/amazon/carbonado/qe/AbstractQuery.html create mode 100644 apidocs/com/amazon/carbonado/qe/AbstractQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/BoundaryType.html create mode 100644 apidocs/com/amazon/carbonado/qe/CompositeScore.html create mode 100644 apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html create mode 100644 apidocs/com/amazon/carbonado/qe/EmptyQuery.html create mode 100644 apidocs/com/amazon/carbonado/qe/FilteredQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/FilteringScore.html create mode 100644 apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html create mode 100644 apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html create mode 100644 apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.html create mode 100644 apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html create mode 100644 apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/IterableQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/JoinedQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.Support.html create mode 100644 apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/OrderingList.html create mode 100644 apidocs/com/amazon/carbonado/qe/OrderingScore.html create mode 100644 apidocs/com/amazon/carbonado/qe/QueryEngine.html create mode 100644 apidocs/com/amazon/carbonado/qe/QueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/QueryExecutorCache.html create mode 100644 apidocs/com/amazon/carbonado/qe/QueryExecutorFactory.html create mode 100644 apidocs/com/amazon/carbonado/qe/QueryFactory.html create mode 100644 apidocs/com/amazon/carbonado/qe/QueryHint.html create mode 100644 apidocs/com/amazon/carbonado/qe/QueryHints.html create mode 100644 apidocs/com/amazon/carbonado/qe/RepositoryAccess.html create mode 100644 apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html create mode 100644 apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html create mode 100644 apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.Support.html create mode 100644 apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/StandardQuery.html create mode 100644 apidocs/com/amazon/carbonado/qe/StandardQueryFactory.html create mode 100644 apidocs/com/amazon/carbonado/qe/StorableIndexSet.html create mode 100644 apidocs/com/amazon/carbonado/qe/StorageAccess.html create mode 100644 apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html create mode 100644 apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.html create mode 100644 apidocs/com/amazon/carbonado/qe/UnionQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/AbstractQuery.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/AbstractQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/BoundaryType.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/CompositeScore.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/DelegatedQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/DelegatedQueryExecutorFactory.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/EmptyQuery.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/FilteredQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/FilteringScore.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.Support.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.Result.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.Support.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/IterableQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/JoinedQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.Support.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/OrderingList.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/OrderingScore.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/QueryEngine.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/QueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/QueryExecutorCache.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/QueryExecutorFactory.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/QueryFactory.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/QueryHint.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/QueryHints.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/RepositoryAccess.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.ArraySortSupport.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.MergeSortSupport.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.Support.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/StandardQuery.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/StandardQueryFactory.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/StorableIndexSet.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/StorageAccess.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.Result.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/UnionQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/qe/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/qe/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/qe/package-use.html create mode 100644 apidocs/com/amazon/carbonado/raw/CompressedEncodingStrategy.html create mode 100644 apidocs/com/amazon/carbonado/raw/CompressedStorableCodecFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/CompressionType.html create mode 100644 apidocs/com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/CustomStorableCodec.html create mode 100644 apidocs/com/amazon/carbonado/raw/CustomStorableCodecFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/DataDecoder.html create mode 100644 apidocs/com/amazon/carbonado/raw/DataEncoder.html create mode 100644 apidocs/com/amazon/carbonado/raw/GenericEncodingStrategy.html create mode 100644 apidocs/com/amazon/carbonado/raw/GenericInstanceFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/GenericPropertyInfo.html create mode 100644 apidocs/com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html create mode 100644 apidocs/com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/GenericStorableCodec.html create mode 100644 apidocs/com/amazon/carbonado/raw/GenericStorableCodecFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/GzipCompressor.html create mode 100644 apidocs/com/amazon/carbonado/raw/KeyDecoder.html create mode 100644 apidocs/com/amazon/carbonado/raw/KeyEncoder.html create mode 100644 apidocs/com/amazon/carbonado/raw/RawCursor.html create mode 100644 apidocs/com/amazon/carbonado/raw/RawStorableGenerator.html create mode 100644 apidocs/com/amazon/carbonado/raw/RawSupport.html create mode 100644 apidocs/com/amazon/carbonado/raw/RawUtil.html create mode 100644 apidocs/com/amazon/carbonado/raw/StorableCodec.html create mode 100644 apidocs/com/amazon/carbonado/raw/StorableCodecFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/StorablePropertyInfo.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/CompressedEncodingStrategy.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/CompressedStorableCodecFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/CompressionType.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/CustomStorableCodec.InstanceFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/CustomStorableCodec.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/CustomStorableCodecFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/DataDecoder.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/DataEncoder.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/GenericEncodingStrategy.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/GenericInstanceFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/GenericPropertyInfo.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.Decoder.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.SearchKeyFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodecFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/GzipCompressor.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/KeyDecoder.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/KeyEncoder.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/RawCursor.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/RawStorableGenerator.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/RawSupport.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/RawUtil.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/StorableCodec.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/StorableCodecFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/StorablePropertyInfo.html create mode 100644 apidocs/com/amazon/carbonado/raw/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/raw/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/raw/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/raw/package-use.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/StoredIndexInfo.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/Unindexed.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessor.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexedRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/class-use/StoredIndexInfo.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/class-use/Unindexed.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/repo/indexed/package-use.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/JDBCSupport.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/LoggingDataSource.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/SimpleDataSource.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCBlobLoader.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCClobLoader.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCConnectionCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableInfo.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableIntrospector.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableProperty.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCSupport.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/class-use/LoggingDataSource.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/class-use/SimpleDataSource.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/repo/jdbc/package-use.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/CommonsLog.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/Log.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/LogAccessCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/class-use/CommonsLog.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/class-use/Log.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/class-use/LogAccessCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/class-use/LoggingRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/repo/logging/package-use.html create mode 100644 apidocs/com/amazon/carbonado/repo/map/MapRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/map/class-use/MapRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/map/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/repo/map/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/repo/map/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/repo/map/package-use.html create mode 100644 apidocs/com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/replicated/class-use/ReplicatedRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/replicated/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/repo/replicated/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/repo/replicated/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/repo/replicated/package-use.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/BDBProduct.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/CompactionCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBPanicHandler.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBProduct.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.DatabaseHook.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CheckpointCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.Result.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/class-use/EnvironmentCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.Backup.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/class-use/StoredDatabaseInfo.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/package-use.html create mode 100644 apidocs/com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html create mode 100644 apidocs/com/amazon/carbonado/sequence/SequenceCapability.html create mode 100644 apidocs/com/amazon/carbonado/sequence/SequenceValueGenerator.html create mode 100644 apidocs/com/amazon/carbonado/sequence/SequenceValueProducer.html create mode 100644 apidocs/com/amazon/carbonado/sequence/SequenceValueProducerPool.html create mode 100644 apidocs/com/amazon/carbonado/sequence/StoredSequence.html create mode 100644 apidocs/com/amazon/carbonado/sequence/class-use/AbstractSequenceValueProducer.html create mode 100644 apidocs/com/amazon/carbonado/sequence/class-use/SequenceCapability.html create mode 100644 apidocs/com/amazon/carbonado/sequence/class-use/SequenceValueGenerator.html create mode 100644 apidocs/com/amazon/carbonado/sequence/class-use/SequenceValueProducer.html create mode 100644 apidocs/com/amazon/carbonado/sequence/class-use/SequenceValueProducerPool.html create mode 100644 apidocs/com/amazon/carbonado/sequence/class-use/StoredSequence.html create mode 100644 apidocs/com/amazon/carbonado/sequence/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/sequence/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/sequence/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/sequence/package-use.html create mode 100644 apidocs/com/amazon/carbonado/spi/AbstractRepository.html create mode 100644 apidocs/com/amazon/carbonado/spi/AbstractRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/spi/BelatedRepositoryCreator.html create mode 100644 apidocs/com/amazon/carbonado/spi/BelatedStorageCreator.html create mode 100644 apidocs/com/amazon/carbonado/spi/ExceptionTransformer.html create mode 100644 apidocs/com/amazon/carbonado/spi/IndexInfoImpl.html create mode 100644 apidocs/com/amazon/carbonado/spi/LobEngine.html create mode 100644 apidocs/com/amazon/carbonado/spi/RAFInputStream.html create mode 100644 apidocs/com/amazon/carbonado/spi/RAFOutputStream.html create mode 100644 apidocs/com/amazon/carbonado/spi/RepairExecutor.html create mode 100644 apidocs/com/amazon/carbonado/spi/StoragePool.html create mode 100644 apidocs/com/amazon/carbonado/spi/StoredLob.Block.html create mode 100644 apidocs/com/amazon/carbonado/spi/StoredLob.html create mode 100644 apidocs/com/amazon/carbonado/spi/StoredSequence.html create mode 100644 apidocs/com/amazon/carbonado/spi/TriggerManager.html create mode 100644 apidocs/com/amazon/carbonado/spi/TriggerManagerCapability.html create mode 100644 apidocs/com/amazon/carbonado/spi/class-use/AbstractRepository.html create mode 100644 apidocs/com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html create mode 100644 apidocs/com/amazon/carbonado/spi/class-use/BelatedRepositoryCreator.html create mode 100644 apidocs/com/amazon/carbonado/spi/class-use/BelatedStorageCreator.html create mode 100644 apidocs/com/amazon/carbonado/spi/class-use/ExceptionTransformer.html create mode 100644 apidocs/com/amazon/carbonado/spi/class-use/IndexInfoImpl.html create mode 100644 apidocs/com/amazon/carbonado/spi/class-use/LobEngine.html create mode 100644 apidocs/com/amazon/carbonado/spi/class-use/RAFInputStream.html create mode 100644 apidocs/com/amazon/carbonado/spi/class-use/RAFOutputStream.html create mode 100644 apidocs/com/amazon/carbonado/spi/class-use/RepairExecutor.html create mode 100644 apidocs/com/amazon/carbonado/spi/class-use/StoragePool.html create mode 100644 apidocs/com/amazon/carbonado/spi/class-use/StoredLob.Block.html create mode 100644 apidocs/com/amazon/carbonado/spi/class-use/StoredLob.html create mode 100644 apidocs/com/amazon/carbonado/spi/class-use/StoredSequence.html create mode 100644 apidocs/com/amazon/carbonado/spi/class-use/TriggerManager.html create mode 100644 apidocs/com/amazon/carbonado/spi/class-use/TriggerManagerCapability.html create mode 100644 apidocs/com/amazon/carbonado/spi/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/spi/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/spi/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/spi/package-use.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/ClassFileBuilder.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/SyntheticBuilder.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/SyntheticIndex.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/SyntheticKey.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/SyntheticProperty.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/SyntheticPropertyList.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/class-use/ClassFileBuilder.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.ClassNameProvider.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticIndex.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticKey.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticProperty.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticPropertyList.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableBuilder.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceAccess.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceBuilder.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/synthetic/package-use.html create mode 100644 apidocs/com/amazon/carbonado/txn/TransactionManager.html create mode 100644 apidocs/com/amazon/carbonado/txn/TransactionMonitor.html create mode 100644 apidocs/com/amazon/carbonado/txn/TransactionPair.html create mode 100644 apidocs/com/amazon/carbonado/txn/TransactionScope.html create mode 100644 apidocs/com/amazon/carbonado/txn/class-use/TransactionManager.html create mode 100644 apidocs/com/amazon/carbonado/txn/class-use/TransactionMonitor.html create mode 100644 apidocs/com/amazon/carbonado/txn/class-use/TransactionPair.html create mode 100644 apidocs/com/amazon/carbonado/txn/class-use/TransactionScope.html create mode 100644 apidocs/com/amazon/carbonado/txn/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/txn/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/txn/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/txn/package-use.html create mode 100644 apidocs/com/amazon/carbonado/util/AbstractPool.html create mode 100644 apidocs/com/amazon/carbonado/util/AnnotationBuilder.html create mode 100644 apidocs/com/amazon/carbonado/util/AnnotationDescParser.html create mode 100644 apidocs/com/amazon/carbonado/util/AnnotationDescPrinter.html create mode 100644 apidocs/com/amazon/carbonado/util/AnnotationPrinter.html create mode 100644 apidocs/com/amazon/carbonado/util/AnnotationVisitor.html create mode 100644 apidocs/com/amazon/carbonado/util/Appender.html create mode 100644 apidocs/com/amazon/carbonado/util/BelatedCreationException.html create mode 100644 apidocs/com/amazon/carbonado/util/BelatedCreator.html create mode 100644 apidocs/com/amazon/carbonado/util/Comparators.html create mode 100644 apidocs/com/amazon/carbonado/util/ConversionComparator.html create mode 100644 apidocs/com/amazon/carbonado/util/Converter.html create mode 100644 apidocs/com/amazon/carbonado/util/QuickConstructorGenerator.html create mode 100644 apidocs/com/amazon/carbonado/util/SoftValuedCache.html create mode 100644 apidocs/com/amazon/carbonado/util/TaskQueueThread.html create mode 100644 apidocs/com/amazon/carbonado/util/Throttle.html create mode 100644 apidocs/com/amazon/carbonado/util/ThrowUnchecked.html create mode 100644 apidocs/com/amazon/carbonado/util/class-use/AbstractPool.html create mode 100644 apidocs/com/amazon/carbonado/util/class-use/AnnotationBuilder.html create mode 100644 apidocs/com/amazon/carbonado/util/class-use/AnnotationDescParser.html create mode 100644 apidocs/com/amazon/carbonado/util/class-use/AnnotationDescPrinter.html create mode 100644 apidocs/com/amazon/carbonado/util/class-use/AnnotationPrinter.html create mode 100644 apidocs/com/amazon/carbonado/util/class-use/AnnotationVisitor.html create mode 100644 apidocs/com/amazon/carbonado/util/class-use/Appender.html create mode 100644 apidocs/com/amazon/carbonado/util/class-use/BelatedCreationException.html create mode 100644 apidocs/com/amazon/carbonado/util/class-use/BelatedCreator.html create mode 100644 apidocs/com/amazon/carbonado/util/class-use/Comparators.html create mode 100644 apidocs/com/amazon/carbonado/util/class-use/ConversionComparator.html create mode 100644 apidocs/com/amazon/carbonado/util/class-use/Converter.html create mode 100644 apidocs/com/amazon/carbonado/util/class-use/QuickConstructorGenerator.html create mode 100644 apidocs/com/amazon/carbonado/util/class-use/SoftValuedCache.html create mode 100644 apidocs/com/amazon/carbonado/util/class-use/TaskQueueThread.html create mode 100644 apidocs/com/amazon/carbonado/util/class-use/Throttle.html create mode 100644 apidocs/com/amazon/carbonado/util/class-use/ThrowUnchecked.html create mode 100644 apidocs/com/amazon/carbonado/util/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/util/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/util/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/util/package-use.html create mode 100644 apidocs/constant-values.html create mode 100644 apidocs/deprecated-list.html create mode 100644 apidocs/help-doc.html create mode 100644 apidocs/index-files/index-1.html create mode 100644 apidocs/index-files/index-10.html create mode 100644 apidocs/index-files/index-11.html create mode 100644 apidocs/index-files/index-12.html create mode 100644 apidocs/index-files/index-13.html create mode 100644 apidocs/index-files/index-14.html create mode 100644 apidocs/index-files/index-15.html create mode 100644 apidocs/index-files/index-16.html create mode 100644 apidocs/index-files/index-17.html create mode 100644 apidocs/index-files/index-18.html create mode 100644 apidocs/index-files/index-19.html create mode 100644 apidocs/index-files/index-2.html create mode 100644 apidocs/index-files/index-20.html create mode 100644 apidocs/index-files/index-21.html create mode 100644 apidocs/index-files/index-22.html create mode 100644 apidocs/index-files/index-23.html create mode 100644 apidocs/index-files/index-24.html create mode 100644 apidocs/index-files/index-3.html create mode 100644 apidocs/index-files/index-4.html create mode 100644 apidocs/index-files/index-5.html create mode 100644 apidocs/index-files/index-6.html create mode 100644 apidocs/index-files/index-7.html create mode 100644 apidocs/index-files/index-8.html create mode 100644 apidocs/index-files/index-9.html create mode 100644 apidocs/index.html create mode 100644 apidocs/overview-frame.html create mode 100644 apidocs/overview-summary.html create mode 100644 apidocs/overview-tree.html create mode 100644 apidocs/package-list create mode 100644 apidocs/resources/background.gif create mode 100644 apidocs/resources/tab.gif create mode 100644 apidocs/resources/titlebar.gif create mode 100644 apidocs/resources/titlebar_end.gif create mode 100644 apidocs/serialized-form.html create mode 100644 apidocs/stylesheet.css create mode 100644 docs/CarbonadoGuide.pdf diff --git a/apidocs/allclasses-frame.html b/apidocs/allclasses-frame.html new file mode 100644 index 0000000..628ee7e --- /dev/null +++ b/apidocs/allclasses-frame.html @@ -0,0 +1,332 @@ + + + + + + +All Classes (Carbonado 1.2.3 API) + + + + +

All Classes

+
+ +
+ + diff --git a/apidocs/allclasses-noframe.html b/apidocs/allclasses-noframe.html new file mode 100644 index 0000000..273c409 --- /dev/null +++ b/apidocs/allclasses-noframe.html @@ -0,0 +1,332 @@ + + + + + + +All Classes (Carbonado 1.2.3 API) + + + + +

All Classes

+
+ +
+ + diff --git a/apidocs/com/amazon/carbonado/Alias.html b/apidocs/com/amazon/carbonado/Alias.html new file mode 100644 index 0000000..863c963 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Alias.html @@ -0,0 +1,229 @@ + + + + + + +Alias (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado
+

Annotation Type Alias

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value={TYPE,METHOD})
+public @interface Alias
    +
    Identifies alternate names for a Storable or a Storable property. An alias is used + only by a repository to link to entities. Without an alias, the repository will perform + a best guess at finding an entity to use. Aliases may be ignored by repositories that + don't require explicitly named entities. +

    The most common use for an alias is for a JDBC repository, to link a storable to a table and + its properties to the corresponding columns. Naming conventions for databases rarely work + well for class and variable names. + +

    Example:

    + @Alias("USER_INFO")
+ @PrimaryKey("userInfoID")
+ public interface UserInfo extends Storable<UserInfo> {
+     @Alias("USER_ID")
+     long getUserInfoID();
+     void setUserInfoID(long id);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Name
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.String[]value +
      Alias values for the storage layer to select from.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String[] value
        +
        Alias values for the storage layer to select from. It will choose the + first one in the list that matches one of its own entities.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/AlternateKeys.html b/apidocs/com/amazon/carbonado/AlternateKeys.html new file mode 100644 index 0000000..a9a3ec6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/AlternateKeys.html @@ -0,0 +1,237 @@ + + + + + + +AlternateKeys (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado
+

Annotation Type AlternateKeys

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=TYPE)
+public @interface AlternateKeys
    +
    List of alternate keys for a Storable. + +

    Example:

    + @AlternateKeys({
+     @Key("fullPath")
+     @Key({"+name", "-parentID"})
+ })
+ @PrimaryKey("ID")
+ public interface FileInfo extends Storable<FileInfo> {
+     long getID();
+     void setID(long id);
+
+     String getFullPath();
+     void setFullPath(String path);
+
+     String getName();
+     void setName(String name);
+
+     long getParentID();
+     void setParentID(long id);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Key
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      Key[]value +
      A list of Key annotations.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract Key[] value
        +
        A list of Key annotations.
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/Authoritative.html b/apidocs/com/amazon/carbonado/Authoritative.html new file mode 100644 index 0000000..d0db0d0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Authoritative.html @@ -0,0 +1,183 @@ + + + + + + +Authoritative (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Annotation Type Authoritative

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=TYPE)
+public @interface Authoritative
    +
    Indicates that all accesses to this Storable must come from an + authoritative source. When reading or writing the Storable, the Repository must guarantee that it is operating on the latest, correct + version of the Storable. + +

    Repositories that cache potentially stale Storables are required to + ensure the cache is always up-to-date or bypass the cache + altogether. Replicating repositories which may have a propagation delay must + always access the master repository. + +

    Repositories which provide eventual consistency but don't rely on a + master must throw UnsupportedTypeException, as there is no + authoritative source. + +

    Example:

    + @Authoritative
+ @PrimaryKey("sequenceName")
+ public interface SequenceValue extends Storable<SequenceValue> {
+     String getSequenceName();
+     void setSequenceName(String name);
+
+     long getNextValue();
+     void setNextValue(long value);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/Automatic.html b/apidocs/com/amazon/carbonado/Automatic.html new file mode 100644 index 0000000..6a57514 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Automatic.html @@ -0,0 +1,181 @@ + + + + + + +Automatic (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Annotation Type Automatic

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+public @interface Automatic
    +
    Identifies a Storable property capable of selecting its own value on + insert. The actual process by which a value is automatically assigned is + repository dependent. In the JDBC repository, the value might come from an + auto-increment column or a database-specific trigger. + +

    If the underlying repository doesn't automatically supply a value to an + automatic property, no immediate warning is given and instead the property + will be assigned a default value of null or zero. This may cause problems if + the automatic property is a member of a key. Explicitly specifying a value + can sometimes be used to bypass the automatic value altogether. + +

    Example:

    + @PrimaryKey("userInfoID")
+ public interface UserInfo extends Storable<UserInfo> {
+     @Automatic
+     long getUserInfoID();
+     void setUserInfoID(long id);
+
+     ...
+ }
+
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Sequence
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/ConfigurationException.html b/apidocs/com/amazon/carbonado/ConfigurationException.html new file mode 100644 index 0000000..8ec2894 --- /dev/null +++ b/apidocs/com/amazon/carbonado/ConfigurationException.html @@ -0,0 +1,311 @@ + + + + + + +ConfigurationException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Class ConfigurationException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class ConfigurationException
+extends SupportException
    +
    Indicates that a Repository could not be + instantiated given the configuration information provided to a RepositoryBuilder.
    +
    Author:
    +
    Don Schneider
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConfigurationException

        +
        public ConfigurationException()
        +
        • +
      + + + +
        +
      • +

        ConfigurationException

        +
        public ConfigurationException(java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        ConfigurationException

        +
        public ConfigurationException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        ConfigurationException

        +
        public ConfigurationException(java.lang.String message,
+                      java.lang.Throwable cause)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/ConstraintException.html b/apidocs/com/amazon/carbonado/ConstraintException.html new file mode 100644 index 0000000..6ae6c0a --- /dev/null +++ b/apidocs/com/amazon/carbonado/ConstraintException.html @@ -0,0 +1,315 @@ + + + + + + +ConstraintException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Class ConstraintException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    Direct Known Subclasses:
    +
    UniqueConstraintException
    +
    +
    +
    +
    public class ConstraintException
+extends PersistException
    +
    A ConstraintException is thrown if the Repository storage layer + detects any kind of constraint violation.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConstraintException

        +
        public ConstraintException()
        +
        • +
      + + + +
        +
      • +

        ConstraintException

        +
        public ConstraintException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        ConstraintException

        +
        public ConstraintException(java.lang.String message,
+                   java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        ConstraintException

        +
        public ConstraintException(java.lang.Throwable cause)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/CorruptEncodingException.html b/apidocs/com/amazon/carbonado/CorruptEncodingException.html new file mode 100644 index 0000000..8daef99 --- /dev/null +++ b/apidocs/com/amazon/carbonado/CorruptEncodingException.html @@ -0,0 +1,395 @@ + + + + + + +CorruptEncodingException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado
+

Class CorruptEncodingException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class CorruptEncodingException
+extends FetchException
    +
    A CorruptEncodingException is caused when decoding an encoded record fails.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CorruptEncodingException

        +
        public CorruptEncodingException()
        +
        • +
      + + + +
        +
      • +

        CorruptEncodingException

        +
        public CorruptEncodingException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        CorruptEncodingException

        +
        public CorruptEncodingException(java.lang.String message,
+                        java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        CorruptEncodingException

        +
        public CorruptEncodingException(java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        CorruptEncodingException

        +
        public CorruptEncodingException(int expectedGeneration,
+                        int actualGeneration)
        +
        Parameters:
        expectedGeneration - expected layout generation of decoded storable
        actualGeneration - actual layout generation of decoded storable
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setStorableWithPrimaryKey

        +
        public void setStorableWithPrimaryKey(Storable s)
        +
        If the decoder can at least extract the primary key, it should set it here.
        +
        • +
      + + + +
        +
      • +

        getStorableWithPrimaryKey

        +
        public Storable getStorableWithPrimaryKey()
        +
        If the decoder was able to extract the primary key, it will be available in the + returned Storable. If this exception was re-constructed through serialization, then + the Storable is as well. As a result, it won't be bound to any Repository and + updating it will have no effect.
        +
        Returns:
        partial Storable with primary key defined, or null if unable to + decode the key
        +
        • +
      + + + +
        +
      • +

        getMessage

        +
        public java.lang.String getMessage()
        +
        +
        Overrides:
        +
        getMessage in class java.lang.Throwable
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/Cursor.html b/apidocs/com/amazon/carbonado/Cursor.html new file mode 100644 index 0000000..0230910 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Cursor.html @@ -0,0 +1,431 @@ + + + + + + +Cursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Interface Cursor<S>

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    AbstractCursor, ControllerCursor, DifferenceCursor, EmptyCursor, FetchAheadCursor, FilteredCursor, GroupedCursor, IntersectionCursor, IteratorCursor, LimitCursor, MultiTransformedCursor, RawCursor, SingletonCursor, SkipCursor, SortedCursor, SymmetricDifferenceCursor, ThrottledCursor, TransformedCursor, UnionCursor
    +
    +
    +
    +
    public interface Cursor<S>
    +
    Represents the results of a Query's fetch + operation. Cursors must be closed promptly when no longer + needed. Failure to do so may result in excessive resource consumption or + deadlock. As a convenience, the close operation is automatically performed + when the end is reached or when an exception is thrown. + +

    Note: because a Cursor manages resources, it is inapproprate to create a long-lived one and + pass it around in your code. A cursor is expected to live close to the Query which vended + it. To discourage inappropriate retention, the cursor does not implement methods (like + "getQuery" or "reset") which would make it more convenient to operate on in isolation. + +

    Similarly, it is difficult to guarantee that the results of a cursor will + be the same in case of a "reset" or reverse iteration. For this reason, + neither is supported; if you need to iterate the same set of objects twice, + simply retain the query object and reissue it. Be aware that the results may + not be identical, if any relevant objects are added to or removed the + repository in the interim. To guard against this, operate within a + serializable isolation level. + +

    Cursor instances are mutable and not guaranteed to be thread-safe. Only + one thread should ever operate on a cursor instance.

    +
    Author:
    +
    Brian S O'Neill, Don Schneider
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      intcopyInto(java.util.Collection<? super S> c) +
      Copies all remaining next elements into the given collection.
      +
      intcopyInto(java.util.Collection<? super S> c, + int limit) +
      Copies a limited amount of remaining next elements into the given + collection.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      java.util.List<S>toList() +
      Copies all remaining next elements into a new modifiable list.
      +
      java.util.List<S>toList(int limit) +
      Copies a limited amount of remaining next elements into a new modifiable + list.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        void close()
+           throws FetchException
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        boolean hasNext()
+                throws FetchException
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        S next()
+       throws FetchException
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        java.util.NoSuchElementException - if the cursor has no next element.
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        int skipNext(int amount)
+             throws FetchException
        +
        Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        java.lang.IllegalArgumentException - if amount is negative
        +
        • +
      + + + +
        +
      • +

        copyInto

        +
        int copyInto(java.util.Collection<? super S> c)
+             throws FetchException
        +
        Copies all remaining next elements into the given collection. This + method is roughly equivalent to the following: + 
        + Cursor cursor;
+ ...
+ while (cursor.hasNext()) {
+     c.add(cursor.next());
+ }
+
        + +

        As a side-effect of calling this method, the cursor is closed.

        +
        Returns:
        actual amount of results added
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        copyInto

        +
        int copyInto(java.util.Collection<? super S> c,
+           int limit)
+             throws FetchException
        +
        Copies a limited amount of remaining next elements into the given + collection. This method is roughly equivalent to the following: + 
        + Cursor cursor;
+ ...
+ while (--limit >= 0 && cursor.hasNext()) {
+     c.add(cursor.next());
+ }
+
        +
        Parameters:
        limit - maximum amount of elements to copy
        +
        Returns:
        actual amount of results added
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        java.lang.IllegalArgumentException - if limit is negative
        +
        • +
      + + + +
        +
      • +

        toList

        +
        java.util.List<S> toList()
+                         throws FetchException
        +
        Copies all remaining next elements into a new modifiable list. This + method is roughly equivalent to the following: + 
        + Cursor<S> cursor;
+ ...
+ List<S> list = new ...
+ cursor.copyInto(list);
+
        + +

        As a side-effect of calling this method, the cursor is closed.

        +
        Returns:
        a new modifiable list
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        toList

        +
        java.util.List<S> toList(int limit)
+                         throws FetchException
        +
        Copies a limited amount of remaining next elements into a new modifiable + list. This method is roughly equivalent to the following: + 
        + Cursor<S> cursor;
+ ...
+ List<S> list = new ...
+ cursor.copyInto(list, limit);
+
        +
        Parameters:
        limit - maximum amount of elements to copy
        +
        Returns:
        a new modifiable list
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        java.lang.IllegalArgumentException - if limit is negative
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/Derived.html b/apidocs/com/amazon/carbonado/Derived.html new file mode 100644 index 0000000..a27e556 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Derived.html @@ -0,0 +1,264 @@ + + + + + + +Derived (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado
+

Annotation Type Derived

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+public @interface Derived
    +
    Identifies a Storable property which is not directly persisted, but + is instead derived from other property values. A derived property cannot be + abstract, and a "set" method is optional. + +

    Derived properties can be used just like a normal property in most + cases. They can be used in query filters, indexes, alternate keys, and they + can also be used to define a Version property. + +

    If the derived property depends on Join properties and is also + used in an index or alternate key, dependencies must be listed in order for + the index to be properly updated. + +

    Example:

    + @Indexes(@Index("uppercaseName"))
+ public abstract class UserInfo implements Storable<UserInfo> {
+     /**
+      * Derive an uppercase name for case-insensitive searches.
+      */
+     @Derived
+     public String getUppercaseName() {
+         String name = getName();
+         return name == null ? null : name.toUpperCase();
+     }
+
+     ...
+ }
+
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill, Tobias Holgers
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.String[]from +
      List of properties that this property is derived from.
      +
      booleanshouldCopy +
      Returns whether this property should be included when copying a + storable.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        from

        +
        public abstract java.lang.String[] from
        +
        List of properties that this property is derived from.
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      + + + +
        +
      • +

        shouldCopy

        +
        public abstract boolean shouldCopy
        +
        Returns whether this property should be included when copying a + storable. Copying of a derived property uses the "get" and "set" methods + and requires the "set" method to be defined. Default false.
        +
        +
        Default:
        +
        false
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/FetchDeadlockException.html b/apidocs/com/amazon/carbonado/FetchDeadlockException.html new file mode 100644 index 0000000..441911b --- /dev/null +++ b/apidocs/com/amazon/carbonado/FetchDeadlockException.html @@ -0,0 +1,349 @@ + + + + + + +FetchDeadlockException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado
+

Class FetchDeadlockException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class FetchDeadlockException
+extends FetchException
    +
    Thrown if a fetch operation fails because it was selected to resolve a + deadlock.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FetchDeadlockException

        +
        public FetchDeadlockException()
        +
        • +
      + + + +
        +
      • +

        FetchDeadlockException

        +
        public FetchDeadlockException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        FetchDeadlockException

        +
        public FetchDeadlockException(java.lang.String message,
+                      java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        FetchDeadlockException

        +
        public FetchDeadlockException(java.lang.Throwable cause)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        makePersistException

        +
        protected PersistException makePersistException(java.lang.String message,
+                                    java.lang.Throwable cause)
        +
        Description copied from class: RepositoryException
        +
        Subclasses can override this to provide a more specialized exception.
        +
        +
        Overrides:
        +
        makePersistException in class RepositoryException
        +
        Parameters:
        message - exception message, which may be null
        cause - non-null cause
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/FetchException.html b/apidocs/com/amazon/carbonado/FetchException.html new file mode 100644 index 0000000..c1c872c --- /dev/null +++ b/apidocs/com/amazon/carbonado/FetchException.html @@ -0,0 +1,309 @@ + + + + + + +FetchException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Class FetchException

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FetchException

        +
        public FetchException()
        +
        • +
      + + + +
        +
      • +

        FetchException

        +
        public FetchException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        FetchException

        +
        public FetchException(java.lang.String message,
+              java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        FetchException

        +
        public FetchException(java.lang.Throwable cause)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/FetchInterruptedException.html b/apidocs/com/amazon/carbonado/FetchInterruptedException.html new file mode 100644 index 0000000..f8a2069 --- /dev/null +++ b/apidocs/com/amazon/carbonado/FetchInterruptedException.html @@ -0,0 +1,348 @@ + + + + + + +FetchInterruptedException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado
+

Class FetchInterruptedException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class FetchInterruptedException
+extends FetchException
    +
    Thrown from a fetch operation that was canceled.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FetchInterruptedException

        +
        public FetchInterruptedException()
        +
        • +
      + + + +
        +
      • +

        FetchInterruptedException

        +
        public FetchInterruptedException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        FetchInterruptedException

        +
        public FetchInterruptedException(java.lang.String message,
+                         java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        FetchInterruptedException

        +
        public FetchInterruptedException(java.lang.Throwable cause)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        makePersistException

        +
        protected PersistException makePersistException(java.lang.String message,
+                                    java.lang.Throwable cause)
        +
        Description copied from class: RepositoryException
        +
        Subclasses can override this to provide a more specialized exception.
        +
        +
        Overrides:
        +
        makePersistException in class RepositoryException
        +
        Parameters:
        message - exception message, which may be null
        cause - non-null cause
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/FetchMultipleException.html b/apidocs/com/amazon/carbonado/FetchMultipleException.html new file mode 100644 index 0000000..1958fd0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/FetchMultipleException.html @@ -0,0 +1,349 @@ + + + + + + +FetchMultipleException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado
+

Class FetchMultipleException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class FetchMultipleException
+extends FetchException
    +
    A FetchMultipleException is thrown when a fetch operation returned more + than one record when at most one was expected.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FetchMultipleException

        +
        public FetchMultipleException()
        +
        • +
      + + + +
        +
      • +

        FetchMultipleException

        +
        public FetchMultipleException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        FetchMultipleException

        +
        public FetchMultipleException(java.lang.String message,
+                      java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        FetchMultipleException

        +
        public FetchMultipleException(java.lang.Throwable cause)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        makePersistException

        +
        protected PersistException makePersistException(java.lang.String message,
+                                    java.lang.Throwable cause)
        +
        Description copied from class: RepositoryException
        +
        Subclasses can override this to provide a more specialized exception.
        +
        +
        Overrides:
        +
        makePersistException in class RepositoryException
        +
        Parameters:
        message - exception message, which may be null
        cause - non-null cause
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/FetchNoneException.html b/apidocs/com/amazon/carbonado/FetchNoneException.html new file mode 100644 index 0000000..fccff8b --- /dev/null +++ b/apidocs/com/amazon/carbonado/FetchNoneException.html @@ -0,0 +1,349 @@ + + + + + + +FetchNoneException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado
+

Class FetchNoneException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class FetchNoneException
+extends FetchException
    +
    A FetchNoneException is thrown when a fetch operation returned no records + when at least one was expected.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FetchNoneException

        +
        public FetchNoneException()
        +
        • +
      + + + +
        +
      • +

        FetchNoneException

        +
        public FetchNoneException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        FetchNoneException

        +
        public FetchNoneException(java.lang.String message,
+                  java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        FetchNoneException

        +
        public FetchNoneException(java.lang.Throwable cause)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        makePersistException

        +
        protected PersistException makePersistException(java.lang.String message,
+                                    java.lang.Throwable cause)
        +
        Description copied from class: RepositoryException
        +
        Subclasses can override this to provide a more specialized exception.
        +
        +
        Overrides:
        +
        makePersistException in class RepositoryException
        +
        Parameters:
        message - exception message, which may be null
        cause - non-null cause
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/FetchTimeoutException.html b/apidocs/com/amazon/carbonado/FetchTimeoutException.html new file mode 100644 index 0000000..3d4bfe0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/FetchTimeoutException.html @@ -0,0 +1,348 @@ + + + + + + +FetchTimeoutException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado
+

Class FetchTimeoutException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class FetchTimeoutException
+extends FetchException
    +
    Thrown if a fetch operation fails because lock acquisition timed out.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FetchTimeoutException

        +
        public FetchTimeoutException()
        +
        • +
      + + + +
        +
      • +

        FetchTimeoutException

        +
        public FetchTimeoutException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        FetchTimeoutException

        +
        public FetchTimeoutException(java.lang.String message,
+                     java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        FetchTimeoutException

        +
        public FetchTimeoutException(java.lang.Throwable cause)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        makePersistException

        +
        protected PersistException makePersistException(java.lang.String message,
+                                    java.lang.Throwable cause)
        +
        Description copied from class: RepositoryException
        +
        Subclasses can override this to provide a more specialized exception.
        +
        +
        Overrides:
        +
        makePersistException in class RepositoryException
        +
        Parameters:
        message - exception message, which may be null
        cause - non-null cause
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/Independent.html b/apidocs/com/amazon/carbonado/Independent.html new file mode 100644 index 0000000..439e0c2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Independent.html @@ -0,0 +1,193 @@ + + + + + + +Independent (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Annotation Type Independent

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value={TYPE,METHOD})
+public @interface Independent
    +
    A hint for a dependent Repository to allow a Storable property or type + to be undefined in the underlying schema. Ordinarily, if a dependent repository cannot + find a matching property, it throws MismatchException when the Storage is + first retrieved for the storable. This annotation suppresses that exception, and instead + makes the property or type unsupported. Any subsequent invocation of a property access + method for the independent type or property will cause an UnsupportedOperationException + to be thrown. + +

    One example of when this might be used would be to store a calculated + field in the cached representation of the object. It is not + necessary to prevent implemented methods of the form "get<value>" + from being inadvertently interpreted as properties of the storable; any + implementation is by definition not a property. + +

    If a correctly matching property actually is found, then this annotation + is ignored and the property or type is defined as usual. If the Repository + finds a property whose name matches, but whose type does not match, a + MismatchException will be thrown regardless of this annotation. + +

    Independent repositories completely ignore this annotation. + +

    Example:

    + public interface UserInfo extends Storable<UserInfo> {
+     @Independent
+     String getName();
+     void setName(String name);
+
+     ...
+ }
+
    + + Note: If a versioned Storable with an independent + property is managed by a replicating repository, updates which modify just + the independent property still update the master Storable, in order to get a + new record version. Therefore, independent properties should not be used as + a performance enhancement which avoids writes to a master repository.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/Index.html b/apidocs/com/amazon/carbonado/Index.html new file mode 100644 index 0000000..e921a0a --- /dev/null +++ b/apidocs/com/amazon/carbonado/Index.html @@ -0,0 +1,213 @@ + + + + + + +Index (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado
+

Annotation Type Index

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value={})
+public @interface Index
    +
    An Index annotation provides a hint to the storage layer allowing queries to be performed more quickly. Indexes are contained by an + Indexes annotation.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Indexes
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.String[]value +
      A list of property names, which may be prefixed with '+' or '-' to + indicate a preference for ascending or descending order.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String[] value
        +
        A list of property names, which may be prefixed with '+' or '-' to + indicate a preference for ascending or descending order.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/Indexes.html b/apidocs/com/amazon/carbonado/Indexes.html new file mode 100644 index 0000000..c70fbda --- /dev/null +++ b/apidocs/com/amazon/carbonado/Indexes.html @@ -0,0 +1,239 @@ + + + + + + +Indexes (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado
+

Annotation Type Indexes

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=TYPE)
+public @interface Indexes
    +
    The Indexes annotation is applied to a Storable for specifying all + the indexes it should have. + +

    Example:

    + @Indexes({
+     @Index("name"),
+     @Index("-lastModified"),
+     @Index({"length", "lastModified"})
+ })
+ @PrimaryKey("ID")
+ public interface FileInfo extends Storable<FileInfo> {
+     long getID();
+     void setID(long id);
+
+     String getName();
+     void setName(String name);
+
+     long getLength();
+     void setLength(long length);
+
+     long getLastModified();
+     void getLastModified(long datetime);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Index
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      Index[]value +
      A list of Index annotations.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract Index[] value
        +
        A list of Index annotations.
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/IsolationLevel.html b/apidocs/com/amazon/carbonado/IsolationLevel.html new file mode 100644 index 0000000..e79cf52 --- /dev/null +++ b/apidocs/com/amazon/carbonado/IsolationLevel.html @@ -0,0 +1,510 @@ + + + + + + +IsolationLevel (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado
+

Enum IsolationLevel

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<IsolationLevel>
    +
    +
    +
    +
    public enum IsolationLevel
+extends java.lang.Enum<IsolationLevel>
    +
    Describes a transaction isolation level. Transaction levels, in order from + lowest to highest are: + + + + A transaction's isolation level is usually READ_COMMITTED or + REPEATABLE_READ by default. Forcing a lower level, like + READ_COMMITTED, is useful when performing a long cursor + iteration. It releases locks during iteration rather than holding on to them + until the transaction exits. + +

    SNAPSHOT isolation is special in that it uses multiversion + concurrency control (MVCC). A commit may fail with an OptimisticLockException. Few repositories are expected to support this + level, however.

    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Repository.enterTransaction(IsolationLevel), +Transaction
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      NONE +
      Indicates that no actual transaction is in progress.
      +
      READ_COMMITTED +
      Indicates that dirty reads are prevented.
      +
      READ_UNCOMMITTED +
      Indicates that dirty reads, non-repeatable reads and phantom reads can + occur.
      +
      REPEATABLE_READ +
      Indicates that dirty reads and non-repeatable reads are prevented.
      +
      SERIALIZABLE +
      Indicates that dirty reads, non-repeatable reads and phantom reads are + prevented.
      +
      SNAPSHOT +
      Indicates that dirty reads, non-repeatable reads and phantom reads are + prevented.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      IsolationLevelhighestCommon(IsolationLevel level) +
      Returns the highest common isolation level between this and the one + given.
      +
      booleanisAtLeast(IsolationLevel level) +
      Returns true if this isolation level is at least as high as the one + given.
      +
      booleanisAtMost(IsolationLevel level) +
      Returns true if this isolation level is no higher than the one given.
      +
      IsolationLevellowestCommon(IsolationLevel level) +
      Returns the lowest common isolation level between this and the one + given.
      +
      static IsolationLevelvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static IsolationLevel[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        NONE

        +
        public static final IsolationLevel NONE
        +
        Indicates that no actual transaction is in progress. If this level is + specified when entering a transaction, it uses auto-commit mode.
        +
        • +
      + + + +
        +
      • +

        READ_UNCOMMITTED

        +
        public static final IsolationLevel READ_UNCOMMITTED
        +
        Indicates that dirty reads, non-repeatable reads and phantom reads can + occur. This level allows modifications by one transaction to be read by + another transaction before any changes have been committed (a "dirty + read"). If any of the changes are rolled back, the second transaction + will have retrieved an invalid modification. + +

        This level is also known as degree 1 isolation.

        +
        • +
      + + + +
        +
      • +

        READ_COMMITTED

        +
        public static final IsolationLevel READ_COMMITTED
        +
        Indicates that dirty reads are prevented. Non-repeatable reads and + phantom reads can occur. This level only prohibits a transaction from + reading modifications with uncommitted changes in it. + +

        This level is also known as degree 2 isolation.

        +
        • +
      + + + +
        +
      • +

        REPEATABLE_READ

        +
        public static final IsolationLevel REPEATABLE_READ
        +
        Indicates that dirty reads and non-repeatable reads are prevented. + Phantom reads can occur. This level prohibits a transaction from reading + uncommitted changes, and it also prohibits the situation where one + transaction reads a record, a second transaction alters the record, and + the first transaction rereads the record, getting different values the + second time (a "non-repeatable read").
        +
        • +
      + + + +
        +
      • +

        SNAPSHOT

        +
        public static final IsolationLevel SNAPSHOT
        +
        Indicates that dirty reads, non-repeatable reads and phantom reads are + prevented. Commits can still fail however, as snapshot isolation avoids + using locks.
        +
        • +
      + + + +
        +
      • +

        SERIALIZABLE

        +
        public static final IsolationLevel SERIALIZABLE
        +
        Indicates that dirty reads, non-repeatable reads and phantom reads are + prevented. Phantoms are records returned as a result of a search, but + which were not seen by the same transaction when the identical search + criteria was previously used. For example, another transaction may have + inserted records which match the original search. + +

        This level is also known as degree 3 isolation.

        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static IsolationLevel[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (IsolationLevel c : IsolationLevel.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in +the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static IsolationLevel valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      + + + +
        +
      • +

        isAtLeast

        +
        public boolean isAtLeast(IsolationLevel level)
        +
        Returns true if this isolation level is at least as high as the one + given.
        +
        • +
      + + + +
        +
      • +

        isAtMost

        +
        public boolean isAtMost(IsolationLevel level)
        +
        Returns true if this isolation level is no higher than the one given.
        +
        • +
      + + + +
        +
      • +

        lowestCommon

        +
        public IsolationLevel lowestCommon(IsolationLevel level)
        +
        Returns the lowest common isolation level between this and the one + given.
        +
        • +
      + + + +
        +
      • +

        highestCommon

        +
        public IsolationLevel highestCommon(IsolationLevel level)
        +
        Returns the highest common isolation level between this and the one + given.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/Join.html b/apidocs/com/amazon/carbonado/Join.html new file mode 100644 index 0000000..3a5394b --- /dev/null +++ b/apidocs/com/amazon/carbonado/Join.html @@ -0,0 +1,314 @@ + + + + + + +Join (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado
+

Annotation Type Join

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+public @interface Join
    +
    Identifies a Storable property as defining a join relationship + with another Storable type. Joins can also refer to their own enclosing + class or interface. +

    + To complete the join, lists of internal and external properties may be + supplied. If these lists are not supplied, then join is "natural", and the + properties are determined automatically. When the lists are specified, the + join is "explicit". Natural joins are merely a convenience; they can always + be replaced by an explicit join. +

    + The lists used for explicit joins must have the same length, and each must + have at least one element. Each element in the internal list must refer to + a property defined in this property's class or interface, and each element + in the external list must refer to a matching property defined in the joined + type. The matched up property pairs must not themselves be join properties, + and they must be compatible with each other. +

    + If the join is made to external properties which do not completely specify a + primary key, then the type of the join property must be a Query of + the joined type. When the type is a Query, a property mutator method cannot + be defined. The returned query has all of the "with" parameters filled in. +

    + With a natural join, the internal and external properties are deduced by + examining the type of the referenced join property. If the type is a Query, + then the internal and external properties are set to match this property's + primary key. The referenced join property (specified as a parameterized type + to Query) must have properties matching name and type of this property's + primary key. +

    + If a natural join's property type is not defined by a Query, then the + internal and external properties are set to match the referenced property's + primary key. This join property must have properties matching name and type + of the referenced property's primary key. + +

    Example:

    + @PrimaryKey("addressID")
+ public interface Address extends Storable {
+     int getAddressID();
+
+     ...
+ }
+
+ @PrimaryKey("userID")
+ public interface UserInfo extends Storable {
+     int getUserID();
+     void setUserID(int id);
+
+     int getAddressID();
+     void setAddressID(int value);
+
+     // Natural join, which works because Address has a primary key
+     // property of addressID which matches a property in this type.
+     @Join
+     Address getAddress() throws FetchException;
+     void setAddress(Address address);
+
+     // Explicit join, equivalent to getAddress.
+     @Join(internal="addressID", external="addressID")
+     Address getCurrentAddress() throws FetchException;
+     void setCurrentAddress(Address address);
+
+     @Nullable
+     Integer getParentID();
+     void setParentID(Integer value);
+
+     // Many-to-one relationship
+     @Nullable
+     @Join(internal="parentID", external="userID")
+     UserInfo getParent() throws FetchException;
+     void setParent(UserInfo parent);
+
+     // One-to-many relationship
+     @Join(internal="userID", external="parentID")
+     Query<UserInfo> getChildren() throws FetchException;
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.String[]external +
      List of property names defined in the foreign property's enclosing class + or interface.
      +
      java.lang.String[]internal +
      List of property names defined in this property's enclosing class or + interface.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        internal

        +
        public abstract java.lang.String[] internal
        +
        List of property names defined in this property's enclosing class or + interface.
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      + + + +
        +
      • +

        external

        +
        public abstract java.lang.String[] external
        +
        List of property names defined in the foreign property's enclosing class + or interface.
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/Key.html b/apidocs/com/amazon/carbonado/Key.html new file mode 100644 index 0000000..3ee0b17 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Key.html @@ -0,0 +1,217 @@ + + + + + + +Key (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado
+

Annotation Type Key

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value={})
+public @interface Key
    +
    Identifies a Storable property as being a member of an alternate + key. An alternate key is just as good as the primary key for uniquely + identifying a storable instance, except repositories are usually more + flexible with alternate keys. For example, dropping an alternate key and + reconstructing it should not result in loss of data. Alternate keys are + often implemented as indexes with a uniqueness constraint.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    AlternateKeys
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.String[]value +
      A list of property names, which may be prefixed with '+' or '-' to + indicate a preference for ascending or descending order.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String[] value
        +
        A list of property names, which may be prefixed with '+' or '-' to + indicate a preference for ascending or descending order.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/MalformedArgumentException.html b/apidocs/com/amazon/carbonado/MalformedArgumentException.html new file mode 100644 index 0000000..27c1444 --- /dev/null +++ b/apidocs/com/amazon/carbonado/MalformedArgumentException.html @@ -0,0 +1,349 @@ + + + + + + +MalformedArgumentException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado
+

Class MalformedArgumentException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    Direct Known Subclasses:
    +
    MalformedFilterException, MalformedTypeException
    +
    +
    +
    +
    public abstract class MalformedArgumentException
+extends java.lang.IllegalArgumentException
    +
    A MalformedArgumentException is thrown after detailed analysis on an + argument determined it was not suitable. This class is abstract to prevent + its direct use. Subclasses are encouraged to provide more detail as to the + cause of the exception.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetMessage() 
      java.util.List<java.lang.String>getMessages() +
      Multiple error messages may be embedded in a MalformedArgumentException.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MalformedArgumentException

        +
        protected MalformedArgumentException()
        +
        • +
      + + + +
        +
      • +

        MalformedArgumentException

        +
        protected MalformedArgumentException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        MalformedArgumentException

        +
        protected MalformedArgumentException(java.util.List<java.lang.String> messages)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getMessage

        +
        public java.lang.String getMessage()
        +
        +
        Overrides:
        +
        getMessage in class java.lang.Throwable
        +
        +
        • +
      + + + +
        +
      • +

        getMessages

        +
        public java.util.List<java.lang.String> getMessages()
        +
        Multiple error messages may be embedded in a MalformedArgumentException.
        +
        Returns:
        non-null, unmodifiable list of messages
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/MalformedFilterException.html b/apidocs/com/amazon/carbonado/MalformedFilterException.html new file mode 100644 index 0000000..e5e7815 --- /dev/null +++ b/apidocs/com/amazon/carbonado/MalformedFilterException.html @@ -0,0 +1,371 @@ + + + + + + +MalformedFilterException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado
+

Class MalformedFilterException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class MalformedFilterException
+extends MalformedArgumentException
    +
    A MalformedFilterException indicates that a + query filter is invalid.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      intgetCulpritIndex() +
      Returns the index into the query filter string that is malformed, or a + negative value if not known.
      +
      java.lang.StringgetFilter() +
      Returns the malformed query filter.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MalformedFilterException

        +
        public MalformedFilterException(java.lang.String filter)
        +
        • +
      + + + +
        +
      • +

        MalformedFilterException

        +
        public MalformedFilterException(java.lang.String filter,
+                        int index)
        +
        • +
      + + + +
        +
      • +

        MalformedFilterException

        +
        public MalformedFilterException(java.lang.String filter,
+                        java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        MalformedFilterException

        +
        public MalformedFilterException(java.lang.String filter,
+                        java.lang.String message,
+                        int index)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFilter

        +
        public java.lang.String getFilter()
        +
        Returns the malformed query filter.
        +
        • +
      + + + +
        +
      • +

        getCulpritIndex

        +
        public int getCulpritIndex()
        +
        Returns the index into the query filter string that is malformed, or a + negative value if not known.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/MalformedTypeException.html b/apidocs/com/amazon/carbonado/MalformedTypeException.html new file mode 100644 index 0000000..9181e2e --- /dev/null +++ b/apidocs/com/amazon/carbonado/MalformedTypeException.html @@ -0,0 +1,354 @@ + + + + + + +MalformedTypeException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado
+

Class MalformedTypeException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class MalformedTypeException
+extends MalformedArgumentException
    +
    A MalformedTypeException indicates that a Storable is defined in a + way that violates the requirements for Storable objects.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      MalformedTypeException(java.lang.Class<?> malformedType) 
      MalformedTypeException(java.lang.Class<?> malformedType, + java.util.List<java.lang.String> messages) 
      MalformedTypeException(java.lang.Class<?> malformedType, + java.lang.String message) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.Class<?>getMalformedType() 
      java.lang.StringgetMessage() +
      Returns first message, prefixed with the malformed type.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MalformedTypeException

        +
        public MalformedTypeException(java.lang.Class<?> malformedType)
        +
        • +
      + + + +
        +
      • +

        MalformedTypeException

        +
        public MalformedTypeException(java.lang.Class<?> malformedType,
+                      java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        MalformedTypeException

        +
        public MalformedTypeException(java.lang.Class<?> malformedType,
+                      java.util.List<java.lang.String> messages)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getMessage

        +
        public java.lang.String getMessage()
        +
        Returns first message, prefixed with the malformed type.
        +
        +
        Overrides:
        +
        getMessage in class MalformedArgumentException
        +
        +
        • +
      + + + +
        +
      • +

        getMalformedType

        +
        public java.lang.Class<?> getMalformedType()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/MismatchException.html b/apidocs/com/amazon/carbonado/MismatchException.html new file mode 100644 index 0000000..8310273 --- /dev/null +++ b/apidocs/com/amazon/carbonado/MismatchException.html @@ -0,0 +1,393 @@ + + + + + + +MismatchException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado
+

Class MismatchException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class MismatchException
+extends SupportException
    +
    Indicates that a Storable doesn't exactly match up with an external + schema. This exception may only be thrown by repositories with a dependency + on an external schema.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MismatchException

        +
        public MismatchException()
        +
        • +
      + + + +
        +
      • +

        MismatchException

        +
        public MismatchException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        MismatchException

        +
        public MismatchException(java.util.List<java.lang.String> messages)
        +
        • +
      + + + +
        +
      • +

        MismatchException

        +
        public MismatchException(java.lang.Class<?> malformedType)
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        MismatchException

        +
        public MismatchException(java.lang.Class<?> malformedType,
+                 java.lang.String message)
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        MismatchException

        +
        public MismatchException(java.lang.Class<?> malformedType,
+                 java.util.List<java.lang.String> messages)
        +
        Since:
        +
        1.2
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getMessage

        +
        public java.lang.String getMessage()
        +
        +
        Overrides:
        +
        getMessage in class java.lang.Throwable
        +
        +
        • +
      + + + +
        +
      • +

        getMessages

        +
        public java.util.List<java.lang.String> getMessages()
        +
        Multiple error messages may be embedded in a MismatchException.
        +
        Returns:
        non-null, unmodifiable list of messages
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/Name.html b/apidocs/com/amazon/carbonado/Name.html new file mode 100644 index 0000000..496a561 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Name.html @@ -0,0 +1,228 @@ + + + + + + +Name (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado
+

Annotation Type Name

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+public @interface Name
    +
    Overrides the primary name of a Storable property. By default, the primary + name of a property is determined by JavaBeans conventions. When overridden, + all references to the named property must use the new name. + +

    Example:

    + @PrimaryKey("userId")
+ public interface UserInfo extends Storable<UserInfo> {
+     @Name("userId")
+     long getUserInfoID();
+     void setUserInfoID(long id);
+
+     ...
+ }
+
    + + The first character of a name must be a unicode identifier start, and all + subsequent characters must be a unicode identifier part.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Fang Chen, Brian S O'Neill
    +
    See Also:
    Alias
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.Stringvalue +
      Name assigned to the property.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String value
        +
        Name assigned to the property.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/NonDurableCommitException.html b/apidocs/com/amazon/carbonado/NonDurableCommitException.html new file mode 100644 index 0000000..7197b61 --- /dev/null +++ b/apidocs/com/amazon/carbonado/NonDurableCommitException.html @@ -0,0 +1,313 @@ + + + + + + +NonDurableCommitException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Class NonDurableCommitException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class NonDurableCommitException
+extends PersistException
    +
    Thrown during a transaction commit if durability guarantees cannot be met. + In a replication system, this exception can indicate that some replicas have + not yet acknowledged the commit. They may still complete normally, but at an + indeterminate time.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NonDurableCommitException

        +
        public NonDurableCommitException()
        +
        • +
      + + + +
        +
      • +

        NonDurableCommitException

        +
        public NonDurableCommitException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        NonDurableCommitException

        +
        public NonDurableCommitException(java.lang.String message,
+                         java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        NonDurableCommitException

        +
        public NonDurableCommitException(java.lang.Throwable cause)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/Nullable.html b/apidocs/com/amazon/carbonado/Nullable.html new file mode 100644 index 0000000..e79f407 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Nullable.html @@ -0,0 +1,177 @@ + + + + + + +Nullable (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Annotation Type Nullable

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+public @interface Nullable
    +
    Identifies that a Storable property can have a null value. By + default, all Storable properties are required to have a non-null value. It + is illegal to declare a property as nullable whose type is a primitive + non-object. + +

    Example:

    + public interface UserInfo extends Storable<UserInfo> {
+     @Nullable
+     String getName();
+     void setName(String name);
+
+     ...
+ }
+
    + +

    If the repository does not allow a property to be declared as nullable + because the underlying schema differs, it can be also annotated as Independent. This makes it easier for a common set of Storables to interact + with schemas which are slightly different. Attempting to persist null into a + property for which null is not allowed will likely result in a constraint + exception.

    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/OptimisticLockException.html b/apidocs/com/amazon/carbonado/OptimisticLockException.html new file mode 100644 index 0000000..9028548 --- /dev/null +++ b/apidocs/com/amazon/carbonado/OptimisticLockException.html @@ -0,0 +1,427 @@ + + + + + + +OptimisticLockException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado
+

Class OptimisticLockException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class OptimisticLockException
+extends PersistException
    +
    An OptimisticLockException is thrown if the Repository is using + optimistic locking for concurrency control, and lock aquisition failed. + This exception may also be thrown if multiversion concurrency control (MVCC) + is being used and the commit fails.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        OptimisticLockException

        +
        public OptimisticLockException()
        +
        • +
      + + + +
        +
      • +

        OptimisticLockException

        +
        public OptimisticLockException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        OptimisticLockException

        +
        public OptimisticLockException(java.lang.String message,
+                       java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        OptimisticLockException

        +
        public OptimisticLockException(java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        OptimisticLockException

        +
        public OptimisticLockException(long expectedVersion)
        +
        Parameters:
        expectedVersion - version number that was expected for persistent + record when update was executed
        +
        • +
      + + + +
        +
      • +

        OptimisticLockException

        +
        public OptimisticLockException(java.lang.Object expectedVersion)
        +
        Parameters:
        expectedVersion - version number that was expected for persistent + record when update was executed
        +
        • +
      + + + +
        +
      • +

        OptimisticLockException

        +
        public OptimisticLockException(java.lang.Object expectedVersion,
+                       java.lang.Object savedVersion)
        +
        Parameters:
        expectedVersion - version number that was expected for persistent + record when update was executed
        savedVersion - actual persistent version number of storable
        +
        • +
      + + + +
        +
      • +

        OptimisticLockException

        +
        public OptimisticLockException(java.lang.Object expectedVersion,
+                       java.lang.Object savedVersion,
+                       Storable s)
        +
        Parameters:
        expectedVersion - version number that was expected for persistent + record when update was executed
        savedVersion - actual persistent version number of storable
        s - Storable which was acted upon
        +
        • +
      + + + +
        +
      • +

        OptimisticLockException

        +
        public OptimisticLockException(java.lang.Object savedVersion,
+                       Storable s,
+                       java.lang.Object newVersion)
        +
        Construct exception for when new version was expected to have increased.
        +
        Parameters:
        savedVersion - actual persistent version number of storable
        s - Storable which was acted upon
        newVersion - new version which was provided
        Since:
        +
        1.2
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStorable

        +
        public Storable getStorable()
        +
        Returns the Storable which was acted upon, or null if not available.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/PartitionKey.html b/apidocs/com/amazon/carbonado/PartitionKey.html new file mode 100644 index 0000000..d6b9e6a --- /dev/null +++ b/apidocs/com/amazon/carbonado/PartitionKey.html @@ -0,0 +1,228 @@ + + + + + + +PartitionKey (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado
+

Annotation Type PartitionKey

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=TYPE)
+public @interface PartitionKey
    +
    Identifies a Storable property as being a member of the partition key. + This key is ignored if the underlying repository lacks support for partitioning. + +

    Example:

    + @PrimaryKey("userInfoID")
+ @PartitionKey("userInfoGroup")
+ public interface UserInfo extends Storable<UserInfo> {
+     long getUserInfoID();
+     void setUserInfoID(long id);
+
+     String getUserInfoGroup();
+     void setUserInfoGroup(String group);
+
+     ...
+ }
+
    +
    Author:
    +
    Archit Shivaprakash
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.String[]value +
      A list of property names.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String[] value
        +
        A list of property names.
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/PersistDeadlockException.html b/apidocs/com/amazon/carbonado/PersistDeadlockException.html new file mode 100644 index 0000000..f85714f --- /dev/null +++ b/apidocs/com/amazon/carbonado/PersistDeadlockException.html @@ -0,0 +1,349 @@ + + + + + + +PersistDeadlockException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado
+

Class PersistDeadlockException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class PersistDeadlockException
+extends PersistException
    +
    Thrown if a persist operation fails because it was selected to resolve a + deadlock.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PersistDeadlockException

        +
        public PersistDeadlockException()
        +
        • +
      + + + +
        +
      • +

        PersistDeadlockException

        +
        public PersistDeadlockException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        PersistDeadlockException

        +
        public PersistDeadlockException(java.lang.String message,
+                        java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        PersistDeadlockException

        +
        public PersistDeadlockException(java.lang.Throwable cause)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        makeFetchException

        +
        protected FetchException makeFetchException(java.lang.String message,
+                                java.lang.Throwable cause)
        +
        Description copied from class: RepositoryException
        +
        Subclasses can override this to provide a more specialized exception.
        +
        +
        Overrides:
        +
        makeFetchException in class RepositoryException
        +
        Parameters:
        message - exception message, which may be null
        cause - non-null cause
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/PersistDeniedException.html b/apidocs/com/amazon/carbonado/PersistDeniedException.html new file mode 100644 index 0000000..8eb08b9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/PersistDeniedException.html @@ -0,0 +1,311 @@ + + + + + + +PersistDeniedException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Class PersistDeniedException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class PersistDeniedException
+extends PersistException
    +
    Thrown when a persist operation was denied either because the repository is + in read-only mode, or the connection does not have permission.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PersistDeniedException

        +
        public PersistDeniedException()
        +
        • +
      + + + +
        +
      • +

        PersistDeniedException

        +
        public PersistDeniedException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        PersistDeniedException

        +
        public PersistDeniedException(java.lang.String message,
+                      java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        PersistDeniedException

        +
        public PersistDeniedException(java.lang.Throwable cause)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/PersistException.html b/apidocs/com/amazon/carbonado/PersistException.html new file mode 100644 index 0000000..ed4e04d --- /dev/null +++ b/apidocs/com/amazon/carbonado/PersistException.html @@ -0,0 +1,310 @@ + + + + + + +PersistException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Class PersistException

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PersistException

        +
        public PersistException()
        +
        • +
      + + + +
        +
      • +

        PersistException

        +
        public PersistException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        PersistException

        +
        public PersistException(java.lang.String message,
+                java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        PersistException

        +
        public PersistException(java.lang.Throwable cause)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/PersistInterruptedException.html b/apidocs/com/amazon/carbonado/PersistInterruptedException.html new file mode 100644 index 0000000..e7c1002 --- /dev/null +++ b/apidocs/com/amazon/carbonado/PersistInterruptedException.html @@ -0,0 +1,350 @@ + + + + + + +PersistInterruptedException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado
+

Class PersistInterruptedException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class PersistInterruptedException
+extends PersistException
    +
    Thrown from a persist operation that was canceled.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PersistInterruptedException

        +
        public PersistInterruptedException()
        +
        • +
      + + + +
        +
      • +

        PersistInterruptedException

        +
        public PersistInterruptedException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        PersistInterruptedException

        +
        public PersistInterruptedException(java.lang.String message,
+                           java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        PersistInterruptedException

        +
        public PersistInterruptedException(java.lang.Throwable cause)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        makeFetchException

        +
        protected FetchException makeFetchException(java.lang.String message,
+                                java.lang.Throwable cause)
        +
        Description copied from class: RepositoryException
        +
        Subclasses can override this to provide a more specialized exception.
        +
        +
        Overrides:
        +
        makeFetchException in class RepositoryException
        +
        Parameters:
        message - exception message, which may be null
        cause - non-null cause
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/PersistMultipleException.html b/apidocs/com/amazon/carbonado/PersistMultipleException.html new file mode 100644 index 0000000..f2ccc97 --- /dev/null +++ b/apidocs/com/amazon/carbonado/PersistMultipleException.html @@ -0,0 +1,349 @@ + + + + + + +PersistMultipleException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado
+

Class PersistMultipleException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class PersistMultipleException
+extends PersistException
    +
    A PersistMultipleException is thrown when a persist operation would have + applied to more than one record when at most one was expected.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PersistMultipleException

        +
        public PersistMultipleException()
        +
        • +
      + + + +
        +
      • +

        PersistMultipleException

        +
        public PersistMultipleException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        PersistMultipleException

        +
        public PersistMultipleException(java.lang.String message,
+                        java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        PersistMultipleException

        +
        public PersistMultipleException(java.lang.Throwable cause)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        makeFetchException

        +
        protected FetchException makeFetchException(java.lang.String message,
+                                java.lang.Throwable cause)
        +
        Description copied from class: RepositoryException
        +
        Subclasses can override this to provide a more specialized exception.
        +
        +
        Overrides:
        +
        makeFetchException in class RepositoryException
        +
        Parameters:
        message - exception message, which may be null
        cause - non-null cause
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/PersistNoneException.html b/apidocs/com/amazon/carbonado/PersistNoneException.html new file mode 100644 index 0000000..3aa633d --- /dev/null +++ b/apidocs/com/amazon/carbonado/PersistNoneException.html @@ -0,0 +1,349 @@ + + + + + + +PersistNoneException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado
+

Class PersistNoneException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class PersistNoneException
+extends PersistException
    +
    A PersistNoneException is thrown when a persist operation applied to no + records when at least one was expected.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PersistNoneException

        +
        public PersistNoneException()
        +
        • +
      + + + +
        +
      • +

        PersistNoneException

        +
        public PersistNoneException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        PersistNoneException

        +
        public PersistNoneException(java.lang.String message,
+                    java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        PersistNoneException

        +
        public PersistNoneException(java.lang.Throwable cause)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        makeFetchException

        +
        protected FetchException makeFetchException(java.lang.String message,
+                                java.lang.Throwable cause)
        +
        Description copied from class: RepositoryException
        +
        Subclasses can override this to provide a more specialized exception.
        +
        +
        Overrides:
        +
        makeFetchException in class RepositoryException
        +
        Parameters:
        message - exception message, which may be null
        cause - non-null cause
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/PersistTimeoutException.html b/apidocs/com/amazon/carbonado/PersistTimeoutException.html new file mode 100644 index 0000000..c9df69e --- /dev/null +++ b/apidocs/com/amazon/carbonado/PersistTimeoutException.html @@ -0,0 +1,348 @@ + + + + + + +PersistTimeoutException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado
+

Class PersistTimeoutException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class PersistTimeoutException
+extends PersistException
    +
    Thrown if a persist operation fails because lock acquisition timed out.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PersistTimeoutException

        +
        public PersistTimeoutException()
        +
        • +
      + + + +
        +
      • +

        PersistTimeoutException

        +
        public PersistTimeoutException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        PersistTimeoutException

        +
        public PersistTimeoutException(java.lang.String message,
+                       java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        PersistTimeoutException

        +
        public PersistTimeoutException(java.lang.Throwable cause)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        makeFetchException

        +
        protected FetchException makeFetchException(java.lang.String message,
+                                java.lang.Throwable cause)
        +
        Description copied from class: RepositoryException
        +
        Subclasses can override this to provide a more specialized exception.
        +
        +
        Overrides:
        +
        makeFetchException in class RepositoryException
        +
        Parameters:
        message - exception message, which may be null
        cause - non-null cause
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/PrimaryKey.html b/apidocs/com/amazon/carbonado/PrimaryKey.html new file mode 100644 index 0000000..d916a4f --- /dev/null +++ b/apidocs/com/amazon/carbonado/PrimaryKey.html @@ -0,0 +1,225 @@ + + + + + + +PrimaryKey (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado
+

Annotation Type PrimaryKey

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=TYPE)
+public @interface PrimaryKey
    +
    Identifies a Storable property as being a member of the primary + key. All Storable types must have at least one property belonging to the + primary key. + +

    Example:

    + @PrimaryKey("userInfoID")
+ public interface UserInfo extends Storable<UserInfo> {
+     long getUserInfoID();
+     void setUserInfoID(long id);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    AlternateKeys, +Sequence
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.String[]value +
      A list of property names, which may be prefixed with '+' or '-' to + indicate a preference for ascending or descending order.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String[] value
        +
        A list of property names, which may be prefixed with '+' or '-' to + indicate a preference for ascending or descending order.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/Query.Controller.html b/apidocs/com/amazon/carbonado/Query.Controller.html new file mode 100644 index 0000000..1b949aa --- /dev/null +++ b/apidocs/com/amazon/carbonado/Query.Controller.html @@ -0,0 +1,307 @@ + + + + + + +Query.Controller (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Interface Query.Controller

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.lang.AutoCloseable, java.io.Closeable, java.io.Serializable
    +
    +
    +
    All Known Implementing Classes:
    +
    Query.Timeout
    +
    +
    +
    Enclosing interface:
    +
    Query<S extends Storable>
    +
    +
    +
    +
    public static interface Query.Controller
+extends java.io.Serializable, java.io.Closeable
    +
    Controller instance can be used to abort query operations. + +

    Example:

    + Storage<UserInfo> users = ...
+ long count = users.query("name = ?").count(Query.Timeout.seconds(10));
+
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidbegin() +
      Called by query when it begins, possibly multiple times.
      +
      voidclose() +
      Always called by query when finished, even when it fails.
      +
      voidcontinueCheck() +
      Periodically called by query to determine if it should continue.
      +
      longgetTimeout() +
      Returns a non-negative value if controller imposes an absolute upper + bound on query execution time.
      +
      java.util.concurrent.TimeUnitgetTimeoutUnit() +
      Returns the unit for the timeout, if applicable.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getTimeout

        +
        long getTimeout()
        +
        Returns a non-negative value if controller imposes an absolute upper + bound on query execution time.
        +
        • +
      + + + +
        +
      • +

        getTimeoutUnit

        +
        java.util.concurrent.TimeUnit getTimeoutUnit()
        +
        Returns the unit for the timeout, if applicable.
        +
        • +
      + + + +
        +
      • +

        begin

        +
        void begin()
        +
        Called by query when it begins, possibly multiple times. Implementation + is required to be idempotent and ignore multiple invocations.
        +
        • +
      + + + +
        +
      • +

        continueCheck

        +
        void continueCheck()
+                   throws FetchException
        +
        Periodically called by query to determine if it should continue.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        close

        +
        void close()
        +
        Always called by query when finished, even when it fails. Implementation + is required to be idempotent and ignore multiple invocations.
        +
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Specified by:
        +
        close in interface java.io.Closeable
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/Query.Timeout.html b/apidocs/com/amazon/carbonado/Query.Timeout.html new file mode 100644 index 0000000..0f6d511 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Query.Timeout.html @@ -0,0 +1,493 @@ + + + + + + +Query.Timeout (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado
+

Class Query.Timeout

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Query.Controller, java.io.Closeable, java.io.Serializable, java.lang.AutoCloseable
    +
    +
    +
    Enclosing interface:
    +
    Query<S extends Storable>
    +
    +
    +
    +
    public static final class Query.Timeout
+extends java.lang.Object
+implements Query.Controller
    +
    Timeout controller, for aborting long running queries. One instance is + good for one timeout. The instance can be shared by multiple queries, if + they are part of a single logical operation. + +

    The timeout applies to the entire duration of fetching results, not + just the time spent between individual fetches. A caller which is slowly + processing results can timeout. More sophisticated timeouts can be + implemented using custom Controller implementations.

    +
    See Also:
    Serialized Form
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Query.Timeout(long timeout, + java.util.concurrent.TimeUnit unit) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidbegin() +
      Called by query when it begins, possibly multiple times.
      +
      voidclose() +
      Always called by query when finished, even when it fails.
      +
      voidcontinueCheck() +
      Periodically called by query to determine if it should continue.
      +
      longgetTimeout() +
      Returns a non-negative value if controller imposes an absolute upper + bound on query execution time.
      +
      java.util.concurrent.TimeUnitgetTimeoutUnit() +
      Returns the unit for the timeout, if applicable.
      +
      static Query.Timeouthours(long timeout) +
      Return a new Timeout in hours.
      +
      static Query.Timeoutmicros(long timeout) +
      Return a new Timeout in microseconds.
      +
      static Query.Timeoutmillis(long timeout) +
      Return a new Timeout in milliseconds.
      +
      static Query.Timeoutminutes(long timeout) +
      Return a new Timeout in minutes.
      +
      static Query.Timeoutnanos(long timeout) +
      Return a new Timeout in nanoseconds.
      +
      static Query.Timeoutseconds(long timeout) +
      Return a new Timeout in seconds.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Query.Timeout

        +
        public Query.Timeout(long timeout,
+             java.util.concurrent.TimeUnit unit)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        nanos

        +
        public static Query.Timeout nanos(long timeout)
        +
        Return a new Timeout in nanoseconds.
        +
        • +
      + + + +
        +
      • +

        micros

        +
        public static Query.Timeout micros(long timeout)
        +
        Return a new Timeout in microseconds.
        +
        • +
      + + + +
        +
      • +

        millis

        +
        public static Query.Timeout millis(long timeout)
        +
        Return a new Timeout in milliseconds.
        +
        • +
      + + + +
        +
      • +

        seconds

        +
        public static Query.Timeout seconds(long timeout)
        +
        Return a new Timeout in seconds.
        +
        • +
      + + + +
        +
      • +

        minutes

        +
        public static Query.Timeout minutes(long timeout)
        +
        Return a new Timeout in minutes.
        +
        • +
      + + + +
        +
      • +

        hours

        +
        public static Query.Timeout hours(long timeout)
        +
        Return a new Timeout in hours.
        +
        • +
      + + + +
        +
      • +

        getTimeout

        +
        public long getTimeout()
        +
        Description copied from interface: Query.Controller
        +
        Returns a non-negative value if controller imposes an absolute upper + bound on query execution time.
        +
        +
        Specified by:
        +
        getTimeout in interface Query.Controller
        +
        +
        • +
      + + + +
        +
      • +

        getTimeoutUnit

        +
        public java.util.concurrent.TimeUnit getTimeoutUnit()
        +
        Description copied from interface: Query.Controller
        +
        Returns the unit for the timeout, if applicable.
        +
        +
        Specified by:
        +
        getTimeoutUnit in interface Query.Controller
        +
        +
        • +
      + + + +
        +
      • +

        begin

        +
        public void begin()
        +
        Description copied from interface: Query.Controller
        +
        Called by query when it begins, possibly multiple times. Implementation + is required to be idempotent and ignore multiple invocations.
        +
        +
        Specified by:
        +
        begin in interface Query.Controller
        +
        +
        • +
      + + + + + + + +
        +
      • +

        close

        +
        public void close()
        +
        Description copied from interface: Query.Controller
        +
        Always called by query when finished, even when it fails. Implementation + is required to be idempotent and ignore multiple invocations.
        +
        +
        Specified by:
        +
        close in interface Query.Controller
        +
        Specified by:
        +
        close in interface java.io.Closeable
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/Query.html b/apidocs/com/amazon/carbonado/Query.html new file mode 100644 index 0000000..9b7d5af --- /dev/null +++ b/apidocs/com/amazon/carbonado/Query.html @@ -0,0 +1,1431 @@ + + + + + + +Query (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Interface Query<S extends Storable>

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    AbstractQuery, EmptyQuery, StandardQuery
    +
    +
    +
    +
    public interface Query<S extends Storable>
    +
    Supports complex retrieval and deletion of Storable objects. + Queries are immutable representations of an action – they do not + contain any Storable instances. The apparent mutators (with, et al) do not + actually modify the Query. Instead, they return another Query instance which + has the requested modification. To obtain an initial Query instance, call + one of the Storage query methods. + +

    Query objects are usually compiled and cached, and the same instance can + be re-used for future queries. This is possible because queries are + immutable and naturally thread-safe.

    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeInterface and Description
      static interface Query.Controller +
      Controller instance can be used to abort query operations.
      +
      static class Query.Timeout +
      Timeout controller, for aborting long running queries.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      <T extends S> 
      Query<S>      		after(T start) +
      Returns a query which fetches results for this query after a given + starting point, which is useful for re-opening a cursor.
      +
      Query<S>and(Filter<S> filter) +
      Returns a new query which has another filter logically "and"ed to this, potentially reducing the amount of + results.
      +
      Query<S>and(java.lang.String filter) +
      Returns a new query which has another filter logically "and"ed to this, potentially reducing the amount of + results.
      +
      longcount() +
      Returns a count of all results matched by this query.
      +
      longcount(Query.Controller controller) +
      Returns a count of all results matched by this query.
      +
      voiddeleteAll() +
      Deletes zero or more matching objects.
      +
      voiddeleteAll(Query.Controller controller) +
      Deletes zero or more matching objects.
      +
      voiddeleteOne() +
      Deletes one matching object.
      +
      voiddeleteOne(Query.Controller controller) +
      Deletes one matching object.
      +
      booleanequals(java.lang.Object obj) 
      booleanexists() +
      Returns true if any results are matched by this query.
      +
      booleanexists(Query.Controller controller) +
      Returns true if any results are matched by this query.
      +
      Cursor<S>fetch() +
      Fetches results for this query.
      +
      Cursor<S>fetch(Query.Controller controller) +
      Fetches results for this query.
      +
      <T extends S> 
      Cursor<S>      		fetchAfter(T start) +
      Fetches results for this query after a given starting point, which is + useful for re-opening a cursor.
      +
      <T extends S> 
      Cursor<S>      		fetchAfter(T start, + Query.Controller controller) +
      Fetches results for this query after a given starting point, which is + useful for re-opening a cursor.
      +
      Cursor<S>fetchSlice(long from, + java.lang.Long to) +
      Fetches a slice of results for this query, as defined by a numerical + range.
      +
      Cursor<S>fetchSlice(long from, + java.lang.Long to, + Query.Controller controller) +
      Fetches a slice of results for this query, as defined by a numerical + range.
      +
      intgetBlankParameterCount() +
      Returns the amount of blank parameters that need to be filled in.
      +
      Filter<S>getFilter() +
      Returns the query's filter.
      +
      FilterValues<S>getFilterValues() +
      Returns the query's filter values, which is null if filter has no + parameters.
      +
      java.lang.Class<S>getStorableType() +
      Returns the specific type of Storable managed by this object.
      +
      inthashCode() 
      SloadOne() +
      Attempts to load exactly one matching object.
      +
      SloadOne(Query.Controller controller) +
      Attempts to load exactly one matching object.
      +
      Query<S>not() +
      Returns a new query which produces all the results not supplied in this + query.
      +
      Query<S>or(Filter<S> filter) +
      Returns a new query which has another filter logically "or"ed to this, potentially increasing the amount of + results.
      +
      Query<S>or(java.lang.String filter) +
      Returns a new query which has another filter logically "or"ed to this, potentially increasing the amount of + results.
      +
      Query<S>orderBy(java.lang.String... properties) +
      Returns a copy of this query ordered by specific property values.
      +
      Query<S>orderBy(java.lang.String property) +
      Returns a copy of this query ordered by a specific property value.
      +
      booleanprintNative() +
      Print the native query to standard out, which is useful for performance + analysis.
      +
      booleanprintNative(java.lang.Appendable app) +
      Prints the native query to any appendable, which is useful for + performance analysis.
      +
      booleanprintNative(java.lang.Appendable app, + int indentLevel) +
      Prints the native query to any appendable, which is useful for + performance analysis.
      +
      booleanprintPlan() +
      Prints the query excecution plan to standard out, which is useful for + performance analysis.
      +
      booleanprintPlan(java.lang.Appendable app) +
      Prints the query excecution plan to any appendable, which is useful for + performance analysis.
      +
      booleanprintPlan(java.lang.Appendable app, + int indentLevel) +
      Prints the query excecution plan to any appendable, which is useful for + performance analysis.
      +
      java.lang.StringtoString() +
      Returns a description of the query filter and any other arguments.
      +
      booleantryDeleteOne() +
      Deletes zero or one matching objects.
      +
      booleantryDeleteOne(Query.Controller controller) +
      Deletes zero or one matching objects.
      +
      StryLoadOne() +
      Tries to load one record, but returns null if nothing was found.
      +
      StryLoadOne(Query.Controller controller) +
      Tries to load one record, but returns null if nothing was found.
      +
      Query<S>with(boolean value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(byte value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(char value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(double value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(float value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(int value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(long value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(java.lang.Object value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(short value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>withValues(java.lang.Object... values) +
      Returns a copy of this Query with the next blank parameters filled in.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStorableType

        +
        java.lang.Class<S> getStorableType()
        +
        Returns the specific type of Storable managed by this object.
        +
        • +
      + + + +
        +
      • +

        getFilter

        +
        Filter<S> getFilter()
        +
        Returns the query's filter.
        +
        • +
      + + + +
        +
      • +

        getFilterValues

        +
        FilterValues<S> getFilterValues()
        +
        Returns the query's filter values, which is null if filter has no + parameters.
        +
        • +
      + + + +
        +
      • +

        getBlankParameterCount

        +
        int getBlankParameterCount()
        +
        Returns the amount of blank parameters that need to be filled in. If + zero, then this query is ready to be used.
        +
        • +
      + + + +
        +
      • +

        with

        +
        Query<S> with(int value)
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        Parameters:
        value - parameter value to fill in
        +
        Throws:
        +
        java.lang.IllegalStateException - if no blank parameters
        +
        java.lang.IllegalArgumentException - if type doesn't match
        +
        • +
      + + + +
        +
      • +

        with

        +
        Query<S> with(long value)
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        Parameters:
        value - parameter value to fill in
        +
        Throws:
        +
        java.lang.IllegalStateException - if no blank parameters
        +
        java.lang.IllegalArgumentException - if type doesn't match
        +
        • +
      + + + +
        +
      • +

        with

        +
        Query<S> with(float value)
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        Parameters:
        value - parameter value to fill in
        +
        Throws:
        +
        java.lang.IllegalStateException - if no blank parameters
        +
        java.lang.IllegalArgumentException - if type doesn't match
        +
        • +
      + + + +
        +
      • +

        with

        +
        Query<S> with(double value)
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        Parameters:
        value - parameter value to fill in
        +
        Throws:
        +
        java.lang.IllegalStateException - if no blank parameters
        +
        java.lang.IllegalArgumentException - if type doesn't match
        +
        • +
      + + + +
        +
      • +

        with

        +
        Query<S> with(boolean value)
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        Parameters:
        value - parameter value to fill in
        +
        Throws:
        +
        java.lang.IllegalStateException - if no blank parameters
        +
        java.lang.IllegalArgumentException - if type doesn't match
        +
        • +
      + + + +
        +
      • +

        with

        +
        Query<S> with(char value)
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        Parameters:
        value - parameter value to fill in
        +
        Throws:
        +
        java.lang.IllegalStateException - if no blank parameters
        +
        java.lang.IllegalArgumentException - if type doesn't match
        +
        • +
      + + + +
        +
      • +

        with

        +
        Query<S> with(byte value)
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        Parameters:
        value - parameter value to fill in
        +
        Throws:
        +
        java.lang.IllegalStateException - if no blank parameters
        +
        java.lang.IllegalArgumentException - if type doesn't match
        +
        • +
      + + + +
        +
      • +

        with

        +
        Query<S> with(short value)
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        Parameters:
        value - parameter value to fill in
        +
        Throws:
        +
        java.lang.IllegalStateException - if no blank parameters
        +
        java.lang.IllegalArgumentException - if type doesn't match
        +
        • +
      + + + +
        +
      • +

        with

        +
        Query<S> with(java.lang.Object value)
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        Parameters:
        value - parameter value to fill in
        +
        Throws:
        +
        java.lang.IllegalStateException - if no blank parameters
        +
        java.lang.IllegalArgumentException - if type doesn't match
        +
        • +
      + + + +
        +
      • +

        withValues

        +
        Query<S> withValues(java.lang.Object... values)
        +
        Returns a copy of this Query with the next blank parameters filled in.
        +
        Parameters:
        values - parameter values to fill in; if null or empty, this + Query instance is returned
        +
        Throws:
        +
        java.lang.IllegalStateException - if no blank parameters or if too many + parameter values supplied
        +
        java.lang.IllegalArgumentException - if any type doesn't match
        +
        • +
      + + + +
        +
      • +

        and

        +
        Query<S> and(java.lang.String filter)
+                              throws FetchException
        +
        Returns a new query which has another filter logically "and"ed to this, potentially reducing the amount of + results.
        +
        Parameters:
        filter - query filter expression
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        java.lang.IllegalStateException - if any blank parameters in this query, or + if this query is already guaranteed to fetch nothing
        +
        java.lang.IllegalArgumentException - if filter is null
        +
        MalformedFilterException - if expression is malformed
        +
        java.lang.UnsupportedOperationException - if given filter is unsupported by repository
        +
        • +
      + + + +
        +
      • +

        and

        +
        Query<S> and(Filter<S> filter)
+                              throws FetchException
        +
        Returns a new query which has another filter logically "and"ed to this, potentially reducing the amount of + results.
        +
        Parameters:
        filter - query filter
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        java.lang.IllegalStateException - if any blank parameters in this query, or + if this query is already guaranteed to fetch nothing
        +
        java.lang.IllegalArgumentException - if filter is null
        +
        java.lang.UnsupportedOperationException - if given filter is unsupported by repository
        +
        • +
      + + + +
        +
      • +

        or

        +
        Query<S> or(java.lang.String filter)
+                             throws FetchException
        +
        Returns a new query which has another filter logically "or"ed to this, potentially increasing the amount of + results.
        +
        Parameters:
        filter - query filter expression
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        java.lang.IllegalStateException - if any blank parameters in this query, or + if this query is already guaranteed to fetch everything
        +
        java.lang.IllegalArgumentException - if filter is null
        +
        MalformedFilterException - if expression is malformed
        +
        java.lang.UnsupportedOperationException - if given filter is unsupported by repository
        +
        • +
      + + + +
        +
      • +

        or

        +
        Query<S> or(Filter<S> filter)
+                             throws FetchException
        +
        Returns a new query which has another filter logically "or"ed to this, potentially increasing the amount of + results.
        +
        Parameters:
        filter - query filter
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        java.lang.IllegalStateException - if any blank parameters in this query, or + if this query is already guaranteed to fetch everything
        +
        java.lang.IllegalArgumentException - if filter is null
        +
        java.lang.UnsupportedOperationException - if given filter is unsupported by repository
        +
        • +
      + + + +
        +
      • +

        not

        +
        Query<S> not()
+                              throws FetchException
        +
        Returns a new query which produces all the results not supplied in this + query. Any filled in parameters in this query are copied into the new + one.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        java.lang.UnsupportedOperationException - if new query is unsupported by repository
        +
        • +
      + + + +
        +
      • +

        orderBy

        +
        Query<S> orderBy(java.lang.String property)
+                                  throws FetchException
        +
        Returns a copy of this query ordered by a specific property value. The + property name may be prefixed with '+' or '-' to indicate ascending or + descending order. If the prefix is omitted, ascending order is assumed. + +

        Note: Specification of ordering properties is not cumulative. Calling + this method will first remove any previous ordering properties.

        +
        Parameters:
        property - name of property to order by
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        java.lang.IllegalArgumentException - if property is null or is not a member + of type S
        +
        java.lang.UnsupportedOperationException - if given ordering, combined with + query filter, is unsupported by repository
        +
        • +
      + + + +
        +
      • +

        orderBy

        +
        Query<S> orderBy(java.lang.String... properties)
+                                  throws FetchException
        +
        Returns a copy of this query ordered by specific property values. The + property names may be prefixed with '+' or '-' to indicate ascending or + descending order. If the prefix is omitted, ascending order is assumed. + +

        Note: Specification of ordering properties is not cumulative. Calling + this method will first remove any previous ordering properties.

        +
        Parameters:
        properties - names of properties to order by
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        java.lang.IllegalArgumentException - if any property is null or is not a + member of type S
        +
        java.lang.UnsupportedOperationException - if given ordering, combined with + query filter, is unsupported by repository
        +
        • +
      + + + + + +
        +
      • +

        after

        +
        <T extends S> Query<S> after(T start)
+                                throws FetchException
        +
        Returns a query which fetches results for this query after a given + starting point, which is useful for re-opening a cursor. This is only + effective when query has been given an explicit ordering. If not a total ordering, then query may start at an earlier + position. + +

        Note: The returned query can be very expensive to fetch from + repeatedly, if the query needs to perform a sort operation. Ideally, the + query ordering should match the natural ordering of an index or key.

        +
        Parameters:
        start - storable to attempt to start after; if null, this query is + returned
        +
        Throws:
        +
        java.lang.IllegalStateException - if any blank parameters in this query
        +
        FetchException - if storage layer throws an exception
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        fetch

        +
        Cursor<S> fetch()
+                                 throws FetchException
        +
        Fetches results for this query. If any updates or deletes might be + performed on the results, consider enclosing the fetch in a + transaction. This allows the isolation level and "for update" mode to be + adjusted. Some repositories might otherwise deadlock.
        +
        Returns:
        fetch results
        +
        Throws:
        +
        java.lang.IllegalStateException - if any blank parameters in this query
        +
        FetchException - if storage layer throws an exception
        See Also:
        Repository.enterTransaction(IsolationLevel)
        +
        • +
      + + + +
        +
      • +

        fetch

        +
        Cursor<S> fetch(Query.Controller controller)
+                                 throws FetchException
        +
        Fetches results for this query. If any updates or deletes might be + performed on the results, consider enclosing the fetch in a + transaction. This allows the isolation level and "for update" mode to be + adjusted. Some repositories might otherwise deadlock.
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        fetch results
        +
        Throws:
        +
        java.lang.IllegalStateException - if any blank parameters in this query
        +
        FetchException - if storage layer throws an exception
        See Also:
        Repository.enterTransaction(IsolationLevel)
        +
        • +
      + + + +
        +
      • +

        fetchSlice

        +
        Cursor<S> fetchSlice(long from,
+                   java.lang.Long to)
+                                      throws FetchException
        +
        Fetches a slice of results for this query, as defined by a numerical + range. A slice can be used to limit the number of results from a + query. It is strongly recommended that the query be given a total ordering in order for the slice results to be deterministic.
        +
        Parameters:
        from - zero-based from record number, inclusive
        to - optional zero-based to record number, exclusive
        +
        Returns:
        fetch results
        +
        Throws:
        +
        java.lang.IllegalStateException - if any blank parameters in this query
        +
        java.lang.IllegalArgumentException - if from is negative or if + from is more than to
        +
        FetchException - if storage layer throws an exception
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        fetchSlice

        +
        Cursor<S> fetchSlice(long from,
+                   java.lang.Long to,
+                   Query.Controller controller)
+                                      throws FetchException
        +
        Fetches a slice of results for this query, as defined by a numerical + range. A slice can be used to limit the number of results from a + query. It is strongly recommended that the query be given a total ordering in order for the slice results to be deterministic.
        +
        Parameters:
        from - zero-based from record number, inclusive
        to - optional zero-based to record number, exclusive
        controller - optional controller which can abort query operation
        +
        Returns:
        fetch results
        +
        Throws:
        +
        java.lang.IllegalStateException - if any blank parameters in this query
        +
        java.lang.IllegalArgumentException - if from is negative or if + from is more than to
        +
        FetchException - if storage layer throws an exception
        Since:
        +
        1.2
        +
        • +
      + + + + + +
        +
      • +

        fetchAfter

        +
        <T extends S> Cursor<S> fetchAfter(T start)
+                                      throws FetchException
        +
        Fetches results for this query after a given starting point, which is + useful for re-opening a cursor. This is only effective when query has + been given an explicit ordering. If not a total + ordering, then cursor may start at an earlier position. + +

        Note: This method can be very expensive to call repeatedly, if the + query needs to perform a sort operation. Ideally, the query ordering + should match the natural ordering of an index or key. + +

        Calling fetchAfter(s) is equivalent to calling after(s).fetch().

        +
        Parameters:
        start - storable to attempt to start after; if null, fetch all results
        +
        Returns:
        fetch results
        +
        Throws:
        +
        java.lang.IllegalStateException - if any blank parameters in this query
        +
        FetchException - if storage layer throws an exception
        See Also:
        Repository.enterTransaction(IsolationLevel), +after(T)
        +
        • +
      + + + + + +
        +
      • +

        fetchAfter

        +
        <T extends S> Cursor<S> fetchAfter(T start,
+                                 Query.Controller controller)
+                                      throws FetchException
        +
        Fetches results for this query after a given starting point, which is + useful for re-opening a cursor. This is only effective when query has + been given an explicit ordering. If not a total + ordering, then cursor may start at an earlier position. + +

        Note: This method can be very expensive to call repeatedly, if the + query needs to perform a sort operation. Ideally, the query ordering + should match the natural ordering of an index or key. + +

        Calling fetchAfter(s) is equivalent to calling after(s).fetch().

        +
        Parameters:
        start - storable to attempt to start after; if null, fetch all results
        controller - optional controller which can abort query operation
        +
        Returns:
        fetch results
        +
        Throws:
        +
        java.lang.IllegalStateException - if any blank parameters in this query
        +
        FetchException - if storage layer throws an exception
        See Also:
        Repository.enterTransaction(IsolationLevel), +after(T)
        +
        • +
      + + + +
        +
      • +

        loadOne

        +
        S loadOne()
+                           throws FetchException
        +
        Attempts to load exactly one matching object. If the number of matching + records is zero or exceeds one, then an exception is thrown instead.
        +
        Returns:
        a single fetched object
        +
        Throws:
        +
        java.lang.IllegalStateException - if any blank parameters in this query
        +
        FetchNoneException - if no matching record found
        +
        FetchMultipleException - if more than one matching record found
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        loadOne

        +
        S loadOne(Query.Controller controller)
+                           throws FetchException
        +
        Attempts to load exactly one matching object. If the number of matching + records is zero or exceeds one, then an exception is thrown instead.
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        a single fetched object
        +
        Throws:
        +
        java.lang.IllegalStateException - if any blank parameters in this query
        +
        FetchNoneException - if no matching record found
        +
        FetchMultipleException - if more than one matching record found
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        tryLoadOne

        +
        S tryLoadOne()
+                              throws FetchException
        +
        Tries to load one record, but returns null if nothing was found. Throws + exception if record count is more than one.
        +
        Returns:
        null or a single fetched object
        +
        Throws:
        +
        java.lang.IllegalStateException - if any blank parameters in this query
        +
        FetchMultipleException - if more than one matching record found
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        tryLoadOne

        +
        S tryLoadOne(Query.Controller controller)
+                              throws FetchException
        +
        Tries to load one record, but returns null if nothing was found. Throws + exception if record count is more than one.
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        null or a single fetched object
        +
        Throws:
        +
        java.lang.IllegalStateException - if any blank parameters in this query
        +
        FetchMultipleException - if more than one matching record found
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        deleteOne

        +
        void deleteOne()
+               throws PersistException
        +
        Deletes one matching object. If the number of matching records is zero or + exceeds one, then no delete occurs, and an exception is thrown instead.
        +
        Throws:
        +
        java.lang.IllegalStateException - if any blank parameters in this query
        +
        PersistNoneException - if no matching record found
        +
        PersistMultipleException - if more than one record matches
        +
        PersistException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        deleteOne

        +
        void deleteOne(Query.Controller controller)
+               throws PersistException
        +
        Deletes one matching object. If the number of matching records is zero or + exceeds one, then no delete occurs, and an exception is thrown instead.
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Throws:
        +
        java.lang.IllegalStateException - if any blank parameters in this query
        +
        PersistNoneException - if no matching record found
        +
        PersistMultipleException - if more than one record matches
        +
        PersistException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        tryDeleteOne

        +
        boolean tryDeleteOne()
+                     throws PersistException
        +
        Deletes zero or one matching objects. If the number of matching records + exceeds one, then no delete occurs, and an exception is thrown instead.
        +
        Returns:
        true if record existed and was deleted, or false if no match
        +
        Throws:
        +
        java.lang.IllegalStateException - if any blank parameters in this query
        +
        PersistMultipleException - if more than one record matches
        +
        PersistException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        tryDeleteOne

        +
        boolean tryDeleteOne(Query.Controller controller)
+                     throws PersistException
        +
        Deletes zero or one matching objects. If the number of matching records + exceeds one, then no delete occurs, and an exception is thrown instead.
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        true if record existed and was deleted, or false if no match
        +
        Throws:
        +
        java.lang.IllegalStateException - if any blank parameters in this query
        +
        PersistMultipleException - if more than one record matches
        +
        PersistException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        deleteAll

        +
        void deleteAll()
+               throws PersistException
        +
        Deletes zero or more matching objects. There is no guarantee that + deleteAll is an atomic operation. If atomic behavior is desired, wrap + the call in a transaction scope.
        +
        Throws:
        +
        java.lang.IllegalStateException - if any blank parameters in this query
        +
        PersistException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        deleteAll

        +
        void deleteAll(Query.Controller controller)
+               throws PersistException
        +
        Deletes zero or more matching objects. There is no guarantee that + deleteAll is an atomic operation. If atomic behavior is desired, wrap + the call in a transaction scope.
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Throws:
        +
        java.lang.IllegalStateException - if any blank parameters in this query
        +
        PersistException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        count

        +
        long count()
+           throws FetchException
        +
        Returns a count of all results matched by this query. Even though no + results are explicitly fetched, this method may still be expensive to + call. The actual performance will vary by repository and available indexes.
        +
        Returns:
        count of matches
        +
        Throws:
        +
        java.lang.IllegalStateException - if any blank parameters in this query
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        count

        +
        long count(Query.Controller controller)
+           throws FetchException
        +
        Returns a count of all results matched by this query. Even though no + results are explicitly fetched, this method may still be expensive to + call. The actual performance will vary by repository and available indexes.
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        count of matches
        +
        Throws:
        +
        java.lang.IllegalStateException - if any blank parameters in this query
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        exists

        +
        boolean exists()
+               throws FetchException
        +
        Returns true if any results are matched by this query.
        +
        Returns:
        true if any matches
        +
        Throws:
        +
        java.lang.IllegalStateException - if any blank parameters in this query
        +
        FetchException - if storage layer throws an exception
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        exists

        +
        boolean exists(Query.Controller controller)
+               throws FetchException
        +
        Returns true if any results are matched by this query.
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        true if any matches
        +
        Throws:
        +
        java.lang.IllegalStateException - if any blank parameters in this query
        +
        FetchException - if storage layer throws an exception
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        printNative

        +
        boolean printNative()
        +
        Print the native query to standard out, which is useful for performance + analysis. Not all repositories have a native query format. An example + native format is SQL.
        +
        Returns:
        false if not implemented
        +
        • +
      + + + +
        +
      • +

        printNative

        +
        boolean printNative(java.lang.Appendable app)
+                    throws java.io.IOException
        +
        Prints the native query to any appendable, which is useful for + performance analysis. Not all repositories have a native query + format. An example native format is SQL.
        +
        Parameters:
        app - append results here
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        printNative

        +
        boolean printNative(java.lang.Appendable app,
+                  int indentLevel)
+                    throws java.io.IOException
        +
        Prints the native query to any appendable, which is useful for + performance analysis. Not all repositories have a native query + format. An example native format is SQL.
        +
        Parameters:
        app - append results here
        indentLevel - amount to indent text, zero for none
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        printPlan

        +
        boolean printPlan()
        +
        Prints the query excecution plan to standard out, which is useful for + performance analysis. There is no standard format for query plans, nor + is it a requirement that this method be implemented.
        +
        Returns:
        false if not implemented
        +
        • +
      + + + +
        +
      • +

        printPlan

        +
        boolean printPlan(java.lang.Appendable app)
+                  throws java.io.IOException
        +
        Prints the query excecution plan to any appendable, which is useful for + performance analysis. There is no standard format for query plans, nor + is it a requirement that this method be implemented.
        +
        Parameters:
        app - append results here
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        printPlan

        +
        boolean printPlan(java.lang.Appendable app,
+                int indentLevel)
+                  throws java.io.IOException
        +
        Prints the query excecution plan to any appendable, which is useful for + performance analysis. There is no standard format for query plans, nor + is it a requirement that this method be implemented.
        +
        Parameters:
        app - append results here
        indentLevel - amount to indent text, zero for none
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        java.lang.String toString()
        +
        Returns a description of the query filter and any other arguments.
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/Repository.html b/apidocs/com/amazon/carbonado/Repository.html new file mode 100644 index 0000000..74fa5d3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Repository.html @@ -0,0 +1,422 @@ + + + + + + +Repository (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Interface Repository

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    AbstractRepository
    +
    +
    +
    +
    public interface Repository
    +
    A Repository represents a database for Storable + instances. Some repositories do not have control over the schema (for example, a JDBC + Repository depends on the schema defined by the underlying relational database); such + repositories are called "dependent". Conversely, a repository which has complete control + over the schema is termed "independent". + +

    A dependent repository requires and will verify that Storables + have a matching definition in the external storage layer. An independent + repository will automatically update type definitions in its database to + match changes to Storable definitions. + +

    Repository instances should be thread-safe and immutable. Therefore, it + is safe for multiple threads to be interacting with a Repository.

    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    RepositoryBuilder
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Closes this repository reference, aborting any current + transactions.
      +
      TransactionenterTopTransaction(IsolationLevel level) +
      Causes the current thread to enter a top-level transaction scope + with an explict isolation level.
      +
      TransactionenterTransaction() +
      Causes the current thread to enter a transaction scope.
      +
      TransactionenterTransaction(IsolationLevel level) +
      Causes the current thread to enter a transaction scope with an explict + isolation level.
      +
      <C extends Capability> 
      C      		getCapability(java.lang.Class<C> capabilityType) +
      Requests a specific capability of this Repository.
      +
      java.lang.StringgetName() +
      Returns the name of this repository.
      +
      IsolationLevelgetTransactionIsolationLevel() +
      Returns the isolation level of the current transaction, or null if there + is no transaction in the current thread.
      +
      <S extends Storable> 
      Storage<S>      		storageFor(java.lang.Class<S> type) +
      Returns a Storage instance for the given user defined Storable class or + interface.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        java.lang.String getName()
        +
        Returns the name of this repository.
        +
        • +
      + + + +
        +
      • +

        storageFor

        +
        <S extends Storable> Storage<S> storageFor(java.lang.Class<S> type)
+                                       throws SupportException,
+                                              RepositoryException
        +
        Returns a Storage instance for the given user defined Storable class or + interface.
        +
        Returns:
        specific type of Storage instance
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if specified type is null
        +
        MalformedTypeException - if specified type is not suitable
        +
        SupportException - if specified type cannot be supported
        +
        RepositoryException - if storage layer throws any other kind of + exception
        +
        • +
      + + + +
        +
      • +

        enterTransaction

        +
        Transaction enterTransaction()
        +
        Causes the current thread to enter a transaction scope. Call commit + inside the transaction in order for any updates to the repository to be + applied. Be sure to call exit when leaving the scope. +

        + To ensure exit is called, use transactions as follows: + 

        + Transaction txn = repository.enterTransaction();
+ try {
+     // Make updates to storage layer
+     ...
+
+     // Commit the changes up to this point
+     txn.commit();
+
+     // Optionally make more updates
+     ...
+
+     // Commit remaining changes
+     txn.commit();
+ } finally {
+     // Ensure transaction exits, aborting uncommitted changes if an exception was thrown
+     txn.exit();
+ }
+
        +
        • +
      + + + +
        +
      • +

        enterTransaction

        +
        Transaction enterTransaction(IsolationLevel level)
        +
        Causes the current thread to enter a transaction scope with an explict + isolation level. The actual isolation level may be higher than + requested, if the repository does not support the exact level. If the + repository does not support a high enough level, it throws an + UnsupportedOperationException.
        +
        Parameters:
        level - minimum desired transaction isolation level -- if null, a + suitable default is selected
        +
        Throws:
        +
        java.lang.UnsupportedOperationException - if repository does not support + isolation as high as the desired level
        See Also:
        enterTransaction()
        +
        • +
      + + + +
        +
      • +

        enterTopTransaction

        +
        Transaction enterTopTransaction(IsolationLevel level)
        +
        Causes the current thread to enter a top-level transaction scope + with an explict isolation level. The actual isolation level may be + higher than requested, if the repository does not support the exact + level. If the repository does not support a high enough level, it throws + an UnsupportedOperationException. + +

        This method requests a top-level transaction, which means it never + has a parent transaction, but it still can be a parent transaction + itself. This kind of transaction is useful when a commit must absolutely + succeed, even if the current thread is already in a transaction + scope. If there was a parent transaction, then a commit might still be + rolled back by the parent. + +

        Requesting a top-level transaction can be deadlock prone if the + current thread is already in a transaction scope. The top-level + transaction may not be able to obtain locks held by the parent + transaction. An alternative to requesting top-level transactions is to + execute transactions in separate threads.

        +
        Parameters:
        level - minimum desired transaction isolation level -- if null, a + suitable default is selected
        +
        Throws:
        +
        java.lang.UnsupportedOperationException - if repository does not support + isolation as high as the desired level
        See Also:
        enterTransaction()
        +
        • +
      + + + +
        +
      • +

        getTransactionIsolationLevel

        +
        IsolationLevel getTransactionIsolationLevel()
        +
        Returns the isolation level of the current transaction, or null if there + is no transaction in the current thread.
        +
        • +
      + + + +
        +
      • +

        getCapability

        +
        <C extends Capability> C getCapability(java.lang.Class<C> capabilityType)
        +
        Requests a specific capability of this Repository. This allows + repositories to support extended features without having to clutter the + main repository interface. The list of supported capabilities is + documented with repository implementations.
        +
        Parameters:
        capabilityType - type of capability requested
        +
        Returns:
        capability instance or null if not supported
        +
        • +
      + + + +
        +
      • +

        close

        +
        void close()
        +
        Closes this repository reference, aborting any current + transactions. Operations on objects returned by this repository will + fail when accessing the storage layer.
        +
        Throws:
        +
        java.lang.SecurityException - if caller does not have permission
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/RepositoryBuilder.html b/apidocs/com/amazon/carbonado/RepositoryBuilder.html new file mode 100644 index 0000000..984be71 --- /dev/null +++ b/apidocs/com/amazon/carbonado/RepositoryBuilder.html @@ -0,0 +1,399 @@ + + + + + + +RepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Interface RepositoryBuilder

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    AbstractRepositoryBuilder, BDBRepositoryBuilder, IndexedRepositoryBuilder, JDBCRepositoryBuilder, LoggingRepositoryBuilder, MapRepositoryBuilder, ReplicatedRepositoryBuilder
    +
    +
    +
    +
    public interface RepositoryBuilder
    +
    Standard interface for building up configuration and opening a Repository instance. All repository implementations should be constructable + via a builder that implements this interface. Builders should follow a + pattern where configuration is supplied via property access methods. With + this design, each item can have extensive documentation and optional + configuration can be ignored. + +

    A builder design also offers advantages over constructors in that a + different repository can be built depending on the specific + configuration. This logic is hidden, making it easier to use repositories + that would otherwise require complex steps to construct. + +

    RepositoryBuilders are not expected to be thread-safe, but the + Repositories they build are thread-safe.

    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanaddTriggerFactory(TriggerFactory factory) +
      Optionally add a TriggerFactory which will be called upon to create an + initial trigger for each Storable type that the Repository supports.
      +
      Repositorybuild() +
      Builds a repository instance.
      +
      Repositorybuild(java.util.concurrent.atomic.AtomicReference<Repository> rootReference) +
      Builds a repository instance.
      +
      java.lang.StringgetName() +
      Returns the name of the repository.
      +
      java.lang.Iterable<TriggerFactory>getTriggerFactories() +
      Returns all the TriggerFactories which were added.
      +
      booleanisMaster() +
      Returns true if repository should assume the role of master, which is + true by default.
      +
      booleanremoveTriggerFactory(TriggerFactory factory) +
      Remove a TriggerFactory which was added earlier.
      +
      voidsetMaster(boolean b) +
      Set to false if repository should not assume the role of master.
      +
      voidsetName(java.lang.String name) +
      Set name for the repository, which is required.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        build

        +
        Repository build(java.util.concurrent.atomic.AtomicReference<Repository> rootReference)
+                 throws ConfigurationException,
+                        RepositoryException
        +
        Builds a repository instance. + +

        If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.

        +
        Parameters:
        rootReference - reference to root parent repository, to be set by + parent repository upon being built
        +
        Throws:
        +
        ConfigurationException - if there is a problem in the builder's configuration
        +
        RepositoryException - if there is a general problem opening the repository
        +
        • +
      + + + +
        +
      • +

        getName

        +
        java.lang.String getName()
        +
        Returns the name of the repository.
        +
        • +
      + + + +
        +
      • +

        setName

        +
        void setName(java.lang.String name)
        +
        Set name for the repository, which is required.
        +
        • +
      + + + +
        +
      • +

        isMaster

        +
        boolean isMaster()
        +
        Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        setMaster

        +
        void setMaster(boolean b)
        +
        Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        addTriggerFactory

        +
        boolean addTriggerFactory(TriggerFactory factory)
        +
        Optionally add a TriggerFactory which will be called upon to create an + initial trigger for each Storable type that the Repository supports. The + primary purpose of this method is to allow decorator repositories the + opportunity to register custom persistence code for each Storable.
        +
        Returns:
        true if TriggerFactory was added, false if TriggerFactory was + not added because an equal TriggerFactory is already registered
        +
        • +
      + + + +
        +
      • +

        removeTriggerFactory

        +
        boolean removeTriggerFactory(TriggerFactory factory)
        +
        Remove a TriggerFactory which was added earlier.
        +
        Returns:
        true if TriggerFactory instance was removed, false if not added
        +
        • +
      + + + +
        +
      • +

        getTriggerFactories

        +
        java.lang.Iterable<TriggerFactory> getTriggerFactories()
        +
        Returns all the TriggerFactories which were added.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/RepositoryException.html b/apidocs/com/amazon/carbonado/RepositoryException.html new file mode 100644 index 0000000..c56e4cd --- /dev/null +++ b/apidocs/com/amazon/carbonado/RepositoryException.html @@ -0,0 +1,499 @@ + + + + + + +RepositoryException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado
+

Class RepositoryException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    Direct Known Subclasses:
    +
    FetchException, PersistException, SupportException
    +
    +
    +
    +
    public class RepositoryException
+extends java.lang.Exception
    +
    General checked exception thrown when accessing a Repository. + +

    Some repository exceptions are the result of an optimistic lock failure + or deadlock. One resolution strategy is to exit all transactions and try the + operation again, after waiting some bounded random amount of time. As a + convenience, this class provides a mechanism to support such a backoff + strategy. For example: + + 

    + // Retry at most three more times
+ for (int retryCount = 3;;) {
+     try {
+         ...
+         myObject.load();
+         ...
+         myObject.update();
+         break;
+     } catch (OptimisticLockException e) {
+         // Wait up to one second before retrying
+         retryCount = e.backoff(e, retryCount, 1000);
+     }
+ }
+
    + + If the retry count is zero (or less) when backoff is called, then the + original exception is rethrown, indicating retry failure.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static <E extends java.lang.Throwable> 
      int      		backoff(E e, + int retryCount, + int milliseconds) +
      One strategy for resolving an optimistic lock failure is to try the + operation again, after waiting some bounded random amount of time.
      +
      java.lang.ThrowablegetRootCause() +
      Recursively calls getCause, until the root cause is found.
      +
      protected FetchExceptionmakeFetchException(java.lang.String message, + java.lang.Throwable cause) +
      Subclasses can override this to provide a more specialized exception.
      +
      protected PersistExceptionmakePersistException(java.lang.String message, + java.lang.Throwable cause) +
      Subclasses can override this to provide a more specialized exception.
      +
      FetchExceptiontoFetchException() +
      Converts RepositoryException into an appropriate FetchException.
      +
      FetchExceptiontoFetchException(java.lang.String message) +
      Converts RepositoryException into an appropriate FetchException, prepending + the specified message.
      +
      PersistExceptiontoPersistException() +
      Converts RepositoryException into an appropriate PersistException.
      +
      PersistExceptiontoPersistException(java.lang.String message) +
      Converts RepositoryException into an appropriate PersistException, prepending + the specified message.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RepositoryException

        +
        public RepositoryException()
        +
        • +
      + + + +
        +
      • +

        RepositoryException

        +
        public RepositoryException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        RepositoryException

        +
        public RepositoryException(java.lang.String message,
+                   java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        RepositoryException

        +
        public RepositoryException(java.lang.Throwable cause)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        backoff

        +
        public static <E extends java.lang.Throwable> int backoff(E e,
+                                          int retryCount,
+                                          int milliseconds)
+                   throws E extends java.lang.Throwable
        +
        One strategy for resolving an optimistic lock failure is to try the + operation again, after waiting some bounded random amount of time. This + method is provided as a convenience, to support such a random wait. +

        + A retry count is required as well, which is decremented and returned by + this method. If the retry count is zero (or less) when this method is + called, then this exception is thrown again, indicating retry failure.

        +
        Parameters:
        retryCount - current retry count, if zero, throw this exception again
        milliseconds - upper bound on the random amount of time to wait
        +
        Returns:
        retryCount minus one
        +
        Throws:
        +
        E - if retry count is zero
        +
        E extends java.lang.Throwable
        +
        • +
      + + + +
        +
      • +

        getRootCause

        +
        public java.lang.Throwable getRootCause()
        +
        Recursively calls getCause, until the root cause is found. Returns this + if no root cause.
        +
        • +
      + + + +
        +
      • +

        toPersistException

        +
        public final PersistException toPersistException()
        +
        Converts RepositoryException into an appropriate PersistException.
        +
        • +
      + + + +
        +
      • +

        toPersistException

        +
        public final PersistException toPersistException(java.lang.String message)
        +
        Converts RepositoryException into an appropriate PersistException, prepending + the specified message. If message is null, original exception message is + preserved.
        +
        Parameters:
        message - message to prepend, which may be null
        +
        • +
      + + + +
        +
      • +

        toFetchException

        +
        public final FetchException toFetchException()
        +
        Converts RepositoryException into an appropriate FetchException.
        +
        • +
      + + + +
        +
      • +

        toFetchException

        +
        public final FetchException toFetchException(java.lang.String message)
        +
        Converts RepositoryException into an appropriate FetchException, prepending + the specified message. If message is null, original exception message is + preserved.
        +
        Parameters:
        message - message to prepend, which may be null
        +
        • +
      + + + +
        +
      • +

        makePersistException

        +
        protected PersistException makePersistException(java.lang.String message,
+                                    java.lang.Throwable cause)
        +
        Subclasses can override this to provide a more specialized exception.
        +
        Parameters:
        message - exception message, which may be null
        cause - non-null cause
        +
        • +
      + + + +
        +
      • +

        makeFetchException

        +
        protected FetchException makeFetchException(java.lang.String message,
+                                java.lang.Throwable cause)
        +
        Subclasses can override this to provide a more specialized exception.
        +
        Parameters:
        message - exception message, which may be null
        cause - non-null cause
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/Sequence.html b/apidocs/com/amazon/carbonado/Sequence.html new file mode 100644 index 0000000..4d96094 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Sequence.html @@ -0,0 +1,224 @@ + + + + + + +Sequence (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado
+

Annotation Type Sequence

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+public @interface Sequence
    +
    Identifies a Storable property capable of selecting its own value on + insert, by a named sequence. Support for sequences is repository dependent, + and if not supported, a PersistException is thrown when trying to + insert. Explicitly specifying a value bypasses the sequence altogether. + +

    Example:

    + @PrimaryKey("userInfoID")
+ public interface UserInfo extends Storable<UserInfo> {
+     @Sequence("USER_ID_SEQ")
+     long getUserInfoID();
+     void setUserInfoID(long id);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Automatic
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.Stringvalue +
      Name of the sequence used by the storage layer.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String value
        +
        Name of the sequence used by the storage layer.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/Storable.html b/apidocs/com/amazon/carbonado/Storable.html new file mode 100644 index 0000000..d6bd6ba --- /dev/null +++ b/apidocs/com/amazon/carbonado/Storable.html @@ -0,0 +1,1116 @@ + + + + + + +Storable (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Interface Storable<S extends Storable<S>>

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      Scopy() +
      Returns an exact shallow copy of this object, including the state.
      +
      voidcopyAllProperties(S target) +
      Copies all supported properties, skipping any that are uninitialized.
      +
      voidcopyDirtyProperties(S target) +
      Copies all supported non-primary key properties which are + dirty.
      +
      voidcopyPrimaryKeyProperties(S target) +
      Copies all supported primary key properties, skipping any that are + uninitialized.
      +
      voidcopyUnequalProperties(S target) +
      Copies all supported non-primary key properties which are unequal, + skipping any that are uninitialized.
      +
      voidcopyVersionProperty(S target) +
      Copies the optional version property, unless it is uninitialized.
      +
      voiddelete() +
      Deletes this object from the storage layer by its primary key, + regardless of whether this object has actually been loaded or not.
      +
      booleanequalPrimaryKeys(java.lang.Object obj) +
      True if the supported properties which participate in the primary key + are equal.
      +
      booleanequalProperties(java.lang.Object obj) +
      True if all supported properties for this object are equal.
      +
      booleanequals(java.lang.Object obj) +
      True if all properties and fields are equal, but ignoring the state.
      +
      java.lang.ObjectgetPropertyValue(java.lang.String propertyName) +
      Returns a Storable property value by name.
      +
      booleanhasDirtyProperties() +
      Returns true if any non-primary key properties in this object are + dirty.
      +
      inthashCode() 
      voidinsert() +
      Inserts a new persistent value for this object.
      +
      booleanisPropertyClean(java.lang.String propertyName) +
      Returns true if the given property of this Storable is clean.
      +
      booleanisPropertyDirty(java.lang.String propertyName) +
      Returns true if the given property of this Storable has been set, but no + load or store operation has been performed yet.
      +
      booleanisPropertySupported(java.lang.String propertyName) +
      Returns true if the given property exists and is supported.
      +
      booleanisPropertyUninitialized(java.lang.String propertyName) +
      Returns true if the given property of this Storable has never been + loaded or set.
      +
      voidload() +
      Loads or reloads this object from the storage layer by a primary or + alternate key.
      +
      voidmarkAllPropertiesClean() +
      Marks all properties as clean, including uninitialized properties.
      +
      voidmarkAllPropertiesDirty() +
      Marks all properties as dirty, including uninitialized properties.
      +
      voidmarkPropertiesClean() +
      Marks all dirty properties as clean.
      +
      voidmarkPropertiesDirty() +
      Marks all clean properties as dirty.
      +
      Sprepare() +
      Prepares a new object for loading, inserting, updating, or deleting.
      +
      java.util.Map<java.lang.String,java.lang.Object>propertyMap() +
      Returns a fixed-size map view of this Storable's properties.
      +
      voidreadFrom(java.io.InputStream in) +
      Restores property values and states as encoded by writeTo(java.io.OutputStream).
      +
      voidsetPropertyValue(java.lang.String propertyName, + java.lang.Object value) +
      Sets a Storable property value by name.
      +
      java.lang.Class<S>storableType() +
      Returns the class or interface from which this storable was + generated.
      +
      java.lang.StringtoString() +
      Returns a string for debugging purposes that contains all supported + property names and values for this object.
      +
      java.lang.StringtoStringKeyOnly() +
      Returns a string for debugging purposes that contains supported key + property names and values for this object.
      +
      booleantryDelete() +
      Deletes this object from the storage layer by its primary key, + regardless of whether this object has actually been loaded or not.
      +
      booleantryInsert() +
      Inserts a new persistent value for this object.
      +
      booleantryLoad() +
      Loads or reloads this object from the storage layer by a primary or + alternate key.
      +
      booleantryUpdate() +
      Updates the persistent value of this object, regardless of whether this + object has actually been loaded or not.
      +
      voidupdate() +
      Updates the persistent value of this object, regardless of whether this + object has actually been loaded or not.
      +
      voidwriteTo(java.io.OutputStream out) +
      Serializes property values and states for temporary storage or for + network transfer.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        load

        +
        void load()
+          throws FetchNoneException,
+                 FetchException
        +
        Loads or reloads this object from the storage layer by a primary or + alternate key. All properties of a key must be initialized for it to be + chosen. The primary key is examined first, and if not fully initialized, + alternate keys are examined in turn. + +

        If load is successful, altering the primary key is no longer allowed + unless a call to delete succeeds. Attempting to alter the primary key in + this state results in an IllegalStateException. Alternate keys + may always be modified, however. + +

        Note: This method differs from tryLoad() only in that it + throws an exception if no matching record was found, instead of returning + false. This may indicate that the underlying record was deleted between + a load and reload. When a FetchNoneException is thrown, this object's + state will be the same as if the delete method was called on it.

        +
        Throws:
        +
        FetchNoneException - if no matching record found
        +
        FetchException - if storage layer throws an exception
        +
        java.lang.IllegalStateException - if the state of this instance suggests + that any primary keys are unspecified
        +
        • +
      + + + +
        +
      • +

        tryLoad

        +
        boolean tryLoad()
+                throws FetchException
        +
        Loads or reloads this object from the storage layer by a primary or + alternate key. All properties of a key must be initialized for it to be + chosen. The primary key is examined first, and if not fully initialized, + alternate keys are examined in turn. + +

        If load is successful, altering the primary key is no longer allowed + unless a call to delete succeeds. Attempting to alter the primary key in + this state results in an IllegalStateException. Alternate keys + may always be modified, however. + +

        Note: This method differs from load() only in that it returns + false if no matching record was found, instead of throwing an exception. + This may indicate that the underlying record was deleted between a load + and reload. When false is returned, this object's state will be the same + as if the delete method was called on it.

        +
        Returns:
        true if found and loaded, false otherwise
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        java.lang.IllegalStateException - if the state of this instance suggests + that any primary keys are unspecified
        +
        • +
      + + + +
        +
      • +

        insert

        +
        void insert()
+            throws PersistException
        +
        Inserts a new persistent value for this object. If successful, altering + the primary key is no longer allowed unless a call to delete succeeds. + Attempting to alter the primary key in this state results in an IllegalStateException. Alternate keys may always be modified, however. + +

        Insert requires that all primary key properties be specified. If not, + an IllegalStateException is thrown. Also, repository + implementations usually require that properties which are not Nullable also be specified. Otherwise, a ConstraintException + may be thrown. + +

        Note: This method differs from tryInsert() only in that it may + throw a UniqueConstraintException, instead of returning false.

        +
        Throws:
        +
        UniqueConstraintException - if it is absolutely known that a key + of inserted object matches an existing one
        +
        ConstraintException - if any required properties are unspecified
        +
        PersistException - if storage layer throws an exception
        +
        java.lang.IllegalStateException - if the state of this instance suggests + that any primary keys are unspecified
        +
        • +
      + + + +
        +
      • +

        tryInsert

        +
        boolean tryInsert()
+                  throws PersistException
        +
        Inserts a new persistent value for this object. If successful, altering + the primary key is no longer allowed unless a call to delete succeeds. + Attempting to alter the primary key in this state results in an IllegalStateException. Alternate keys may always be modified, however. + +

        Insert requires that all primary key properties be specified. If not, + an IllegalStateException is thrown. Also, repository + implementations usually require that properties which are not Nullable also be specified. Otherwise, a ConstraintException + may be thrown. + +

        Note: This method differs from insert() only in that it + returns false, instead of throwing a UniqueConstraintException.

        +
        Returns:
        false if it is absolutely known that a key of inserted object + matches an existing one
        +
        Throws:
        +
        ConstraintException - if any required properties are unspecified
        +
        PersistException - if storage layer throws an exception
        +
        java.lang.IllegalStateException - if the state of this instance suggests + that any primary keys are unspecified
        +
        • +
      + + + +
        +
      • +

        update

        +
        void update()
+            throws PersistException
        +
        Updates the persistent value of this object, regardless of whether this + object has actually been loaded or not. If successful, altering the + primary key is no longer allowed unless a call to delete succeeds. + Attempting to alter the primary key in this state results in an IllegalStateException. Alternate keys may always be modified, however. + +

        If this object has a version property defined, then + the update logic is a bit more strict. Updates of any storable require + that the primary keys be specified; if a version is present, the version + must be specified as well. If any of the primary key or version + properties are unspecified, an IllegalStateException will be + thrown; if they are fully specified and the version doesn't match the + current record, an OptimisticLockException is thrown. + +

        Not all properties need to be set on this object when calling + update. Setting a subset results in a partial update. After a successful + update, all properties are set to the actual values in the storage + layer. Put another way, the object is automatically reloaded after a + successful update. + +

        If PersistNoneException is thrown, this indicates that the underlying + record was deleted. When this happens, this object's state will be the + same as if the delete method was called on it.

        +
        Throws:
        +
        PersistNoneException - if record is missing and no update occurred
        +
        PersistException - if storage layer throws an exception
        +
        OptimisticLockException - if a version property exists and the + optimistic lock failed
        +
        java.lang.IllegalStateException - if the state of this instance suggests + that any primary keys are unspecified, or if a version property is unspecified
        +
        • +
      + + + +
        +
      • +

        tryUpdate

        +
        boolean tryUpdate()
+                  throws PersistException
        +
        Updates the persistent value of this object, regardless of whether this + object has actually been loaded or not. If successful, altering the + primary key is no longer allowed unless a call to delete succeeds. + Attempting to alter the primary key in this state results in an IllegalStateException. Alternate keys may always be modified, however. + +

        If this object has a version property defined, then + the update logic is a bit more strict. Updates of any storable require + that the primary keys be specified; if a version is present, the version + must be specified as well. If any of the primary key or version + properties are unspecified, an IllegalStateException will be + thrown; if they are fully specified and the version doesn't match the + current record, an OptimisticLockException is thrown. + +

        Not all properties need to be set on this object when calling + update. Setting a subset results in a partial update. After a successful + update, all properties are set to the actual values in the storage + layer. Put another way, the object is automatically reloaded after a + successful update. + +

        A return value of false indicates that the underlying record was + deleted. When this happens, this object's state will be the same as if + the delete method was called on it.

        +
        Returns:
        true if record likely exists and was updated, or false if record + absolutely no longer exists and no update occurred
        +
        Throws:
        +
        PersistException - if storage layer throws an exception
        +
        OptimisticLockException - if a version property exists and the + optimistic lock failed
        +
        java.lang.IllegalStateException - if the state of this instance suggests + that any primary keys are unspecified, or if a version property is unspecified
        +
        • +
      + + + +
        +
      • +

        delete

        +
        void delete()
+            throws PersistException
        +
        Deletes this object from the storage layer by its primary key, + regardless of whether this object has actually been loaded or not. + Calling delete does not prevent this object from being used again. All + property values are still valid, including the primary key. Once + deleted, the insert operation is permitted again. + +

        Note: This method differs from tryDelete() only in that it may + throw a PersistNoneException, instead of returning false.

        +
        Throws:
        +
        PersistNoneException - if record is missing and nothing was + deleted
        +
        PersistException - if storage layer throws an exception
        +
        java.lang.IllegalStateException - if the state of this instance suggests + that any primary keys are unspecified
        +
        • +
      + + + +
        +
      • +

        tryDelete

        +
        boolean tryDelete()
+                  throws PersistException
        +
        Deletes this object from the storage layer by its primary key, + regardless of whether this object has actually been loaded or not. + Calling delete does not prevent this object from being used again. All + property values are still valid, including the primary key. Once + deleted, the insert operation is permitted again. + +

        Note: This method differs from delete() only in that it + returns false, instead of throwing a PersistNoneException.

        +
        Returns:
        true if record likely existed and was deleted, or false if record + absolutely no longer exists and no delete was necessary
        +
        Throws:
        +
        PersistException - if storage layer throws an exception
        +
        java.lang.IllegalStateException - if the state of this instance suggests + that any primary keys are unspecified
        +
        • +
      + + + +
        +
      • +

        storableType

        +
        java.lang.Class<S> storableType()
        +
        Returns the class or interface from which this storable was + generated. This represents the data class for the storable. + +

        Design note: the name "getStorableType" is avoided, so as not to + conflict with a user defined property of "storableType"

        +
        • +
      + + + + + +
        +
      • +

        copyAllProperties

        +
        void copyAllProperties(S target)
        +
        Copies all supported properties, skipping any that are uninitialized. + Specifically, calls "target.set<property>" for all supported + properties in this storable, passing the value of the property from this + object. Unsupported independent properties in this + or the target are not copied.
        +
        Parameters:
        target - storable on which to call set<property> methods
        +
        Throws:
        +
        java.lang.IllegalStateException - if any primary key properties of target + cannot be altered
        +
        • +
      + + + + + +
        +
      • +

        copyPrimaryKeyProperties

        +
        void copyPrimaryKeyProperties(S target)
        +
        Copies all supported primary key properties, skipping any that are + uninitialized. Specifically, calls "target.set<property>" for all + supported properties which participate in the primary key, passing the + value of the property from this object. Unsupported independent properties in this or the target are not copied.
        +
        Parameters:
        target - storable on which to call set<property> methods
        +
        Throws:
        +
        java.lang.IllegalStateException - if any primary key properties of target + cannot be altered
        +
        • +
      + + + + + +
        +
      • +

        copyVersionProperty

        +
        void copyVersionProperty(S target)
        +
        Copies the optional version property, unless it is uninitialized. + Specifically, calls "target.set<property>" for the version + property (if supported), passing the value of the property from this + object. If no version property is defined, then this method does + nothing. Unsupported independent properties in this + or the target are not copied.
        +
        Parameters:
        target - storable on which to call set<property> method
        +
        • +
      + + + + + +
        +
      • +

        copyUnequalProperties

        +
        void copyUnequalProperties(S target)
        +
        Copies all supported non-primary key properties which are unequal, + skipping any that are uninitialized. Specifically, calls + "target.get<property>", and if the value thus retrieved differs + from the local value, "target.set<property>" is called for that + property. Unsupported independent properties in this + or the target are not copied.
        +
        Parameters:
        target - storable on which to call set<property> methods
        +
        • +
      + + + + + +
        +
      • +

        copyDirtyProperties

        +
        void copyDirtyProperties(S target)
        +
        Copies all supported non-primary key properties which are + dirty. Specifically, calls "target.set<property>" for any + non-primary key property which is dirty, passing the value of the + property from this object. A property is considered dirty when set + before a load or persist operation is called. Unsupported independent properties in this or the target are not + copied.
        +
        Parameters:
        target - storable on which to call set<property> methods
        +
        • +
      + + + +
        +
      • +

        hasDirtyProperties

        +
        boolean hasDirtyProperties()
        +
        Returns true if any non-primary key properties in this object are + dirty. A property is considered dirty when set before a load or persist + operation is called. A property becomes clean after a successful load, + insert, or update operation.
        +
        • +
      + + + +
        +
      • +

        markPropertiesClean

        +
        void markPropertiesClean()
        +
        Marks all dirty properties as clean. Uninitialized properties remain so. + As a side-effect, initialized primary keys may no longer be altered.
        +
        • +
      + + + +
        +
      • +

        markAllPropertiesClean

        +
        void markAllPropertiesClean()
        +
        Marks all properties as clean, including uninitialized properties. + As a side-effect, primary keys may no longer be altered.
        +
        • +
      + + + +
        +
      • +

        markPropertiesDirty

        +
        void markPropertiesDirty()
        +
        Marks all clean properties as dirty. Uninitialized properties remain so. + As a side-effect, primary keys can be altered.
        +
        • +
      + + + +
        +
      • +

        markAllPropertiesDirty

        +
        void markAllPropertiesDirty()
        +
        Marks all properties as dirty, including uninitialized properties. + As a side-effect, primary keys can be altered.
        +
        • +
      + + + +
        +
      • +

        isPropertyUninitialized

        +
        boolean isPropertyUninitialized(java.lang.String propertyName)
        +
        Returns true if the given property of this Storable has never been + loaded or set.
        +
        Parameters:
        propertyName - name of property to interrogate
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if property is unknown, is a join or is derived
        +
        • +
      + + + +
        +
      • +

        isPropertyDirty

        +
        boolean isPropertyDirty(java.lang.String propertyName)
        +
        Returns true if the given property of this Storable has been set, but no + load or store operation has been performed yet.
        +
        Parameters:
        propertyName - name of property to interrogate
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if property is unknown, is a join or is derived
        +
        • +
      + + + +
        +
      • +

        isPropertyClean

        +
        boolean isPropertyClean(java.lang.String propertyName)
        +
        Returns true if the given property of this Storable is clean. All + properties are clean after a successful load or store operation.
        +
        Parameters:
        propertyName - name of property to interrogate
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if property is unknown, is a join or is derived
        +
        • +
      + + + +
        +
      • +

        isPropertySupported

        +
        boolean isPropertySupported(java.lang.String propertyName)
        +
        Returns true if the given property exists and is supported. If a + Storable has an Independent property which is not supported by + the repository, then this method returns false.
        +
        Parameters:
        propertyName - name of property to check
        +
        • +
      + + + +
        +
      • +

        getPropertyValue

        +
        java.lang.Object getPropertyValue(java.lang.String propertyName)
        +
        Returns a Storable property value by name.
        +
        Parameters:
        propertyName - name of property to get value of
        +
        Returns:
        property value, which is boxed if property type is primitive
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if property is unknown or if accessor + method declares throwing any checked exceptions
        +
        java.lang.UnsupportedOperationException - if property is independent but unsupported
        +
        java.lang.NullPointerException - if property name is null
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        setPropertyValue

        +
        void setPropertyValue(java.lang.String propertyName,
+                    java.lang.Object value)
        +
        Sets a Storable property value by name. Call insert or update to persist + the change.
        +
        Parameters:
        propertyName - name of property to set value to
        value - new value for property
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if property is unknown, or if value is + unsupported due to a constraint, or if mutator method declares throwing + any checked exceptions
        +
        java.lang.UnsupportedOperationException - if property is independent but unsupported
        +
        java.lang.ClassCastException - if value is of wrong type
        +
        java.lang.NullPointerException - if property name is null or if primitive + value is required but value is null
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        propertyMap

        +
        java.util.Map<java.lang.String,java.lang.Object> propertyMap()
        +
        Returns a fixed-size map view of this Storable's properties. Properties + which declare throwing any checked exceptions are excluded from the + map. Removing and adding of map entries is unsupported.
        +
        Returns:
        map of property name to property value; primitive property + values are boxed
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        copy

        +
        S copy()
        +
        Returns an exact shallow copy of this object, including the state.
        +
        • +
      + + + +
        +
      • +

        prepare

        +
        S prepare()
        +
        Prepares a new object for loading, inserting, updating, or deleting.
        +
        Since:
        +
        1.2
        +
        See Also:
        Storage.prepare()
        +
        • +
      + + + +
        +
      • +

        writeTo

        +
        void writeTo(java.io.OutputStream out)
+             throws java.io.IOException,
+                    SupportException
        +
        Serializes property values and states for temporary storage or for + network transfer. Call readFrom(java.io.InputStream) to restore. Derived and join + properties are not serialized. + +

        The encoding used by this method is much simpler than what is + provided by standard object serialization. It does not encode class info + or property names, which is why it is not suitable for long term + storage.

        +
        Throws:
        +
        java.io.IOException - if exception from stream
        +
        SupportException - if Storable cannot be serialized
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        readFrom

        +
        void readFrom(java.io.InputStream in)
+              throws java.io.IOException,
+                     SupportException
        +
        Restores property values and states as encoded by writeTo(java.io.OutputStream). + Derived properties are not directly modified, but all other properties + not restored are reset to their initial state.
        +
        Throws:
        +
        java.io.IOException - if exception from stream
        +
        SupportException - if Storable cannot be serialized
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        boolean equals(java.lang.Object obj)
        +
        True if all properties and fields are equal, but ignoring the state.
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        Parameters:
        obj - object to compare to for equality
        +
        • +
      + + + +
        +
      • +

        equalPrimaryKeys

        +
        boolean equalPrimaryKeys(java.lang.Object obj)
        +
        True if the supported properties which participate in the primary key + are equal. This is useful to cheaply investigate if two storables refer + to the same entity, regardless of the state of object (specifically the + non-key properties). Unsupported independent + properties in this or the target are not compared.
        +
        Parameters:
        obj - object to compare to for equality
        +
        • +
      + + + +
        +
      • +

        equalProperties

        +
        boolean equalProperties(java.lang.Object obj)
        +
        True if all supported properties for this object are equal. Unsupported + independent properties in this or the target are not + compared.
        +
        Parameters:
        obj - object to compare to for equality
        +
        • +
      + + + +
        +
      • +

        toString

        +
        java.lang.String toString()
        +
        Returns a string for debugging purposes that contains all supported + property names and values for this object. Uninitialized and unsupported + independent properties are not included.
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toStringKeyOnly

        +
        java.lang.String toStringKeyOnly()
        +
        Returns a string for debugging purposes that contains supported key + property names and values for this object. Uninitialized and unsupported + independent properties are not included.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/Storage.html b/apidocs/com/amazon/carbonado/Storage.html new file mode 100644 index 0000000..96edf4c --- /dev/null +++ b/apidocs/com/amazon/carbonado/Storage.html @@ -0,0 +1,415 @@ + + + + + + +Storage (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Interface Storage<S extends Storable>

+
+
+
+
    +
  • +
    +
    +
    public interface Storage<S extends Storable>
    +
    Access for a specific type of Storable from a Repository. + +

    Storage instances are mutable, but they are thread-safe.

    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanaddTrigger(Trigger<? super S> trigger) +
      Register a trigger which will be called for overridden methods in the given + trigger implementation.
      +
      java.lang.Class<S>getStorableType() +
      Returns the specific type of Storable managed by this object.
      +
      Sprepare() +
      Prepares a new object for loading, inserting, updating, or deleting.
      +
      Query<S>query() +
      Query for all Storable instances in this Storage.
      +
      Query<S>query(Filter<S> filter) +
      Query for Storable instances against an explicitly constructed filter + object.
      +
      Query<S>query(java.lang.String filter) +
      Query for Storable instances against a filter expression.
      +
      booleanremoveTrigger(Trigger<? super S> trigger) +
      Remove a trigger which was registered earlier.
      +
      voidtruncate() +
      Attempts to quickly delete all Storables instances in this + Storage.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStorableType

        +
        java.lang.Class<S> getStorableType()
        +
        Returns the specific type of Storable managed by this object.
        +
        • +
      + + + +
        +
      • +

        prepare

        +
        S prepare()
        +
        Prepares a new object for loading, inserting, updating, or deleting.
        +
        Returns:
        a new data access object
        +
        • +
      + + + + + + + +
        +
      • +

        query

        +
        Query<S> query(java.lang.String filter)
+                                throws FetchException
        +
        Query for Storable instances against a filter expression. A filter tests + if property values match against specific values specified by '?' + placeholders. The simplest filter compares just one property, like + "ID = ?". Filters can also contain several kinds of relational + operators, boolean logic operators, sub-properties, and parentheses. A + more complex example might be "income < ? | (name = ? & address.zipCode != ?)". +

        + When querying for a single Storable instance by its primary key, it is + generally more efficient to call prepare(), set primary key + properties, and then call Storable.load(). For example, consider + an object with a primary key consisting only of the property "ID". It + can be queried as: + 

        + Storage<UserInfo> users;
+ UserInfo user = users.query("ID = ?").with(123456).loadOne();
+
        + The above code will likely open a Cursor in order to verify that just + one object was loaded. Instead, do this: + 
        + Storage<UserInfo> users;
+ UserInfo user = users.prepare();
+ user.setID(123456);
+ user.load();
+
        + The complete syntax for query filters follows. Note that: +
          +
        • literals are not allowed +
        • logical 'and' operator has precedence over 'or' +
        • logical 'not' operator has precedence over 'and' +
        • '?' placeholders can only appear after relational operators +
        + 
        + Filter          = OrFilter
+ OrFilter        = AndFilter { "|" AndFilter }
+ AndFilter       = NotFilter { "&" NotFilter }
+ NotFilter       = [ "!" ] EntityFilter
+ EntityFilter    = PropertyFilter
+                 | ChainedFilter
+                 | "(" Filter ")"
+ PropertyFilter  = ChainedProperty RelOp "?"
+ RelOp           = "=" | "!=" | "<" | ">=" | ">" | "<="
+ ChainedFilter   = ChainedProperty "(" [ Filter ] ")"
+ ChainedProperty = Identifier
+                 | InnerJoin "." ChainedProperty
+                 | OuterJoin "." ChainedProperty
+ InnerJoin       = Identifier
+ OuterJoin       = "(" Identifier ")"
+
        +
        Parameters:
        filter - query filter expression
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        java.lang.IllegalArgumentException - if filter is null
        +
        MalformedFilterException - if expression is malformed
        +
        java.lang.UnsupportedOperationException - if given filter is unsupported by repository
        +
        • +
      + + + +
        +
      • +

        query

        +
        Query<S> query(Filter<S> filter)
+                                throws FetchException
        +
        Query for Storable instances against an explicitly constructed filter + object.
        +
        Parameters:
        filter - query filter
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        java.lang.IllegalArgumentException - if filter is null
        +
        java.lang.UnsupportedOperationException - if given filter is unsupported by repository
        +
        • +
      + + + +
        +
      • +

        truncate

        +
        void truncate()
+              throws PersistException
        +
        Attempts to quickly delete all Storables instances in this + Storage. Support for transactional truncation is not guaranteed. + +

        If this Storage has any registered triggers which act on deletes, all + Storables are deleted via query().deleteAll() instead to ensure + these triggers get run.

        +
        Throws:
        +
        PersistException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        addTrigger

        +
        boolean addTrigger(Trigger<? super S> trigger)
        +
        Register a trigger which will be called for overridden methods in the given + trigger implementation. The newly added trigger is invoked before and + after all other triggers. In other words, it is added at the outermost + nesting level.
        +
        Returns:
        true if trigger was added, false if trigger was not added + because an equal trigger is already registered
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if trigger is null
        +
        • +
      + + + +
        +
      • +

        removeTrigger

        +
        boolean removeTrigger(Trigger<? super S> trigger)
        +
        Remove a trigger which was registered earlier.
        +
        Returns:
        true if trigger instance was removed, false if not registered
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if trigger is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/SupportException.html b/apidocs/com/amazon/carbonado/SupportException.html new file mode 100644 index 0000000..8743315 --- /dev/null +++ b/apidocs/com/amazon/carbonado/SupportException.html @@ -0,0 +1,311 @@ + + + + + + +SupportException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Class SupportException

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SupportException

        +
        public SupportException()
        +
        • +
      + + + +
        +
      • +

        SupportException

        +
        public SupportException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        SupportException

        +
        public SupportException(java.lang.String message,
+                java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        SupportException

        +
        public SupportException(java.lang.Throwable cause)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/Transaction.html b/apidocs/com/amazon/carbonado/Transaction.html new file mode 100644 index 0000000..90fa943 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Transaction.html @@ -0,0 +1,446 @@ + + + + + + +Transaction (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Interface Transaction

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    TransactionPair
    +
    +
    +
    +
    public interface Transaction
    +
    Transactions define atomic operations which can be committed or aborted as a + unit. Transactions are entered by calling Repository.enterTransaction(). + Transactions are thread-local, and so no special action needs to be taken to + bind operations to them. Cursors which are opened in the scope of a + transaction are automatically closed when the transaction is committed or + aborted. + +

    Transactions do not exit when they are committed. The transaction is + still valid after a commit, but new operations are grouped into a separate + atomic unit. The exit method must be invoked on every + transaction. The following pattern is recommended: + + 

    + Transaction txn = repository.enterTransaction();
+ try {
+     // Make updates to storage layer
+     ...
+
+     // Commit the changes up to this point
+     txn.commit();
+
+     // Optionally make more updates
+     ...
+
+     // Commit remaining changes
+     txn.commit();
+ } finally {
+     // Ensure transaction exits, aborting uncommitted changes if an exception was thrown
+     txn.exit();
+ }
+
    + +

    Transactions may be nested. Calling commit or abort on an outer + transaction will recursively apply the same operation to all inner + transactions as well. All Cursors contained within are also closed. + +

    Transaction instances are mutable, but they are thread-safe.

    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidattach() +
      Attaches this transaction to the current thread, if it has been + detached.
      +
      voidcommit() +
      If currently in a transaction, commits all changes to the storage layer + since the last commit within the transaction.
      +
      voiddetach() +
      Detaches this transaction from the current thread.
      +
      voidexit() +
      Closes the current transaction, aborting all changes since the last + commit.
      +
      IsolationLevelgetIsolationLevel() +
      Returns the isolation level of this transaction.
      +
      booleanisForUpdate() +
      Returns true if this transaction is in update mode, which is adjusted by + calling setForUpdate(boolean).
      +
      booleanpreCommit() +
      Calling this method commits all nested child transactions, closes all + scoped cursors, and locks out some interactions from other threads.
      +
      voidsetDesiredLockTimeout(int timeout, + java.util.concurrent.TimeUnit unit) +
      Specify a desired timeout for aquiring locks within this + transaction.
      +
      voidsetForUpdate(boolean forUpdate) +
      Set to true to force all read operations within this transaction to + acquire upgradable or write locks.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        commit

        +
        void commit()
+            throws PersistException
        +
        If currently in a transaction, commits all changes to the storage layer + since the last commit within the transaction.
        +
        Throws:
        +
        PersistException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        exit

        +
        void exit()
+          throws PersistException
        +
        Closes the current transaction, aborting all changes since the last + commit.
        +
        Throws:
        +
        PersistException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        setForUpdate

        +
        void setForUpdate(boolean forUpdate)
        +
        Set to true to force all read operations within this transaction to + acquire upgradable or write locks. This option eliminates deadlocks that + may occur when updating records, except it may increase contention.
        +
        • +
      + + + +
        +
      • +

        isForUpdate

        +
        boolean isForUpdate()
        +
        Returns true if this transaction is in update mode, which is adjusted by + calling setForUpdate(boolean).
        +
        • +
      + + + +
        +
      • +

        setDesiredLockTimeout

        +
        void setDesiredLockTimeout(int timeout,
+                         java.util.concurrent.TimeUnit unit)
        +
        Specify a desired timeout for aquiring locks within this + transaction. Calling this method may have have no effect at all, if the + repository does not support this feature. In addition, the lock timeout + might not be alterable if the transaction contains uncommitted data. + +

        Also, the range of lock timeout values supported might be small. For + example, only a timeout value of zero might be supported. In that case, + the transaction is configured to not wait at all when trying to acquire + locks. Expect immediate timeout exceptions when locks cannot be + granted. + +

        Nested transactions inherit the desired lock timeout of their + parent. Top transactions always begin with the default lock timeout.

        +
        Parameters:
        timeout - Desired lock timeout. If negative, revert lock timeout to + default value.
        unit - Time unit for timeout. If null, revert lock timeout to + default value.
        +
        • +
      + + + +
        +
      • +

        getIsolationLevel

        +
        IsolationLevel getIsolationLevel()
        +
        Returns the isolation level of this transaction.
        +
        • +
      + + + +
        +
      • +

        detach

        +
        void detach()
        +
        Detaches this transaction from the current thread. It can be attached + later, and to any thread which currently has no thread-local + transaction. + +

        Detaching a transaction also detaches any parent and nested child + transactions. Attaching any of them achieves the same result as + attaching this transaction.

        +
        Throws:
        +
        java.lang.IllegalStateException - if transaction is attached to a different + thread
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        attach

        +
        void attach()
        +
        Attaches this transaction to the current thread, if it has been + detached. Attaching a transaction also attaches any parent and nested + child transactions.
        +
        Throws:
        +
        java.lang.IllegalStateException - if current thread has a different + transaction already attached
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        preCommit

        +
        boolean preCommit()
+                  throws PersistException
        +
        Calling this method commits all nested child transactions, closes all + scoped cursors, and locks out some interactions from other threads. The + commit method must still be called to finish the commit. Most applications + have no use for pre-commit and should only ever call commit. + +

        The intent of this method is to complete as many operations as + possible leading up to the actual commit. If pre-commit succeeds, then + commit will most likely succeed as well. While in a pre-commit state, the + transaction can still be used by the current thread. Calling pre-commit + again ensures that child transactions and cursors are closed.

        +
        Returns:
        false if transaction has exited
        +
        Throws:
        +
        PersistException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/Trigger.Abort.html b/apidocs/com/amazon/carbonado/Trigger.Abort.html new file mode 100644 index 0000000..b566bf3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Trigger.Abort.html @@ -0,0 +1,291 @@ + + + + + + +Trigger.Abort (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Class Trigger.Abort

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        fillInStackTrace

        +
        public java.lang.Throwable fillInStackTrace()
        +
        Override to remove the stack trace.
        +
        +
        Overrides:
        +
        fillInStackTrace in class java.lang.Throwable
        +
        +
        • +
      + + + +
        +
      • +

        withStackTrace

        +
        public Trigger.Abort withStackTrace()
        +
        Returns this exception but with a fresh stack trace. The trace does + not include the original thrower of this exception.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/Trigger.html b/apidocs/com/amazon/carbonado/Trigger.html new file mode 100644 index 0000000..b2946f2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Trigger.html @@ -0,0 +1,971 @@ + + + + + + +Trigger (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado
+

Class Trigger<S>

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    ResyncCapability.Listener, TriggerManager
    +
    +
    +
    +
    public abstract class Trigger<S>
+extends java.lang.Object
    +
    Callback mechanism to allow custom code to run when a storable is + persisted. By default, the methods defined in this class do + nothing. Subclass and override trigger conditions of interest, and then + register it. Each overridden trigger method is + called in the same transaction scope as the persist operation. Trigger + implementations are encouraged to override the equals method, to prevent + accidental double registration. + +

    To ensure proper nesting, all "before" events are run in the + opposite order that the trigger was registered. All "after" and + "failed" events are run in the same order that the trigger was registered. + In other words, the last added trigger is at the outermost nesting level. + +

    Triggers always run within the same transaction as the triggering + operation. The exact isolation level and update mode is outside the + trigger's control. If an explicit isolation level or update mode is + required, create a nested transaction within a trigger method. A trigger's + nested transaction can also be defined to span the entire triggering operation. + To do this, enter the transaction in the "before" method, but return the + transaction object without exiting it. The "after" method is responsible for + exiting the transaction. It extracts (or simply casts) the transaction from + the state object passed into it. When creating spanning transactions like + this, it is critical that the "failed" method be defined to properly exit + the transaction upon failure.

    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class Trigger.Abort 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Trigger() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected Trigger.AbortabortTry() +
      Call to quickly abort a "try" operation, returning false to the + caller.
      +
      voidafterDelete(S storable, + java.lang.Object state) +
      Called right after a storable has been successfully deleted.
      +
      voidafterInsert(S storable, + java.lang.Object state) +
      Called right after a storable has been successfully inserted.
      +
      voidafterLoad(S storable) +
      Called right after a storable has been successfully loaded or + fetched.
      +
      voidafterTryDelete(S storable, + java.lang.Object state) +
      Called right after a storable has been successfully deleted via + tryDelete.
      +
      voidafterTryInsert(S storable, + java.lang.Object state) +
      Called right after a storable has been successfully inserted via + tryInsert.
      +
      voidafterTryUpdate(S storable, + java.lang.Object state) +
      Called right after a storable has been successfully updated via + tryUpdate.
      +
      voidafterUpdate(S storable, + java.lang.Object state) +
      Called right after a storable has been successfully updated.
      +
      java.lang.ObjectbeforeDelete(S storable) +
      Called before a storable is to be deleted.
      +
      java.lang.ObjectbeforeDelete(Transaction txn, + S storable) +
      Called before a storable is to be deleted.
      +
      java.lang.ObjectbeforeInsert(S storable) +
      Called before a storable is to be inserted.
      +
      java.lang.ObjectbeforeInsert(Transaction txn, + S storable) +
      Called before a storable is to be inserted.
      +
      java.lang.ObjectbeforeTryDelete(S storable) +
      Called before a storable is to be deleted via tryDelete.
      +
      java.lang.ObjectbeforeTryDelete(Transaction txn, + S storable) +
      Called before a storable is to be deleted via tryDelete.
      +
      java.lang.ObjectbeforeTryInsert(S storable) +
      Called before a storable is to be inserted via tryInsert.
      +
      java.lang.ObjectbeforeTryInsert(Transaction txn, + S storable) +
      Called before a storable is to be inserted via tryInsert.
      +
      java.lang.ObjectbeforeTryUpdate(S storable) +
      Called before a storable is to be updated via tryUpdate.
      +
      java.lang.ObjectbeforeTryUpdate(Transaction txn, + S storable) +
      Called before a storable is to be updated via tryUpdate.
      +
      java.lang.ObjectbeforeUpdate(S storable) +
      Called before a storable is to be updated.
      +
      java.lang.ObjectbeforeUpdate(Transaction txn, + S storable) +
      Called before a storable is to be updated.
      +
      voidfailedDelete(S storable, + java.lang.Object state) +
      Called when an delete operation failed because the record was missing or + an exception was thrown.
      +
      voidfailedInsert(S storable, + java.lang.Object state) +
      Called when an insert operation failed due to a unique constraint + violation or an exception was thrown.
      +
      voidfailedUpdate(S storable, + java.lang.Object state) +
      Called when an update operation failed because the record was missing or + an exception was thrown.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Trigger

        +
        public Trigger()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        beforeInsert

        +
        public java.lang.Object beforeInsert(S storable)
+                              throws PersistException
        +
        Called before a storable is to be inserted. The default implementation + does nothing. + +

        Any exception thrown by this method will cause the insert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the insert method.

        +
        Parameters:
        storable - storable before being inserted
        +
        Returns:
        arbitrary state object, passed to afterInsert or failedInsert method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        beforeInsert

        +
        public java.lang.Object beforeInsert(Transaction txn,
+                            S storable)
+                              throws PersistException
        +
        Called before a storable is to be inserted. The default implementation + simply calls beforeInsert(Object). Only override if access to + the transaction is required. + +

        Any exception thrown by this method will cause the insert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the insert method.

        +
        Parameters:
        txn - nested transaction which trigger runs in
        storable - storable before being inserted
        +
        Returns:
        arbitrary state object, passed to afterInsert or failedInsert method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        beforeTryInsert

        +
        public java.lang.Object beforeTryInsert(S storable)
+                                 throws PersistException
        +
        Called before a storable is to be inserted via tryInsert. The default + implementation simply calls beforeInsert(Object). Only override + if trigger needs to distinguish between different insert variants. + +

        Any exception thrown by this method will cause the tryInsert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryInsert method.

        +
        Parameters:
        storable - storable before being inserted
        +
        Returns:
        arbitrary state object, passed to afterTryInsert or failedInsert method
        +
        Throws:
        +
        PersistException
        See Also:
        abortTry()
        +
        • +
      + + + + + +
        +
      • +

        beforeTryInsert

        +
        public java.lang.Object beforeTryInsert(Transaction txn,
+                               S storable)
+                                 throws PersistException
        +
        Called before a storable is to be inserted via tryInsert. The default + implementation simply calls beforeTryInsert(Object). Only + override if trigger needs access to the transaction and to distinguish + between different insert variants. + +

        Any exception thrown by this method will cause the tryInsert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryInsert method.

        +
        Parameters:
        txn - nested transaction which trigger runs in
        storable - storable before being inserted
        +
        Returns:
        arbitrary state object, passed to afterTryInsert or failedInsert method
        +
        Throws:
        +
        PersistException
        See Also:
        abortTry()
        +
        • +
      + + + + + +
        +
      • +

        afterInsert

        +
        public void afterInsert(S storable,
+               java.lang.Object state)
+                 throws PersistException
        +
        Called right after a storable has been successfully inserted. The + default implementation does nothing. + +

        Any exception thrown by this method will cause the insert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the insert method.

        +
        Parameters:
        storable - storable after being inserted
        state - object returned by beforeInsert method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        afterTryInsert

        +
        public void afterTryInsert(S storable,
+                  java.lang.Object state)
+                    throws PersistException
        +
        Called right after a storable has been successfully inserted via + tryInsert. The default implementation simply calls afterInsert(S, java.lang.Object). + Only override if trigger needs to distinguish between different insert + variants. + +

        Any exception thrown by this method will cause the tryInsert + operation to rollback and all remaining triggers to not run. The + exception is ultimately passed to the caller of the tryInsert method.

        +
        Parameters:
        storable - storable after being inserted
        state - object returned by beforeTryInsert method
        +
        Throws:
        +
        PersistException
        See Also:
        abortTry()
        +
        • +
      + + + + + +
        +
      • +

        failedInsert

        +
        public void failedInsert(S storable,
+                java.lang.Object state)
        +
        Called when an insert operation failed due to a unique constraint + violation or an exception was thrown. The main purpose of this method is + to allow any necessary clean-up to occur on the optional state object. + +

        Any exception thrown by this method will be passed to the current + thread's uncaught exception handler.

        +
        Parameters:
        storable - storable which failed to be inserted
        state - object returned by beforeInsert method, but it may be null
        +
        • +
      + + + + + +
        +
      • +

        beforeUpdate

        +
        public java.lang.Object beforeUpdate(S storable)
+                              throws PersistException
        +
        Called before a storable is to be updated. The default implementation + does nothing. + +

        Any exception thrown by this method will cause the update operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the update method.

        +
        Parameters:
        storable - storable before being updated
        +
        Returns:
        arbitrary state object, passed to afterUpdate or failedUpdate method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        beforeUpdate

        +
        public java.lang.Object beforeUpdate(Transaction txn,
+                            S storable)
+                              throws PersistException
        +
        Called before a storable is to be updated. The default implementation + simply calls beforeUpdate(Object). Only override if access to + the transaction is required. + +

        Any exception thrown by this method will cause the update operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the update method.

        +
        Parameters:
        txn - nested transaction which trigger runs in
        storable - storable before being updated
        +
        Returns:
        arbitrary state object, passed to afterUpdate or failedUpdate method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        beforeTryUpdate

        +
        public java.lang.Object beforeTryUpdate(S storable)
+                                 throws PersistException
        +
        Called before a storable is to be updated via tryUpdate. The default + implementation simply calls beforeUpdate(Object). Only override + if trigger needs to distinguish between different update variants. + +

        Any exception thrown by this method will cause the tryUpdate operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryUpdate method.

        +
        Parameters:
        storable - storable before being updated
        +
        Returns:
        arbitrary state object, passed to afterTryUpdate or failedUpdate method
        +
        Throws:
        +
        PersistException
        See Also:
        abortTry()
        +
        • +
      + + + + + +
        +
      • +

        beforeTryUpdate

        +
        public java.lang.Object beforeTryUpdate(Transaction txn,
+                               S storable)
+                                 throws PersistException
        +
        Called before a storable is to be updated via tryUpdate. The default + implementation simply calls beforeTryUpdate(Object). Only + override if trigger needs access to the transaction and to distinguish + between different update variants. + +

        Any exception thrown by this method will cause the tryUpdate operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryUpdate method.

        +
        Parameters:
        txn - nested transaction which trigger runs in
        storable - storable before being updated
        +
        Returns:
        arbitrary state object, passed to afterTryUpdate or failedUpdate method
        +
        Throws:
        +
        PersistException
        See Also:
        abortTry()
        +
        • +
      + + + + + +
        +
      • +

        afterUpdate

        +
        public void afterUpdate(S storable,
+               java.lang.Object state)
+                 throws PersistException
        +
        Called right after a storable has been successfully updated. The default + implementation does nothing. + +

        Any exception thrown by this method will cause the update operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the update method.

        +
        Parameters:
        storable - storable after being updated
        state - optional object returned by beforeUpdate method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        afterTryUpdate

        +
        public void afterTryUpdate(S storable,
+                  java.lang.Object state)
+                    throws PersistException
        +
        Called right after a storable has been successfully updated via + tryUpdate. The default implementation simply calls afterUpdate(S, java.lang.Object). + Only override if trigger needs to distinguish between different update + variants. + +

        Any exception thrown by this method will cause the tryUpdate + operation to rollback and all remaining triggers to not run. The + exception is ultimately passed to the caller of the tryUpdate method.

        +
        Parameters:
        storable - storable after being updated
        state - object returned by beforeTryUpdate method
        +
        Throws:
        +
        PersistException
        See Also:
        abortTry()
        +
        • +
      + + + + + +
        +
      • +

        failedUpdate

        +
        public void failedUpdate(S storable,
+                java.lang.Object state)
        +
        Called when an update operation failed because the record was missing or + an exception was thrown. The main purpose of this method is to allow any + necessary clean-up to occur on the optional state object. + +

        Any exception thrown by this method will be passed to the current + thread's uncaught exception handler.

        +
        Parameters:
        storable - storable which failed to be updated
        state - optional object returned by beforeUpdate + method, but it may be null
        +
        • +
      + + + + + +
        +
      • +

        beforeDelete

        +
        public java.lang.Object beforeDelete(S storable)
+                              throws PersistException
        +
        Called before a storable is to be deleted. The default implementation + does nothing. + +

        Any exception thrown by this method will cause the delete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the delete method.

        +
        Parameters:
        storable - storable before being deleted
        +
        Returns:
        arbitrary state object, passed to afterDelete or failedDelete method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        beforeDelete

        +
        public java.lang.Object beforeDelete(Transaction txn,
+                            S storable)
+                              throws PersistException
        +
        Called before a storable is to be deleted. The default implementation + simply calls beforeDelete(Object). Only override if access to + the transaction is required. + +

        Any exception thrown by this method will cause the delete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the delete method.

        +
        Parameters:
        txn - nested transaction which trigger runs in
        storable - storable before being deleted
        +
        Returns:
        arbitrary state object, passed to afterDelete or failedDelete method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        beforeTryDelete

        +
        public java.lang.Object beforeTryDelete(S storable)
+                                 throws PersistException
        +
        Called before a storable is to be deleted via tryDelete. The default + implementation simply calls beforeDelete(Object). Only override + if trigger needs to distinguish between different delete variants. + +

        Any exception thrown by this method will cause the tryDelete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryDelete method.

        +
        Parameters:
        storable - storable before being deleted
        +
        Returns:
        arbitrary state object, passed to afterTryDelete or failedDelete method
        +
        Throws:
        +
        PersistException
        See Also:
        abortTry()
        +
        • +
      + + + + + +
        +
      • +

        beforeTryDelete

        +
        public java.lang.Object beforeTryDelete(Transaction txn,
+                               S storable)
+                                 throws PersistException
        +
        Called before a storable is to be deleted via tryDelete. The default + implementation simply calls beforeTryDelete(Object). Only + override if trigger needs access to the transaction and to distinguish + between different delete variants. + +

        Any exception thrown by this method will cause the tryDelete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryDelete method.

        +
        Parameters:
        txn - nested transaction which trigger runs in
        storable - storable before being deleted
        +
        Returns:
        arbitrary state object, passed to afterTryDelete or failedDelete method
        +
        Throws:
        +
        PersistException
        See Also:
        abortTry()
        +
        • +
      + + + + + +
        +
      • +

        afterDelete

        +
        public void afterDelete(S storable,
+               java.lang.Object state)
+                 throws PersistException
        +
        Called right after a storable has been successfully deleted. The default + implementation does nothing. + +

        Any exception thrown by this method will cause the delete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the delete method.

        +
        Parameters:
        storable - storable after being deleted
        state - optional object returned by beforeDelete method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        afterTryDelete

        +
        public void afterTryDelete(S storable,
+                  java.lang.Object state)
+                    throws PersistException
        +
        Called right after a storable has been successfully deleted via + tryDelete. The default implementation simply calls afterDelete(S, java.lang.Object). + Only override if trigger needs to distinguish between different delete + variants. + +

        Any exception thrown by this method will cause the tryDelete + operation to rollback and all remaining triggers to not run. The + exception is ultimately passed to the caller of the tryDelete method.

        +
        Parameters:
        storable - storable after being deleted
        state - object returned by beforeTryDelete method
        +
        Throws:
        +
        PersistException
        See Also:
        abortTry()
        +
        • +
      + + + + + +
        +
      • +

        failedDelete

        +
        public void failedDelete(S storable,
+                java.lang.Object state)
        +
        Called when an delete operation failed because the record was missing or + an exception was thrown. The main purpose of this method is to allow any + necessary clean-up to occur on the optional state object. + +

        Any exception thrown by this method will be passed to the current + thread's uncaught exception handler.

        +
        Parameters:
        storable - storable which failed to be deleted
        state - optional object returned by beforeDelete + method, but it may be null
        +
        • +
      + + + + + +
        +
      • +

        afterLoad

        +
        public void afterLoad(S storable)
+               throws FetchException
        +
        Called right after a storable has been successfully loaded or + fetched. The default implementation does nothing.
        +
        Parameters:
        storable - storable after being loaded or fetched
        +
        Throws:
        +
        FetchException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        abortTry

        +
        protected Trigger.Abort abortTry()
+                          throws Trigger.Abort
        +
        Call to quickly abort a "try" operation, returning false to the + caller. This method should not be called by a non-try trigger method, + since the caller gets thrown an exception with an incomplete stack trace. + +

        This method never returns normally, but as a convenience, a return + type is defined. The abort exception can be thrown by throw abortTry(), + but the throw keyword is not needed.

        +
        Throws:
        +
        Trigger.Abort
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/TriggerFactory.html b/apidocs/com/amazon/carbonado/TriggerFactory.html new file mode 100644 index 0000000..c5511b5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/TriggerFactory.html @@ -0,0 +1,223 @@ + + + + + + +TriggerFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Interface TriggerFactory

+
+
+
+
    +
  • +
    +
    +
    public interface TriggerFactory
    +
    Can be used with RepositoryBuilder to automatically register + triggers as Storable types become available.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      <S extends Storable> 
      Trigger<? super S>      		triggerFor(java.lang.Class<S> type) +
      Return an appropriate trigger for the given type, or null if none.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        triggerFor

        +
        <S extends Storable> Trigger<? super S> triggerFor(java.lang.Class<S> type)
+                                               throws RepositoryException
        +
        Return an appropriate trigger for the given type, or null if none. This + method is expected to be called at most once per Storable type. As an + extra safeguard, trigger implementations are encouraged to implement the + equals method.
        +
        Parameters:
        type - Storable type requesting an automatic trigger
        +
        Returns:
        trigger instance or null if not applicable
        +
        Throws:
        +
        RepositoryException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/UniqueConstraintException.html b/apidocs/com/amazon/carbonado/UniqueConstraintException.html new file mode 100644 index 0000000..9c2c92f --- /dev/null +++ b/apidocs/com/amazon/carbonado/UniqueConstraintException.html @@ -0,0 +1,317 @@ + + + + + + +UniqueConstraintException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Class UniqueConstraintException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class UniqueConstraintException
+extends ConstraintException
    +
    A UniqueConstraintException is thrown if the Repository storage + layer has a unique constraint check defined for a property, and a violation + has been detected.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        UniqueConstraintException

        +
        public UniqueConstraintException()
        +
        • +
      + + + +
        +
      • +

        UniqueConstraintException

        +
        public UniqueConstraintException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        UniqueConstraintException

        +
        public UniqueConstraintException(java.lang.String message,
+                         java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        UniqueConstraintException

        +
        public UniqueConstraintException(java.lang.Throwable cause)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/UnsupportedTypeException.html b/apidocs/com/amazon/carbonado/UnsupportedTypeException.html new file mode 100644 index 0000000..d538038 --- /dev/null +++ b/apidocs/com/amazon/carbonado/UnsupportedTypeException.html @@ -0,0 +1,320 @@ + + + + + + +UnsupportedTypeException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado
+

Class UnsupportedTypeException

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        UnsupportedTypeException

        +
        public UnsupportedTypeException(java.lang.String message,
+                        java.lang.Class<? extends Storable> type)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getType

        +
        public java.lang.Class<? extends Storable> getType()
        +
        • +
      + + + +
        +
      • +

        getMessage

        +
        public java.lang.String getMessage()
        +
        +
        Overrides:
        +
        getMessage in class java.lang.Throwable
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/Version.html b/apidocs/com/amazon/carbonado/Version.html new file mode 100644 index 0000000..00ea984 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Version.html @@ -0,0 +1,189 @@ + + + + + + +Version (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Annotation Type Version

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+public @interface Version
    +
    Designates a Storable property as being the authoritative version + number for the entire Storable instance. Only one property can have this + designation. + +

    Philosophically, a version property can be considered part of the + identity of the storable. Unless the version is Derived, the + repository is responsible for establishing the version on insert, and for + auto-incrementing it on update. Under no circumstances should a normal + version property be incremented manually; this can result in a false OptimisticLockException, or worse may allow the persistent record to become + corrupted. + +

    When updating a storable which has a normal version property, a value for + the version must be specified along with its primary key. Otherwise, an + IllegalStateException is thrown when calling update. If the update + operation detects that the specified version doesn't exactly match the + version of the existing persisted storable, an OptimisticLockException is thrown. For Derived versions, an OptimisticLockException is thrown only if the update detects that the new + version hasn't incremented. + +

    The actual type of the version property can be anything, but some + repositories might only support integers. For maximum portability, version + properties should be a regular 32-bit int. + +

    Example:

    + public interface UserInfo extends Storable {
+     @Version
+     int getRecordVersionNumber();
+     void setRecordVersionNumber(int version);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill, Don Schneider
    +
    See Also:
    OptimisticLockException
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/AdapterDefinition.html b/apidocs/com/amazon/carbonado/adapter/AdapterDefinition.html new file mode 100644 index 0000000..6b8dd93 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/AdapterDefinition.html @@ -0,0 +1,317 @@ + + + + + + +AdapterDefinition (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.adapter
+

Annotation Type AdapterDefinition

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=ANNOTATION_TYPE)
+public @interface AdapterDefinition
    +
    Allows annotations to be defined for supporting property types which are not + natively supported by the underlying storage layer. Repositories must always + attempt to match property types to the best matching native type, but they + may have to rely on an adapter to make a conversion. + +

    The annotation is just a pointer to an adapter implementation class. If + the adapter class is not explicitly provided, it defaults to a static inner + class named "Adapter" in the annotation itself. + +

    The adapter class must have a public constructor that accepts the + annotation that has the AdapterDefinition annotation. It must also define + several adapt methods which convert property values. An adapt method needs + to start with "adapt", accept one parameter and return something. +

    + Example true/false adapter for booleans: + 

    + @Documented
+ @Retention(RetentionPolicy.RUNTIME)
+ @Target(ElementType.METHOD)
+ @AdapterDefinition
+ public @interface TrueFalseAdapter {
+
+     public static class Adapter {
+         private final String propertyName;
+
+         // Constructor may throw a MalformedTypeException if
+         // params supplied by annotation are illegal.
+
+         /**
+          * @param type optional type of object that contains the adapted property
+          * @param propertyName name of property with adapter
+          * @param annotation specific annotation that binds to this adapter class
+          */
+         public Adapter(Class type, String propertyName, TrueFalseAdapter annotation) {
+             this.propertyName = propertyName;
+         }
+
+         // Define at least two adapt methods for each supported property type.
+
+         /**
+          * @param propertyValue value to convert from
+          */
+         public char adaptToChar(boolean propertyValue) {
+             return value ? 'T' : 'F';
+         }
+
+         /**
+          * @param propertyValue value to convert from
+          */
+         public boolean adaptToBoolean(char propertyValue) {
+             if (propertyValue == 'T') { return true; };
+             if (propertyValue == 'F') { return false; };
+             throw new IllegalArgumentException
+                 ("Cannot adapt '" + value + "' into boolean for property \"" +
+                   propertyName + '"');
+         }
+     }
+ }
+
    + + The newly defined adapter can be applied to property accessors. + + 
    + public interface UserInfo extends Storable {
+     @TrueFalseAdapter
+     boolean isAdministrator();
+     void setAdministrator(boolean admin);
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.Classimplementation +
      Specify class which will perform property adaptation.
      +
      java.lang.Class[]storageTypePreferences +
      Optionally specify the set of preferred storage types for storing the + adapted property, in order of most preferred to least preferred.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        implementation

        +
        public abstract java.lang.Class implementation
        +
        Specify class which will perform property adaptation. Must have a public + constructor with the signature + (Class type, String propertyName, Annotation), + where Annotation refers to the annotation with the + adapter definition. + +

        The implementation class need not be explicitly specified. By + default, the adapter class must be a static inner class of the + annotation, named "Adapter".

        +
        +
        Default:
        +
        void.class
        +
        +
        • +
      + + + +
        +
      • +

        storageTypePreferences

        +
        public abstract java.lang.Class[] storageTypePreferences
        +
        Optionally specify the set of preferred storage types for storing the + adapted property, in order of most preferred to least preferred. A type + in the set must be supported by the adapt methods to be considered. + +

        If the repository is independent, it needs help on deciding exactly + how to store the adapted property. A dependent repository will not have + as much flexibility in selecting an appropriate type, but it may still + need a hint.

        +
        +
        Default:
        +
        {}
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html new file mode 100644 index 0000000..643f670 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html @@ -0,0 +1,1052 @@ + + + + + + +DateTimeAdapter.Adapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.adapter
+

Class DateTimeAdapter.Adapter

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    DateTimeAdapter
    +
    +
    +
    +
    public static class DateTimeAdapter.Adapter
+extends java.lang.Object
    +
    Adapter implementation for DateTimeAdapter.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DateTimeAdapter.Adapter

        +
        public DateTimeAdapter.Adapter(java.lang.Class<?> type,
+                       java.lang.String propertyName,
+                       DateTimeAdapter ann)
        +
        Parameters:
        type - type of object that contains the adapted property
        propertyName - name of property with adapter
        ann - specific annotation that binds to this adapter class
        +
        • +
      + + + +
        +
      • +

        DateTimeAdapter.Adapter

        +
        public DateTimeAdapter.Adapter(java.lang.Class<?> type,
+                       java.lang.String propertyName,
+                       org.joda.time.DateTimeZone zone)
        +
        Parameters:
        type - type of object that contains the adapted property
        propertyName - name of property with
        zone - time zone to apply, or null to use default
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        adaptToDateTime

        +
        public org.joda.time.DateTime adaptToDateTime(long instant)
        +
        • +
      + + + +
        +
      • +

        adaptToDateTime

        +
        public org.joda.time.DateTime adaptToDateTime(java.lang.Long instant)
        +
        • +
      + + + +
        +
      • +

        adaptToDateTime

        +
        public org.joda.time.DateTime adaptToDateTime(java.lang.String isoDateString)
        +
        • +
      + + + +
        +
      • +

        adaptToDateTime

        +
        public org.joda.time.DateTime adaptToDateTime(java.util.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToDateTime

        +
        public org.joda.time.DateTime adaptToDateTime(java.sql.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToDateTime

        +
        public org.joda.time.DateTime adaptToDateTime(java.sql.Time time)
        +
        • +
      + + + +
        +
      • +

        adaptToDateTime

        +
        public org.joda.time.DateTime adaptToDateTime(java.sql.Timestamp timestamp)
        +
        • +
      + + + +
        +
      • +

        adaptToDateMidnight

        +
        public org.joda.time.DateMidnight adaptToDateMidnight(long instant)
        +
        • +
      + + + +
        +
      • +

        adaptToDateMidnight

        +
        public org.joda.time.DateMidnight adaptToDateMidnight(java.lang.Long instant)
        +
        • +
      + + + +
        +
      • +

        adaptToDateMidnight

        +
        public org.joda.time.DateMidnight adaptToDateMidnight(java.lang.String isoDateString)
        +
        • +
      + + + +
        +
      • +

        adaptToDateMidnight

        +
        public org.joda.time.DateMidnight adaptToDateMidnight(java.util.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToDateMidnight

        +
        public org.joda.time.DateMidnight adaptToDateMidnight(java.sql.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToDateMidnight

        +
        public org.joda.time.DateMidnight adaptToDateMidnight(java.sql.Time time)
        +
        • +
      + + + +
        +
      • +

        adaptToDateMidnight

        +
        public org.joda.time.DateMidnight adaptToDateMidnight(java.sql.Timestamp timestamp)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDateTime

        +
        public org.joda.time.LocalDateTime adaptToLocalDateTime(long instant)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDateTime

        +
        public org.joda.time.LocalDateTime adaptToLocalDateTime(java.lang.Long instant)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDateTime

        +
        public org.joda.time.LocalDateTime adaptToLocalDateTime(java.lang.String isoDateString)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDateTime

        +
        public org.joda.time.LocalDateTime adaptToLocalDateTime(java.util.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDateTime

        +
        public org.joda.time.LocalDateTime adaptToLocalDateTime(java.sql.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDateTime

        +
        public org.joda.time.LocalDateTime adaptToLocalDateTime(java.sql.Time time)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDateTime

        +
        public org.joda.time.LocalDateTime adaptToLocalDateTime(java.sql.Timestamp timestamp)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDate

        +
        public org.joda.time.LocalDate adaptToLocalDate(long instant)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDate

        +
        public org.joda.time.LocalDate adaptToLocalDate(java.lang.Long instant)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDate

        +
        public org.joda.time.LocalDate adaptToLocalDate(java.lang.String isoDateString)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDate

        +
        public org.joda.time.LocalDate adaptToLocalDate(java.util.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDate

        +
        public org.joda.time.LocalDate adaptToLocalDate(java.sql.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDate

        +
        public org.joda.time.LocalDate adaptToLocalDate(java.sql.Time time)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDate

        +
        public org.joda.time.LocalDate adaptToLocalDate(java.sql.Timestamp timestamp)
        +
        • +
      + + + +
        +
      • +

        adaptToLong

        +
        public long adaptToLong(org.joda.time.ReadableInstant instant)
        +
        • +
      + + + +
        +
      • +

        adaptToLongObj

        +
        public java.lang.Long adaptToLongObj(org.joda.time.ReadableInstant instant)
        +
        • +
      + + + +
        +
      • +

        adaptToString

        +
        public java.lang.String adaptToString(org.joda.time.ReadableInstant instant)
        +
        • +
      + + + +
        +
      • +

        adaptToDate

        +
        public java.util.Date adaptToDate(org.joda.time.ReadableInstant instant)
        +
        • +
      + + + +
        +
      • +

        adaptToSqlDate

        +
        public java.sql.Date adaptToSqlDate(org.joda.time.ReadableInstant instant)
        +
        • +
      + + + +
        +
      • +

        adaptToSqlTime

        +
        public java.sql.Time adaptToSqlTime(org.joda.time.ReadableInstant instant)
        +
        • +
      + + + +
        +
      • +

        adaptToSqlTimestamp

        +
        public java.sql.Timestamp adaptToSqlTimestamp(org.joda.time.ReadableInstant instant)
        +
        • +
      + + + +
        +
      • +

        adaptToLong

        +
        public long adaptToLong(org.joda.time.LocalDateTime dateTime)
        +
        • +
      + + + +
        +
      • +

        adaptToLongObj

        +
        public java.lang.Long adaptToLongObj(org.joda.time.LocalDateTime dateTime)
        +
        • +
      + + + +
        +
      • +

        adaptToString

        +
        public java.lang.String adaptToString(org.joda.time.LocalDateTime dateTime)
        +
        • +
      + + + +
        +
      • +

        adaptToDate

        +
        public java.util.Date adaptToDate(org.joda.time.LocalDateTime dateTime)
        +
        • +
      + + + +
        +
      • +

        adaptToSqlDate

        +
        public java.sql.Date adaptToSqlDate(org.joda.time.LocalDateTime dateTime)
        +
        • +
      + + + +
        +
      • +

        adaptToSqlTime

        +
        public java.sql.Time adaptToSqlTime(org.joda.time.LocalDateTime dateTime)
        +
        • +
      + + + +
        +
      • +

        adaptToSqlTimestamp

        +
        public java.sql.Timestamp adaptToSqlTimestamp(org.joda.time.LocalDateTime dateTime)
        +
        • +
      + + + +
        +
      • +

        adaptToLong

        +
        public long adaptToLong(org.joda.time.LocalDate date)
        +
        • +
      + + + +
        +
      • +

        adaptToLongObj

        +
        public java.lang.Long adaptToLongObj(org.joda.time.LocalDate date)
        +
        • +
      + + + +
        +
      • +

        adaptToString

        +
        public java.lang.String adaptToString(org.joda.time.LocalDate date)
        +
        • +
      + + + +
        +
      • +

        adaptToDate

        +
        public java.util.Date adaptToDate(org.joda.time.LocalDate date)
        +
        • +
      + + + +
        +
      • +

        adaptToSqlDate

        +
        public java.sql.Date adaptToSqlDate(org.joda.time.LocalDate date)
        +
        • +
      + + + +
        +
      • +

        adaptToSqlTimestamp

        +
        public java.sql.Timestamp adaptToSqlTimestamp(org.joda.time.LocalDate date)
        +
        • +
      + + + +
        +
      • +

        adaptToDate

        +
        public java.util.Date adaptToDate(long instant)
        +
        • +
      + + + +
        +
      • +

        adaptToDate

        +
        public java.util.Date adaptToDate(java.lang.Long instant)
        +
        • +
      + + + +
        +
      • +

        adaptToDate

        +
        public java.util.Date adaptToDate(java.lang.String isoDateString)
        +
        • +
      + + + +
        +
      • +

        adaptToDate

        +
        public java.util.Date adaptToDate(java.sql.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToDate

        +
        public java.util.Date adaptToDate(java.sql.Time time)
        +
        • +
      + + + +
        +
      • +

        adaptToDate

        +
        public java.util.Date adaptToDate(java.sql.Timestamp timestamp)
        +
        • +
      + + + +
        +
      • +

        adaptToLong

        +
        public long adaptToLong(java.util.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToLongObj

        +
        public java.lang.Long adaptToLongObj(java.util.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToString

        +
        public java.lang.String adaptToString(java.util.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToSqlDate

        +
        public java.sql.Date adaptToSqlDate(java.util.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToSqlTime

        +
        public java.sql.Time adaptToSqlTime(java.util.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToSqlTimestamp

        +
        public java.sql.Timestamp adaptToSqlTimestamp(java.util.Date date)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/DateTimeAdapter.html b/apidocs/com/amazon/carbonado/adapter/DateTimeAdapter.html new file mode 100644 index 0000000..8bcca50 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/DateTimeAdapter.html @@ -0,0 +1,231 @@ + + + + + + +DateTimeAdapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.adapter
+

Annotation Type DateTimeAdapter

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+@AdapterDefinition(storageTypePreferences={long.class,java.lang.Long.class,java.lang.String.class})
+public @interface DateTimeAdapter
    +
    Converts Joda-Time datetime objects to and from other forms. This adapter is + applied automatically for all storable properties of type DateTime, + DateMidnight, LocalDateTime, LocalDate and also + Date. Explicit use allows a different time zone to be + used, but this only works for Joda-Time objects. + +

    Example:

    + public interface UserInfo extends Storable {
+     @DateTimeAdapter(timeZone="UTC")
+     DateTime getModifyDateTime();
+     void setModifyDateTime(DateTime dt);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill, Justin Rudd
    +
    See Also:
    AdapterDefinition
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.StringtimeZone +
      Optionally specify a time zone to apply to new DateTimes, overriding the + default time zone.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        timeZone

        +
        public abstract java.lang.String timeZone
        +
        Optionally specify a time zone to apply to new DateTimes, overriding the + default time zone.
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html new file mode 100644 index 0000000..ad825fe --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html @@ -0,0 +1,455 @@ + + + + + + +PrimitiveArrayAdapter.Adapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.adapter
+

Class PrimitiveArrayAdapter.Adapter

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PrimitiveArrayAdapter.Adapter

        +
        public PrimitiveArrayAdapter.Adapter(java.lang.Class<?> type,
+                             java.lang.String propertyName,
+                             PrimitiveArrayAdapter ann)
        +
        Parameters:
        type - type of object that contains the adapted property
        propertyName - name of property with adapter
        ann - specific annotation that binds to this adapter class
        +
        • +
      + + + +
        +
      • +

        PrimitiveArrayAdapter.Adapter

        +
        public PrimitiveArrayAdapter.Adapter()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        adaptToByteArray

        +
        public byte[] adaptToByteArray(short[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToByteArray

        +
        public byte[] adaptToByteArray(char[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToByteArray

        +
        public byte[] adaptToByteArray(int[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToByteArray

        +
        public byte[] adaptToByteArray(long[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToByteArray

        +
        public byte[] adaptToByteArray(float[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToByteArray

        +
        public byte[] adaptToByteArray(double[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToByteArray

        +
        public byte[] adaptToByteArray(boolean[] src)
        +
        Packs the given boolean array into a byte array, big-endian fashion.
        +
        • +
      + + + +
        +
      • +

        adaptToShortArray

        +
        public short[] adaptToShortArray(byte[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToCharArray

        +
        public char[] adaptToCharArray(byte[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToIntArray

        +
        public int[] adaptToIntArray(byte[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToLongArray

        +
        public long[] adaptToLongArray(byte[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToFloatArray

        +
        public float[] adaptToFloatArray(byte[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToDoubleArray

        +
        public double[] adaptToDoubleArray(byte[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToBooleanArray

        +
        public boolean[] adaptToBooleanArray(byte[] src)
        +
        Unpacks a boolean array from a byte array, big-endian fashion.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html b/apidocs/com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html new file mode 100644 index 0000000..04a3a5d --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html @@ -0,0 +1,161 @@ + + + + + + +PrimitiveArrayAdapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.adapter
+

Annotation Type PrimitiveArrayAdapter

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+@AdapterDefinition(storageTypePreferences=byte[].class)
+public @interface PrimitiveArrayAdapter
    +
    Allows arrays of primitive types to be encoded (big-endian) as byte arrays.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/TextAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/TextAdapter.Adapter.html new file mode 100644 index 0000000..7d1ef87 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/TextAdapter.Adapter.html @@ -0,0 +1,370 @@ + + + + + + +TextAdapter.Adapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.adapter
+

Class TextAdapter.Adapter

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    TextAdapter
    +
    +
    +
    +
    public static class TextAdapter.Adapter
+extends java.lang.Object
    +
    Adapter implementation for TextAdapter.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      TextAdapter.Adapter(java.lang.Class<?> type, + java.lang.String propertyName, + java.nio.charset.Charset charset) 
      TextAdapter.Adapter(java.lang.Class<?> type, + java.lang.String propertyName, + java.nio.charset.Charset charset, + java.nio.charset.Charset[] altCharsets) 
      TextAdapter.Adapter(java.lang.Class<?> type, + java.lang.String propertyName, + java.lang.String charset) 
      TextAdapter.Adapter(java.lang.Class<?> type, + java.lang.String propertyName, + TextAdapter ann) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      BlobadaptToBlob(java.lang.String text) 
      ClobadaptToClob(java.lang.String text) 
      java.lang.StringadaptToString(Blob blob) 
      java.lang.StringadaptToString(Clob clob) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TextAdapter.Adapter

        +
        public TextAdapter.Adapter(java.lang.Class<?> type,
+                   java.lang.String propertyName,
+                   TextAdapter ann)
        +
        Parameters:
        type - type of object that contains the adapted property
        propertyName - name of property with adapter
        ann - specific annotation that binds to this adapter class
        +
        • +
      + + + +
        +
      • +

        TextAdapter.Adapter

        +
        public TextAdapter.Adapter(java.lang.Class<?> type,
+                   java.lang.String propertyName,
+                   java.lang.String charset)
        +
        Parameters:
        type - type of object that contains the adapted property
        propertyName - name of property with
        charset - character set to use, or null to use default of UTF-8.
        +
        • +
      + + + +
        +
      • +

        TextAdapter.Adapter

        +
        public TextAdapter.Adapter(java.lang.Class<?> type,
+                   java.lang.String propertyName,
+                   java.nio.charset.Charset charset)
        +
        Parameters:
        type - type of object that contains the adapted property
        propertyName - name of property with
        charset - character set to use, or null to use default of UTF-8.
        +
        • +
      + + + +
        +
      • +

        TextAdapter.Adapter

        +
        public TextAdapter.Adapter(java.lang.Class<?> type,
+                   java.lang.String propertyName,
+                   java.nio.charset.Charset charset,
+                   java.nio.charset.Charset[] altCharsets)
        +
        Parameters:
        type - type of object that contains the adapted property
        propertyName - name of property with
        charset - character set to use, or null to use default of UTF-8.
        altCharsets - alternate character sets to use, if text cannot be + decoded with primary charset
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/TextAdapter.html b/apidocs/com/amazon/carbonado/adapter/TextAdapter.html new file mode 100644 index 0000000..71853c5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/TextAdapter.html @@ -0,0 +1,253 @@ + + + + + + +TextAdapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.adapter
+

Annotation Type TextAdapter

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+@AdapterDefinition(storageTypePreferences={java.lang.String.class,Clob.class,Blob.class})
+public @interface TextAdapter
    +
    Converts database Blobs and Clobs to Strings. This is suitable for text + values which are expected to fit entirely in memory. The storage layer will + attempt to store the text as a regular string, but will use a blob type if + required to. + +

    Example:

    + public interface UserInfo extends Storable {
+     @TextAdapter(charset="UTF-8")
+     String getWelcomeMessage();
+     void setWelcomeMessage(String message);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Clob, +Blob
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.String[]altCharsets +
      Optionally specify alternate character sets, which are used if text + cannot be decoded with primary charset.
      +
      java.lang.Stringcharset +
      Optionally specify a character set, which is used if the storage type is + a Blob.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        charset

        +
        public abstract java.lang.String charset
        +
        Optionally specify a character set, which is used if the storage type is + a Blob.
        +
        +
        Default:
        +
        "UTF-8"
        +
        +
        • +
      + + + +
        +
      • +

        altCharsets

        +
        public abstract java.lang.String[] altCharsets
        +
        Optionally specify alternate character sets, which are used if text + cannot be decoded with primary charset.
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html new file mode 100644 index 0000000..0d6ea7f --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html @@ -0,0 +1,470 @@ + + + + + + +TrueFalseAdapter.Adapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.adapter
+

Class TrueFalseAdapter.Adapter

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    TrueFalseAdapter
    +
    +
    +
    +
    public static class TrueFalseAdapter.Adapter
+extends java.lang.Object
    +
    Adapter implementation for TrueFalseAdapter.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanadaptToBoolean(char value) +
      Adapts a character 'T' or 'F' to true or false.
      +
      booleanadaptToBoolean(java.lang.Character value) +
      Adapts a character 'T' or 'F' to true or false.
      +
      booleanadaptToBoolean(java.lang.String value) +
      Adapts a character "T" or "F" to true or false.
      +
      java.lang.BooleanadaptToBooleanObj(char value) +
      Adapts a character 'T' or 'F' to true or false.
      +
      java.lang.BooleanadaptToBooleanObj(java.lang.Character value) +
      Adapts a character 'T' or 'F' to true or false.
      +
      java.lang.BooleanadaptToBooleanObj(java.lang.String value) +
      Adapts a character "T" or "F" to true or false.
      +
      charadaptToChar(boolean value) +
      Adapts a boolean true or false into 'T' or 'F'.
      +
      charadaptToChar(java.lang.Boolean value) +
      Adapts a boolean true into 'T', and anything else to 'F'.
      +
      java.lang.CharacteradaptToCharacter(boolean value) +
      Adapts a boolean true or false into 'T' or 'F'.
      +
      java.lang.CharacteradaptToCharacter(java.lang.Boolean value) +
      Adapts a boolean true into 'T', and anything else to 'F'.
      +
      java.lang.StringadaptToString(boolean value) +
      Adapts a boolean true or false into "T" or "F".
      +
      java.lang.StringadaptToString(java.lang.Boolean value) +
      Adapts a boolean true into "T", and anything else to "F".
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TrueFalseAdapter.Adapter

        +
        public TrueFalseAdapter.Adapter(java.lang.Class<?> type,
+                        java.lang.String propertyName,
+                        TrueFalseAdapter ann)
        +
        Parameters:
        type - type of object that contains the adapted property
        propertyName - name of property with adapter
        ann - specific annotation that binds to this adapter class
        +
        • +
      + + + +
        +
      • +

        TrueFalseAdapter.Adapter

        +
        public TrueFalseAdapter.Adapter(java.lang.Class<?> type,
+                        java.lang.String propertyName,
+                        boolean lenient)
        +
        Parameters:
        type - type of object that contains the adapted property
        propertyName - name of property with
        lenient - lenient when true
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        adaptToChar

        +
        public char adaptToChar(boolean value)
        +
        Adapts a boolean true or false into 'T' or 'F'.
        +
        • +
      + + + +
        +
      • +

        adaptToChar

        +
        public char adaptToChar(java.lang.Boolean value)
        +
        Adapts a boolean true into 'T', and anything else to 'F'.
        +
        • +
      + + + +
        +
      • +

        adaptToCharacter

        +
        public java.lang.Character adaptToCharacter(boolean value)
        +
        Adapts a boolean true or false into 'T' or 'F'.
        +
        • +
      + + + +
        +
      • +

        adaptToCharacter

        +
        public java.lang.Character adaptToCharacter(java.lang.Boolean value)
        +
        Adapts a boolean true into 'T', and anything else to 'F'.
        +
        • +
      + + + +
        +
      • +

        adaptToString

        +
        public java.lang.String adaptToString(boolean value)
        +
        Adapts a boolean true or false into "T" or "F".
        +
        • +
      + + + +
        +
      • +

        adaptToString

        +
        public java.lang.String adaptToString(java.lang.Boolean value)
        +
        Adapts a boolean true into "T", and anything else to "F".
        +
        • +
      + + + +
        +
      • +

        adaptToBoolean

        +
        public boolean adaptToBoolean(char value)
        +
        Adapts a character 'T' or 'F' to true or false. If lenient, other characters are accepted as + well.
        +
        • +
      + + + +
        +
      • +

        adaptToBoolean

        +
        public boolean adaptToBoolean(java.lang.Character value)
        +
        Adapts a character 'T' or 'F' to true or false. If lenient, other characters are accepted as + well.
        +
        • +
      + + + +
        +
      • +

        adaptToBoolean

        +
        public boolean adaptToBoolean(java.lang.String value)
        +
        Adapts a character "T" or "F" to true or false. If leneint, other characters are accepted as + well.
        +
        • +
      + + + +
        +
      • +

        adaptToBooleanObj

        +
        public java.lang.Boolean adaptToBooleanObj(char value)
        +
        Adapts a character 'T' or 'F' to true or false. If lenient, other characters are accepted as + well.
        +
        • +
      + + + +
        +
      • +

        adaptToBooleanObj

        +
        public java.lang.Boolean adaptToBooleanObj(java.lang.Character value)
        +
        Adapts a character 'T' or 'F' to true or false. If lenient, other characters are accepted as + well.
        +
        • +
      + + + +
        +
      • +

        adaptToBooleanObj

        +
        public java.lang.Boolean adaptToBooleanObj(java.lang.String value)
        +
        Adapts a character "T" or "F" to true or false. If lenient, other characters are accepted as + well.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/TrueFalseAdapter.html b/apidocs/com/amazon/carbonado/adapter/TrueFalseAdapter.html new file mode 100644 index 0000000..d2f770e --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/TrueFalseAdapter.html @@ -0,0 +1,230 @@ + + + + + + +TrueFalseAdapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.adapter
+

Annotation Type TrueFalseAdapter

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+@AdapterDefinition(storageTypePreferences={char.class,java.lang.Character.class,java.lang.String.class})
+public @interface TrueFalseAdapter
    +
    Adapter that converts 'T' or 'F' to and from a boolean value. + +

    Example:

    + public interface UserInfo extends Storable {
+     @TrueFalseAdapter
+     boolean isAdministrator();
+     void setAdministrator(boolean admin);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    YesNoAdapter, +AdapterDefinition
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      booleanlenient +
      Specify that this adapter should be lenient when converting characters + into booleans.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        lenient

        +
        public abstract boolean lenient
        +
        Specify that this adapter should be lenient when converting characters + into booleans. By default it is true, and it accepts the following as + true: 'T', 't', 'Y', 'y', '1'. For false: 'F', 'f', 'N', 'n', '0'. When + lenient is false, only 'T' and 'F' are accepted.
        +
        +
        Default:
        +
        true
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html new file mode 100644 index 0000000..1481938 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html @@ -0,0 +1,470 @@ + + + + + + +YesNoAdapter.Adapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.adapter
+

Class YesNoAdapter.Adapter

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    YesNoAdapter
    +
    +
    +
    +
    public static class YesNoAdapter.Adapter
+extends java.lang.Object
    +
    Adapter implementation for YesNoAdapter.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      YesNoAdapter.Adapter(java.lang.Class<?> type, + java.lang.String propertyName, + boolean lenient) 
      YesNoAdapter.Adapter(java.lang.Class<?> type, + java.lang.String propertyName, + YesNoAdapter ann) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanadaptToBoolean(char value) +
      Adapts a character 'Y' or 'N' to true or false.
      +
      booleanadaptToBoolean(java.lang.Character value) +
      Adapts a character 'Y' or 'N' to true or false.
      +
      booleanadaptToBoolean(java.lang.String value) +
      Adapts a character "Y" or "N" to true or false.
      +
      java.lang.BooleanadaptToBooleanObj(char value) +
      Adapts a character 'Y' or 'N' to true or false.
      +
      java.lang.BooleanadaptToBooleanObj(java.lang.Character value) +
      Adapts a character 'Y' or 'N' to true or false.
      +
      java.lang.BooleanadaptToBooleanObj(java.lang.String value) +
      Adapts a character "Y" or "N" to true or false.
      +
      charadaptToChar(boolean value) +
      Adapts a boolean true or false into 'Y' or 'N'.
      +
      charadaptToChar(java.lang.Boolean value) +
      Adapts a boolean true into 'Y', and anything else to 'N'.
      +
      java.lang.CharacteradaptToCharacter(boolean value) +
      Adapts a boolean true or false into 'Y' or 'N'.
      +
      java.lang.CharacteradaptToCharacter(java.lang.Boolean value) +
      Adapts a boolean true into 'Y', and anything else to 'N'.
      +
      java.lang.StringadaptToString(boolean value) +
      Adapts a boolean true or false into "Y" or "N".
      +
      java.lang.StringadaptToString(java.lang.Boolean value) +
      Adapts a boolean true into "Y", and anything else to "N".
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        YesNoAdapter.Adapter

        +
        public YesNoAdapter.Adapter(java.lang.Class<?> type,
+                    java.lang.String propertyName,
+                    YesNoAdapter ann)
        +
        Parameters:
        type - type of object that contains the adapted property
        propertyName - name of property with adapter
        ann - specific annotation that binds to this adapter class
        +
        • +
      + + + +
        +
      • +

        YesNoAdapter.Adapter

        +
        public YesNoAdapter.Adapter(java.lang.Class<?> type,
+                    java.lang.String propertyName,
+                    boolean lenient)
        +
        Parameters:
        type - type of object that contains the adapted property
        propertyName - name of property with
        lenient - lenient when true
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        adaptToChar

        +
        public char adaptToChar(boolean value)
        +
        Adapts a boolean true or false into 'Y' or 'N'.
        +
        • +
      + + + +
        +
      • +

        adaptToChar

        +
        public char adaptToChar(java.lang.Boolean value)
        +
        Adapts a boolean true into 'Y', and anything else to 'N'.
        +
        • +
      + + + +
        +
      • +

        adaptToCharacter

        +
        public java.lang.Character adaptToCharacter(boolean value)
        +
        Adapts a boolean true or false into 'Y' or 'N'.
        +
        • +
      + + + +
        +
      • +

        adaptToCharacter

        +
        public java.lang.Character adaptToCharacter(java.lang.Boolean value)
        +
        Adapts a boolean true into 'Y', and anything else to 'N'.
        +
        • +
      + + + +
        +
      • +

        adaptToString

        +
        public java.lang.String adaptToString(boolean value)
        +
        Adapts a boolean true or false into "Y" or "N".
        +
        • +
      + + + +
        +
      • +

        adaptToString

        +
        public java.lang.String adaptToString(java.lang.Boolean value)
        +
        Adapts a boolean true into "Y", and anything else to "N".
        +
        • +
      + + + +
        +
      • +

        adaptToBoolean

        +
        public boolean adaptToBoolean(char value)
        +
        Adapts a character 'Y' or 'N' to true or false. If lenient, other characters are accepted as + well.
        +
        • +
      + + + +
        +
      • +

        adaptToBoolean

        +
        public boolean adaptToBoolean(java.lang.Character value)
        +
        Adapts a character 'Y' or 'N' to true or false. If lenient, other characters are accepted as + well.
        +
        • +
      + + + +
        +
      • +

        adaptToBoolean

        +
        public boolean adaptToBoolean(java.lang.String value)
        +
        Adapts a character "Y" or "N" to true or false. If lenient, other characters are accepted as + well.
        +
        • +
      + + + +
        +
      • +

        adaptToBooleanObj

        +
        public java.lang.Boolean adaptToBooleanObj(char value)
        +
        Adapts a character 'Y' or 'N' to true or false. If lenient, other characters are accepted as + well.
        +
        • +
      + + + +
        +
      • +

        adaptToBooleanObj

        +
        public java.lang.Boolean adaptToBooleanObj(java.lang.Character value)
        +
        Adapts a character 'Y' or 'N' to true or false. If lenient, other characters are accepted as + well.
        +
        • +
      + + + +
        +
      • +

        adaptToBooleanObj

        +
        public java.lang.Boolean adaptToBooleanObj(java.lang.String value)
        +
        Adapts a character "Y" or "N" to true or false. If lenient, other characters are accepted as + well.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/YesNoAdapter.html b/apidocs/com/amazon/carbonado/adapter/YesNoAdapter.html new file mode 100644 index 0000000..5022fcb --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/YesNoAdapter.html @@ -0,0 +1,230 @@ + + + + + + +YesNoAdapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.adapter
+

Annotation Type YesNoAdapter

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+@AdapterDefinition(storageTypePreferences={char.class,java.lang.Character.class,java.lang.String.class})
+public @interface YesNoAdapter
    +
    Adapter that converts 'Y' or 'N' to and from a boolean value. + +

    Example:

    + public interface UserInfo extends Storable {
+     @YesNoAdapter
+     boolean isAdministrator();
+     void setAdministrator(boolean admin);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    TrueFalseAdapter, +AdapterDefinition
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      booleanlenient +
      Specify that this adapter should be lenient when converting characters + into booleans.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        lenient

        +
        public abstract boolean lenient
        +
        Specify that this adapter should be lenient when converting characters + into booleans. By default it is true, and it accepts the following as + true: 'Y', 'y', 'T', 't', '1'. For false: 'N', 'n', 'F', 'f', '0'. When + lenient is false, only 'Y' and 'N' are accepted.
        +
        +
        Default:
        +
        true
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.adapter.AdapterDefinition

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

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

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

Uses of Class
com.amazon.carbonado.adapter.DateTimeAdapter.Adapter

+
+
No usage of com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/DateTimeAdapter.html b/apidocs/com/amazon/carbonado/adapter/class-use/DateTimeAdapter.html new file mode 100644 index 0000000..61ceae0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/DateTimeAdapter.html @@ -0,0 +1,159 @@ + + + + + + +Uses of Class com.amazon.carbonado.adapter.DateTimeAdapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.adapter.DateTimeAdapter

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

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

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

Uses of Class
com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter

+
+
No usage of com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.html b/apidocs/com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.html new file mode 100644 index 0000000..4f87a6c --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.html @@ -0,0 +1,159 @@ + + + + + + +Uses of Class com.amazon.carbonado.adapter.PrimitiveArrayAdapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.adapter.PrimitiveArrayAdapter

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

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

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

Uses of Class
com.amazon.carbonado.adapter.TextAdapter.Adapter

+
+
No usage of com.amazon.carbonado.adapter.TextAdapter.Adapter
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/TextAdapter.html b/apidocs/com/amazon/carbonado/adapter/class-use/TextAdapter.html new file mode 100644 index 0000000..498167d --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/TextAdapter.html @@ -0,0 +1,159 @@ + + + + + + +Uses of Class com.amazon.carbonado.adapter.TextAdapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.adapter.TextAdapter

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

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

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

Uses of Class
com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter

+
+
No usage of com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.adapter.TrueFalseAdapter

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

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

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

Uses of Class
com.amazon.carbonado.adapter.YesNoAdapter.Adapter

+
+
No usage of com.amazon.carbonado.adapter.YesNoAdapter.Adapter
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.adapter.YesNoAdapter

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/package-frame.html b/apidocs/com/amazon/carbonado/adapter/package-frame.html new file mode 100644 index 0000000..2bb220a --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/package-frame.html @@ -0,0 +1,33 @@ + + + + + + +com.amazon.carbonado.adapter (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.adapter

+
+

Classes

+ +

Annotation Types

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/adapter/package-summary.html b/apidocs/com/amazon/carbonado/adapter/package-summary.html new file mode 100644 index 0000000..1277e21 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/package-summary.html @@ -0,0 +1,219 @@ + + + + + + +com.amazon.carbonado.adapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.adapter

+
+
Contains annotations and implementations for supporting property adapters.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.adapter Description

+
Contains annotations and implementations for supporting property adapters.
+
See Also:
AdapterDefinition
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/package-tree.html b/apidocs/com/amazon/carbonado/adapter/package-tree.html new file mode 100644 index 0000000..ae1b8a9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/package-tree.html @@ -0,0 +1,143 @@ + + + + + + +com.amazon.carbonado.adapter Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.adapter

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Annotation Type Hierarchy

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/package-use.html b/apidocs/com/amazon/carbonado/adapter/package-use.html new file mode 100644 index 0000000..5cbc4db --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/package-use.html @@ -0,0 +1,180 @@ + + + + + + +Uses of Package com.amazon.carbonado.adapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.adapter

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/capability/Capability.html b/apidocs/com/amazon/carbonado/capability/Capability.html new file mode 100644 index 0000000..ad1e7db --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/Capability.html @@ -0,0 +1,172 @@ + + + + + + +Capability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface Capability

+
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/capability/GroupAccessCapability.html b/apidocs/com/amazon/carbonado/capability/GroupAccessCapability.html new file mode 100644 index 0000000..93d18e6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/GroupAccessCapability.html @@ -0,0 +1,220 @@ + + + + + + +GroupAccessCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface GroupAccessCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface GroupAccessCapability
+extends Capability
    +
    Capability for gaining access to replication group members.
    +
    Author:
    +
    Vishal Parakh
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      GroupMembersgetGroupMembers() +
      Return all replication group members, including this repository.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getGroupMembers

        +
        GroupMembers getGroupMembers()
        +
        Return all replication group members, including this repository. + Returned instance remains the same unless group membership changes.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/capability/GroupMembers.html b/apidocs/com/amazon/carbonado/capability/GroupMembers.html new file mode 100644 index 0000000..e0b5336 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/GroupMembers.html @@ -0,0 +1,215 @@ + + + + + + +GroupMembers (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface GroupMembers

+
+
+
+
    +
  • +
    +
    +
    public interface GroupMembers
    +
    Author:
    +
    Vishal Parakh, Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.util.SortedMap<java.lang.Object,Repository>getReadWriteMembers() +
      Returns members intended for read and write access.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getReadWriteMembers

        +
        java.util.SortedMap<java.lang.Object,Repository> getReadWriteMembers()
        +
        Returns members intended for read and write access. Keys must uniquely + identify group members, must be serializable, and must have appropriate + implementations of the hashCode and equals methods.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/capability/IndexInfo.html b/apidocs/com/amazon/carbonado/capability/IndexInfo.html new file mode 100644 index 0000000..28f8e06 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/IndexInfo.html @@ -0,0 +1,294 @@ + + + + + + +IndexInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface IndexInfo

+
+
+
+
    +
  • +
    +
    All Known Subinterfaces:
    +
    IndexEntryAccessor<S>
    +
    +
    +
    All Known Implementing Classes:
    +
    IndexInfoImpl
    +
    +
    +
    +
    public interface IndexInfo
    +
    General information about an index defined in a Storage. + +

    IndexInfo instances are thread-safe and immutable.

    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    IndexInfoCapability
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetName() +
      Returns the name of this index, or null if not applicable.
      +
      Direction[]getPropertyDirections() +
      Returns the directions of all the properties in this index.
      +
      java.lang.String[]getPropertyNames() +
      Returns the properties in this index.
      +
      booleanisClustered() +
      Returns true if index is clustered, which means it defines the physical + ordering of storables.
      +
      booleanisUnique() +
      Returns true if index entries are unique.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        java.lang.String getName()
        +
        Returns the name of this index, or null if not applicable.
        +
        • +
      + + + +
        +
      • +

        isUnique

        +
        boolean isUnique()
        +
        Returns true if index entries are unique.
        +
        • +
      + + + +
        +
      • +

        isClustered

        +
        boolean isClustered()
        +
        Returns true if index is clustered, which means it defines the physical + ordering of storables.
        +
        • +
      + + + +
        +
      • +

        getPropertyNames

        +
        java.lang.String[] getPropertyNames()
        +
        Returns the properties in this index. The array might be empty, but it + is never null. The array is a copy, and so it may be safely modified.
        +
        • +
      + + + +
        +
      • +

        getPropertyDirections

        +
        Direction[] getPropertyDirections()
        +
        Returns the directions of all the properties in this index. The length + of the array matches the length returned by getPropertyNames(). The array is a copy, and so it may be safely + modified.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/capability/IndexInfoCapability.html b/apidocs/com/amazon/carbonado/capability/IndexInfoCapability.html new file mode 100644 index 0000000..2e416fe --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/IndexInfoCapability.html @@ -0,0 +1,225 @@ + + + + + + +IndexInfoCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface IndexInfoCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface IndexInfoCapability
+extends Capability
    +
    Capability for getting information about physical indexes for storables.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      <S extends Storable> 
      IndexInfo[]      		getIndexInfo(java.lang.Class<S> storableType) +
      Returns information about the known indexes for the given storable + type.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getIndexInfo

        +
        <S extends Storable> IndexInfo[] getIndexInfo(java.lang.Class<S> storableType)
+                         throws RepositoryException
        +
        Returns information about the known indexes for the given storable + type. The array might be empty, but it is never null. The array is a + copy, and so it may be safely modified.
        +
        Throws:
        +
        RepositoryException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Call.html b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Call.html new file mode 100644 index 0000000..f4dd965 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Call.html @@ -0,0 +1,383 @@ + + + + + + +RemoteProcedure.Call (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface RemoteProcedure.Call<R,D>

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidexecute() +
      Executes the call without expecting a reply.
      +
      voidexecuteAsync() +
      Executes the call without expecting a reply.
      +
      Cursor<R>fetchReply() +
      Executes the call and receive a reply.
      +
      voidflush() +
      Flushes all the data sent so far.
      +
      RemoteProcedure.Call<R,D>reset() +
      Reset the internal object stream of the call, allowing cached + objects to get freed.
      +
      RemoteProcedure.Call<R,D>send(D data) +
      Send data to the remote procedure.
      +
      RemoteProcedure.Call<R,D>sendAll(Cursor<? extends D> cursor) +
      Send all data from the given cursor to the remote procedure.
      +
      RemoteProcedure.Call<R,D>sendAll(java.lang.Iterable<? extends D> iterable) +
      Send all data from the given iterable to the remote procedure.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + + + +
        +
      • +

        sendAll

        +
        RemoteProcedure.Call<R,D> sendAll(java.lang.Iterable<? extends D> iterable)
+                                  throws RepositoryException
        +
        Send all data from the given iterable to the remote procedure.
        +
        Returns:
        this Call instance
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if data is null
        +
        java.lang.IllegalStateException - if a call has been executed
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        sendAll

        +
        RemoteProcedure.Call<R,D> sendAll(Cursor<? extends D> cursor)
+                                  throws RepositoryException
        +
        Send all data from the given cursor to the remote procedure.
        +
        Returns:
        this Call instance
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if data is null
        +
        java.lang.IllegalStateException - if a call has been executed
        +
        RepositoryException
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        fetchReply

        +
        Cursor<R> fetchReply()
+                     throws RepositoryException
        +
        Executes the call and receive a reply. Calling this method does not + block, but methods on the returned Cursor may block waiting for + data.
        +
        Throws:
        +
        java.lang.IllegalStateException - if a call has been executed
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        execute

        +
        void execute()
+             throws RepositoryException
        +
        Executes the call without expecting a reply. Method blocks waiting + for procedure to finish.
        +
        Throws:
        +
        java.lang.IllegalStateException - if a call has been executed
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        executeAsync

        +
        void executeAsync()
+                  throws RepositoryException
        +
        Executes the call without expecting a reply. Method does not block + waiting for procedure to finish. Asynchronous execution is not + allowed if the current thread is in a transaction. This is because + transaction ownership becomes ambiguous.
        +
        Throws:
        +
        java.lang.IllegalStateException - if a call has been executed or if + current thread is in a transaction
        +
        RepositoryException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Reply.html b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Reply.html new file mode 100644 index 0000000..5f140a1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Reply.html @@ -0,0 +1,330 @@ + + + + + + +RemoteProcedure.Reply (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface RemoteProcedure.Reply<R>

+
+
+
+
    +
  • +
    Type Parameters:
    R - reply object type
    +
    +
    Enclosing interface:
    +
    RemoteProcedure<R,D>
    +
    +
    +
    +
    public static interface RemoteProcedure.Reply<R>
    +
    Reply from remote procedure implementation. To avoid leaking resources, + the finish method must always be invoked. If an exception is thrown by a + method defined in this interface, resources are automatically released.
    +
    • +
+
+
+
    +
  • + + +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html new file mode 100644 index 0000000..04a63b8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html @@ -0,0 +1,288 @@ + + + + + + +RemoteProcedure.Request (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface RemoteProcedure.Request<R,D>

+
+
+
+
    +
  • +
    Type Parameters:
    R - reply object type
    D - request data object type
    +
    +
    Enclosing interface:
    +
    RemoteProcedure<R,D>
    +
    +
    +
    +
    public static interface RemoteProcedure.Request<R,D>
    +
    Request into a remote procedure, as seen by procedure implementation. To + avoid leaking resources, the request or reply object must always be + finished. If an exception is thrown by a method defined in this + interface, resources are automatically released.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      RemoteProcedure.Reply<R>beginReply() +
      Begin a reply after receiving all data.
      +
      voidfinish() +
      Reply and immediately finish, without sending any data to caller.
      +
      Dreceive() +
      Receive data from caller.
      +
      intreceiveInto(java.util.Collection<? super D> c) +
      Receive all remaining data from caller.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        receiveInto

        +
        int receiveInto(java.util.Collection<? super D> c)
+                throws RepositoryException
        +
        Receive all remaining data from caller.
        +
        Parameters:
        c - collection to receive data
        +
        Returns:
        amount received
        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        beginReply

        +
        RemoteProcedure.Reply<R> beginReply()
+                                    throws RepositoryException
        +
        Begin a reply after receiving all data. If no data is expected, + reply can be made without calling receive.
        +
        Throws:
        +
        java.lang.IllegalStateException - if reply was already begun, or if + request is finished, or if more data must be received
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        finish

        +
        void finish()
+            throws RepositoryException
        +
        Reply and immediately finish, without sending any data to caller.
        +
        Throws:
        +
        java.lang.IllegalStateException - if a reply was already begun or if + more data must be received
        +
        RepositoryException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/capability/RemoteProcedure.html b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.html new file mode 100644 index 0000000..4b64cbb --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.html @@ -0,0 +1,268 @@ + + + + + + +RemoteProcedure (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface RemoteProcedure<R,D>

+
+
+
+
    +
  • +
    Type Parameters:
    R - reply object type
    D - request data object type
    +
    +
    All Superinterfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public interface RemoteProcedure<R,D>
+extends java.io.Serializable
    +
    Defines a remote procedure which can be executed by RemoteProcedureCapability. Any data within the procedure instance is + serialized to the remote host, and possibly the class definition + too. Execution might have security restrictions applied. + +

    The RemoteProcedure instance is Serializable, and so any serializable + parameters can be passed with it. Storables and extra data can be sent + through the RemoteProcedure.Request object. Any data returned by procedure + implementation must be sent through the RemoteProcedure.Reply object.

    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeInterface and Description
      static interface RemoteProcedure.Call<R,D> +
      Client-side call into a remote procedure.
      +
      static interface RemoteProcedure.Reply<R> +
      Reply from remote procedure implementation.
      +
      static interface RemoteProcedure.Request<R,D> +
      Request into a remote procedure, as seen by procedure implementation.
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        handleRequest

        +
        boolean handleRequest(Repository repo,
+                    RemoteProcedure.Request<R,D> request)
+                      throws RepositoryException
        +
        Request handler for remote procedure implementation.
        +
        Parameters:
        repo - repository as seen by host that procedure is running from
        request - non-null request object
        +
        Returns:
        false if request is still active when this method returns; + request must eventually be explicitly finished
        +
        Throws:
        +
        RepositoryException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/capability/RemoteProcedureCapability.html b/apidocs/com/amazon/carbonado/capability/RemoteProcedureCapability.html new file mode 100644 index 0000000..141e802 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/RemoteProcedureCapability.html @@ -0,0 +1,237 @@ + + + + + + +RemoteProcedureCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface RemoteProcedureCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface RemoteProcedureCapability
+extends Capability
    +
    Capability which allows arbitrary code to run on a remote host and access + its repository. The remote procedure might have security restrictions + applied to it. + +

    Examples:

    + RemoteProcedureCapability cap = ...
+ Cursor<MyRecord> c1 = cap.beginCall(new CustomQuery<MyRecord>(params)).fetchReply();
+ ...
+
+ Cursor<InputRecord> c2 = ...
+ cap.beginCall(new Importer<InputRecord>()).sendAll(c2).finish();
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    RemoteProcedure
    +
    • +
+
+
+
    +
  • + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        beginCall

        +
        <R,D> RemoteProcedure.Call<R,D> beginCall(RemoteProcedure<R,D> proc)
+                                    throws RepositoryException
        +
        Begins a call to execute the given procedure on a remote host. + Execution commences when the Call object is instructed to do so.
        +
        Type Parameters:
        R - reply object type
        D - request data object type
        Parameters:
        proc - procedure to execute
        +
        Returns:
        object for defining the call and receiving a reply
        +
        Throws:
        +
        RepositoryException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/capability/ResyncCapability.Listener.html b/apidocs/com/amazon/carbonado/capability/ResyncCapability.Listener.html new file mode 100644 index 0000000..b82045d --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/ResyncCapability.Listener.html @@ -0,0 +1,561 @@ + + + + + + +ResyncCapability.Listener (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Class ResyncCapability.Listener<S>

+
+
+ +
+
    +
  • +
    +
    Enclosing interface:
    +
    ResyncCapability
    +
    +
    +
    +
    public static class ResyncCapability.Listener<S>
+extends Trigger<S>
    +
    Trigger which is invoked as storables get re-sync'd. Callbacks are + invoked in the scope of the resync transaction. If any unchecked + exception is thrown, the immediate changes are rolled back and the + entire repository resync operation is aborted. + +

    The listener implementation should return quickly from the callback + methods, to avoid lingering transactions. If the listener is used to + invoke special repair operations, they should be placed into a task + queue. A separate thread can then perform the repairs outside the resync + transaction.

    +
    • +
+
+
+
    +
  • + + + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidafterDelete(S oldStorable, + java.lang.Object state) +
      Called right after a bogus storable has been successfully deleted.
      +
      voidafterInsert(S newStorable, + java.lang.Object state) +
      Called right after a sync'd storable has been successfully inserted.
      +
      voidafterUpdate(S newStorable, + java.lang.Object state) +
      Called right after a sync'd storable has been successfully updated.
      +
      java.lang.ObjectbeforeDelete(S oldStorable) +
      Called before a bogus storable is to be deleted.
      +
      java.lang.ObjectbeforeInsert(S newStorable) +
      Called before a sync'd storable is to be inserted.
      +
      java.lang.ObjectbeforeUpdate(S newStorable) +
      Called before a sync'd storable is to be updated.
      +
      java.lang.ObjectbeforeUpdate(S oldStorable, + S newStorable) +
      Overloaded version of beforeUpdate method which is passed the + storable in it's out-of-sync and sync'd states.
      +
      voidfailedDelete(S oldStorable, + java.lang.Object state) +
      Called when a delete operation failed because an exception was + thrown.
      +
      voidfailedInsert(S newStorable, + java.lang.Object state) +
      Called when an insert operation failed because an exception was + thrown.
      +
      voidfailedUpdate(S newStorable, + java.lang.Object state) +
      Called when an update operation failed because an exception was + thrown.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ResyncCapability.Listener

        +
        public ResyncCapability.Listener()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        beforeInsert

        +
        public java.lang.Object beforeInsert(S newStorable)
+                              throws PersistException
        +
        Called before a sync'd storable is to be inserted. Changes can be + made to the storable at this point, possibly to define independent + properties.
        +
        +
        Overrides:
        +
        beforeInsert in class Trigger<S>
        +
        Parameters:
        newStorable - sync'd storable before being inserted
        +
        Returns:
        arbitrary state object, passed to afterInsert or failedInsert method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        afterInsert

        +
        public void afterInsert(S newStorable,
+               java.lang.Object state)
+                 throws PersistException
        +
        Called right after a sync'd storable has been successfully inserted.
        +
        +
        Overrides:
        +
        afterInsert in class Trigger<S>
        +
        Parameters:
        newStorable - sync'd storable after being inserted
        state - object returned by beforeInsert method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        failedInsert

        +
        public void failedInsert(S newStorable,
+                java.lang.Object state)
        +
        Called when an insert operation failed because an exception was + thrown. The main purpose of this method is to allow any necessary + clean-up to occur on the optional state object.
        +
        +
        Overrides:
        +
        failedInsert in class Trigger<S>
        +
        Parameters:
        newStorable - sync'd storable which failed to be inserted
        state - object returned by beforeInsert method, but it may be null
        +
        • +
      + + + + + +
        +
      • +

        beforeUpdate

        +
        public java.lang.Object beforeUpdate(S newStorable)
+                              throws PersistException
        +
        Called before a sync'd storable is to be updated. Changes can be + made to the storable at this point, possibly to update independent + properties.
        +
        +
        Overrides:
        +
        beforeUpdate in class Trigger<S>
        +
        Parameters:
        newStorable - sync'd storable before being updated
        +
        Returns:
        arbitrary state object, passed to afterUpdate or failedUpdate method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        beforeUpdate

        +
        public java.lang.Object beforeUpdate(S oldStorable,
+                            S newStorable)
+                              throws PersistException
        +
        Overloaded version of beforeUpdate method which is passed the + storable in it's out-of-sync and sync'd states. Changes can be made + to the storable at this point, possibly to update independent + properties. + +

        The default implementation calls the single argument beforeUpdate + method, only passing the newly sync'd storable.

        +
        Parameters:
        oldStorable - storable prior to being sync'd
        newStorable - sync'd storable before being updated
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        afterUpdate

        +
        public void afterUpdate(S newStorable,
+               java.lang.Object state)
+                 throws PersistException
        +
        Called right after a sync'd storable has been successfully updated.
        +
        +
        Overrides:
        +
        afterUpdate in class Trigger<S>
        +
        Parameters:
        newStorable - sync'd storable after being updated
        state - optional object returned by beforeUpdate method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        failedUpdate

        +
        public void failedUpdate(S newStorable,
+                java.lang.Object state)
        +
        Called when an update operation failed because an exception was + thrown. The main purpose of this method is to allow any necessary + clean-up to occur on the optional state object.
        +
        +
        Overrides:
        +
        failedUpdate in class Trigger<S>
        +
        Parameters:
        newStorable - sync'd storable which failed to be updated
        state - object returned by beforeUpdate method, but it may be null
        +
        • +
      + + + + + +
        +
      • +

        beforeDelete

        +
        public java.lang.Object beforeDelete(S oldStorable)
+                              throws PersistException
        +
        Called before a bogus storable is to be deleted.
        +
        +
        Overrides:
        +
        beforeDelete in class Trigger<S>
        +
        Parameters:
        oldStorable - bogus storable before being deleted
        +
        Returns:
        arbitrary state object, passed to afterDelete or failedDelete method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        afterDelete

        +
        public void afterDelete(S oldStorable,
+               java.lang.Object state)
+                 throws PersistException
        +
        Called right after a bogus storable has been successfully deleted.
        +
        +
        Overrides:
        +
        afterDelete in class Trigger<S>
        +
        Parameters:
        oldStorable - bogus storable after being deleted
        state - optional object returned by beforeDelete method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        failedDelete

        +
        public void failedDelete(S oldStorable,
+                java.lang.Object state)
        +
        Called when a delete operation failed because an exception was + thrown. The main purpose of this method is to allow any necessary + clean-up to occur on the optional state object.
        +
        +
        Overrides:
        +
        failedDelete in class Trigger<S>
        +
        Parameters:
        oldStorable - bogus storable which failed to be deleted
        state - object returned by beforeDelete method, but it may be null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/capability/ResyncCapability.html b/apidocs/com/amazon/carbonado/capability/ResyncCapability.html new file mode 100644 index 0000000..9233805 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/ResyncCapability.html @@ -0,0 +1,300 @@ + + + + + + +ResyncCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface ResyncCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface ResyncCapability
+extends Capability
    +
    Capability of replicating repositories for re-synchronizing to the master + repository. A re-sync operation can be used to fill up a fresh replication + repository or to repair inconsistencies.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeInterface and Description
      static class ResyncCapability.Listener<S> +
      Trigger which is invoked as storables get re-sync'd.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      RepositorygetMasterRepository() +
      Returns the immediate master Repository, for manual comparison.
      +
      <S extends Storable> 
      void      		resync(java.lang.Class<S> type, + double desiredSpeed, + java.lang.String filter, + java.lang.Object... filterValues) +
      Re-synchronizes replicated storables against the master repository.
      +
      <S extends Storable> 
      void      		resync(java.lang.Class<S> type, + ResyncCapability.Listener<? super S> listener, + double desiredSpeed, + java.lang.String filter, + java.lang.Object... filterValues) +
      Re-synchronizes replicated storables against the master repository.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        resync

        +
        <S extends Storable> void resync(java.lang.Class<S> type,
+                               double desiredSpeed,
+                               java.lang.String filter,
+                               java.lang.Object... filterValues)
+            throws RepositoryException
        +
        Re-synchronizes replicated storables against the master repository.
        +
        Parameters:
        type - type of storable to re-sync
        desiredSpeed - throttling parameter - 1.0 = full speed, 0.5 = half + speed, 0.1 = one-tenth speed, etc
        filter - optional query filter to limit which objects get re-sync'ed
        filterValues - filter values for optional filter
        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        resync

        +
        <S extends Storable> void resync(java.lang.Class<S> type,
+                               ResyncCapability.Listener<? super S> listener,
+                               double desiredSpeed,
+                               java.lang.String filter,
+                               java.lang.Object... filterValues)
+            throws RepositoryException
        +
        Re-synchronizes replicated storables against the master repository.
        +
        Parameters:
        type - type of storable to re-sync
        listener - optional listener which gets notified as storables are re-sync'd
        desiredSpeed - throttling parameter - 1.0 = full speed, 0.5 = half + speed, 0.1 = one-tenth speed, etc
        filter - optional query filter to limit which objects get re-sync'ed
        filterValues - filter values for optional filter
        +
        Throws:
        +
        RepositoryException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getMasterRepository

        +
        Repository getMasterRepository()
        +
        Returns the immediate master Repository, for manual comparison. Direct + updates to the master will likely create inconsistencies.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/capability/ShutdownCapability.html b/apidocs/com/amazon/carbonado/capability/ShutdownCapability.html new file mode 100644 index 0000000..278f1da --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/ShutdownCapability.html @@ -0,0 +1,277 @@ + + + + + + +ShutdownCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface ShutdownCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    All Known Implementing Classes:
    +
    AbstractRepository
    +
    +
    +
    +
    public interface ShutdownCapability
+extends Capability
    +
    Capability for repositories that require special attention with the Java + virtual machine exits.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanisAutoShutdownEnabled() +
      Returns true if repository has a shutdown hook registered to + automatically call shutdown when the virtual machine exits.
      +
      voidsetAutoShutdownEnabled(boolean enabled) +
      Request to enable or disable the automatic shutdown hook.
      +
      voidshutdown() +
      Similar to calling close on a repository, except should only be called + when the virtual machine is in the process of shutting down.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isAutoShutdownEnabled

        +
        boolean isAutoShutdownEnabled()
        +
        Returns true if repository has a shutdown hook registered to + automatically call shutdown when the virtual machine exits.
        +
        • +
      + + + +
        +
      • +

        setAutoShutdownEnabled

        +
        void setAutoShutdownEnabled(boolean enabled)
        +
        Request to enable or disable the automatic shutdown hook. Repository may + ignore this request if shutdown is in progress.
        +
        Throws:
        +
        java.lang.SecurityException - if caller does not have permission
        +
        • +
      + + + +
        +
      • +

        shutdown

        +
        void shutdown()
        +
        Similar to calling close on a repository, except should only be called + when the virtual machine is in the process of shutting down. Calling + close may cause spurious exceptions to be thrown by other threads which + may be interacting with the repository. Shutdown tries to reduce these + exceptions from being thrown by effectively suspending any + threads which continue to interact with this repository. For this + reason, this method should only ever be called during a virtual machine + shutdown. + +

        Repositories may choose to implement this method by simply calling + close. There is no guarantee that shutdown will reduce exceptions, and + it might not suspend any threads. Also, repositories that require proper + shutdown should automatically register runtime hooks, and so this method + usually doesn't need to be called manually.

        +
        Throws:
        +
        java.lang.SecurityException - if caller does not have permission
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/capability/StorableInfoCapability.html b/apidocs/com/amazon/carbonado/capability/StorableInfoCapability.html new file mode 100644 index 0000000..2e7263e --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/StorableInfoCapability.html @@ -0,0 +1,265 @@ + + + + + + +StorableInfoCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface StorableInfoCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface StorableInfoCapability
+extends Capability
    +
    Capability that returns information about known storable types in a + repository.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.String[]getUserStorableTypeNames() +
      Returns an array of storable type class names for user-level storables + known to the repository.
      +
      booleanisPropertySupported(java.lang.Class<Storable> type, + java.lang.String name) +
      Returns true if the given property exists and is supported.
      +
      booleanisSupported(java.lang.Class<Storable> type) +
      Returns true if the given storable type is supported.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getUserStorableTypeNames

        +
        java.lang.String[] getUserStorableTypeNames()
+                                            throws RepositoryException
        +
        Returns an array of storable type class names for user-level storables + known to the repository. The array might be empty, but it is never + null. The array is a copy, and so it may be safely modified. +

        + This method returns class names instead of class instances because the + repository may not be able to load the classes.

        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        isSupported

        +
        boolean isSupported(java.lang.Class<Storable> type)
        +
        Returns true if the given storable type is supported.
        +
        Parameters:
        type - storable type to examine
        +
        • +
      + + + +
        +
      • +

        isPropertySupported

        +
        boolean isPropertySupported(java.lang.Class<Storable> type,
+                          java.lang.String name)
        +
        Returns true if the given property exists and is supported.
        +
        Parameters:
        type - storable type to examine
        name - name of property to examine
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

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

Uses of Interface
com.amazon.carbonado.capability.Capability

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

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

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

Uses of Interface
com.amazon.carbonado.capability.GroupAccessCapability

+
+
No usage of com.amazon.carbonado.capability.GroupAccessCapability
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Interface
com.amazon.carbonado.capability.GroupMembers

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/capability/class-use/IndexInfo.html b/apidocs/com/amazon/carbonado/capability/class-use/IndexInfo.html new file mode 100644 index 0000000..08d3155 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/IndexInfo.html @@ -0,0 +1,266 @@ + + + + + + +Uses of Interface com.amazon.carbonado.capability.IndexInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.capability.IndexInfo

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

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

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

Uses of Interface
com.amazon.carbonado.capability.IndexInfoCapability

+
+
No usage of com.amazon.carbonado.capability.IndexInfoCapability
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Call.html b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Call.html new file mode 100644 index 0000000..f245205 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Call.html @@ -0,0 +1,186 @@ + + + + + + +Uses of Interface com.amazon.carbonado.capability.RemoteProcedure.Call (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.capability.RemoteProcedure.Call

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Reply.html b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Reply.html new file mode 100644 index 0000000..10f2da8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Reply.html @@ -0,0 +1,186 @@ + + + + + + +Uses of Interface com.amazon.carbonado.capability.RemoteProcedure.Reply (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.capability.RemoteProcedure.Reply

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

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

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

Uses of Interface
com.amazon.carbonado.capability.RemoteProcedure.Request

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

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

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

Uses of Interface
com.amazon.carbonado.capability.RemoteProcedure

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

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

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

Uses of Interface
com.amazon.carbonado.capability.RemoteProcedureCapability

+
+
No usage of com.amazon.carbonado.capability.RemoteProcedureCapability
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.Listener.html b/apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.Listener.html new file mode 100644 index 0000000..ab27e14 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.Listener.html @@ -0,0 +1,165 @@ + + + + + + +Uses of Class com.amazon.carbonado.capability.ResyncCapability.Listener (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.capability.ResyncCapability.Listener

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

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

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

Uses of Interface
com.amazon.carbonado.capability.ResyncCapability

+
+
No usage of com.amazon.carbonado.capability.ResyncCapability
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/capability/class-use/ShutdownCapability.html b/apidocs/com/amazon/carbonado/capability/class-use/ShutdownCapability.html new file mode 100644 index 0000000..5b8e69b --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/ShutdownCapability.html @@ -0,0 +1,161 @@ + + + + + + +Uses of Interface com.amazon.carbonado.capability.ShutdownCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.capability.ShutdownCapability

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

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

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

Uses of Interface
com.amazon.carbonado.capability.StorableInfoCapability

+
+
No usage of com.amazon.carbonado.capability.StorableInfoCapability
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/capability/package-frame.html b/apidocs/com/amazon/carbonado/capability/package-frame.html new file mode 100644 index 0000000..4891a36 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/package-frame.html @@ -0,0 +1,36 @@ + + + + + + +com.amazon.carbonado.capability (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.capability

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/capability/package-summary.html b/apidocs/com/amazon/carbonado/capability/package-summary.html new file mode 100644 index 0000000..af0b7c6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/package-summary.html @@ -0,0 +1,238 @@ + + + + + + +com.amazon.carbonado.capability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.capability

+
+
Common capabilities for repositories.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.capability Description

+
Common capabilities for repositories.
+
See Also:
Repository.getCapability(java.lang.Class<C>)
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/capability/package-tree.html b/apidocs/com/amazon/carbonado/capability/package-tree.html new file mode 100644 index 0000000..94bd294 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/package-tree.html @@ -0,0 +1,157 @@ + + + + + + +com.amazon.carbonado.capability Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.capability

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/capability/package-use.html b/apidocs/com/amazon/carbonado/capability/package-use.html new file mode 100644 index 0000000..30c510b --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/package-use.html @@ -0,0 +1,420 @@ + + + + + + +Uses of Package com.amazon.carbonado.capability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.capability

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

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

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

Uses of Class
com.amazon.carbonado.Alias

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

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

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

Uses of Class
com.amazon.carbonado.AlternateKeys

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

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

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

Uses of Class
com.amazon.carbonado.Authoritative

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

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

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

Uses of Class
com.amazon.carbonado.Automatic

+
+
No usage of com.amazon.carbonado.Automatic
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.ConfigurationException

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

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

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

Uses of Class
com.amazon.carbonado.ConstraintException

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

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

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

Uses of Class
com.amazon.carbonado.CorruptEncodingException

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

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

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

Uses of Interface
com.amazon.carbonado.Cursor

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

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

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

Uses of Class
com.amazon.carbonado.Derived

+
+
No usage of com.amazon.carbonado.Derived
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.FetchDeadlockException

+
+
No usage of com.amazon.carbonado.FetchDeadlockException
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.FetchException

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

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

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

Uses of Class
com.amazon.carbonado.FetchInterruptedException

+
+
No usage of com.amazon.carbonado.FetchInterruptedException
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.FetchMultipleException

+
+
No usage of com.amazon.carbonado.FetchMultipleException
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.FetchNoneException

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

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

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

Uses of Class
com.amazon.carbonado.FetchTimeoutException

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

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

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

Uses of Class
com.amazon.carbonado.Independent

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

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

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

Uses of Class
com.amazon.carbonado.Index

+
+
No usage of com.amazon.carbonado.Index
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.Indexes

+
+
No usage of com.amazon.carbonado.Indexes
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.IsolationLevel

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

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

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

Uses of Class
com.amazon.carbonado.Join

+
+
No usage of com.amazon.carbonado.Join
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.Key

+
+
No usage of com.amazon.carbonado.Key
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.MalformedArgumentException

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

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

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

Uses of Class
com.amazon.carbonado.MalformedFilterException

+
+
No usage of com.amazon.carbonado.MalformedFilterException
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.MalformedTypeException

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

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

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

Uses of Class
com.amazon.carbonado.MismatchException

+
+
No usage of com.amazon.carbonado.MismatchException
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.Name

+
+
No usage of com.amazon.carbonado.Name
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.NonDurableCommitException

+
+
No usage of com.amazon.carbonado.NonDurableCommitException
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.Nullable

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

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

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

Uses of Class
com.amazon.carbonado.OptimisticLockException

+
+
No usage of com.amazon.carbonado.OptimisticLockException
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.PartitionKey

+
+
No usage of com.amazon.carbonado.PartitionKey
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.PersistDeadlockException

+
+
No usage of com.amazon.carbonado.PersistDeadlockException
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.PersistDeniedException

+
+
No usage of com.amazon.carbonado.PersistDeniedException
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.PersistException

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

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

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

Uses of Class
com.amazon.carbonado.PersistInterruptedException

+
+
No usage of com.amazon.carbonado.PersistInterruptedException
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.PersistMultipleException

+
+
No usage of com.amazon.carbonado.PersistMultipleException
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.PersistNoneException

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

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

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

Uses of Class
com.amazon.carbonado.PersistTimeoutException

+
+
No usage of com.amazon.carbonado.PersistTimeoutException
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.PrimaryKey

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/class-use/Query.Controller.html b/apidocs/com/amazon/carbonado/class-use/Query.Controller.html new file mode 100644 index 0000000..35e244f --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Query.Controller.html @@ -0,0 +1,559 @@ + + + + + + +Uses of Interface com.amazon.carbonado.Query.Controller (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.Query.Controller

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/class-use/Query.Timeout.html b/apidocs/com/amazon/carbonado/class-use/Query.Timeout.html new file mode 100644 index 0000000..5e8a6a9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Query.Timeout.html @@ -0,0 +1,191 @@ + + + + + + +Uses of Class com.amazon.carbonado.Query.Timeout (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.Query.Timeout

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

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

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

Uses of Interface
com.amazon.carbonado.Query

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

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

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

Uses of Interface
com.amazon.carbonado.Repository

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

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

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

Uses of Interface
com.amazon.carbonado.RepositoryBuilder

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

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

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

Uses of Class
com.amazon.carbonado.RepositoryException

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

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

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

Uses of Class
com.amazon.carbonado.Sequence

+
+
No usage of com.amazon.carbonado.Sequence
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Interface
com.amazon.carbonado.Storable

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

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

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

Uses of Interface
com.amazon.carbonado.Storage

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

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

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

Uses of Class
com.amazon.carbonado.SupportException

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

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

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

Uses of Interface
com.amazon.carbonado.Transaction

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/class-use/Trigger.Abort.html b/apidocs/com/amazon/carbonado/class-use/Trigger.Abort.html new file mode 100644 index 0000000..2dff17c --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Trigger.Abort.html @@ -0,0 +1,184 @@ + + + + + + +Uses of Class com.amazon.carbonado.Trigger.Abort (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.Trigger.Abort

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

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

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

Uses of Class
com.amazon.carbonado.Trigger

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

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

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

Uses of Interface
com.amazon.carbonado.TriggerFactory

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

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

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

Uses of Class
com.amazon.carbonado.UniqueConstraintException

+
+
No usage of com.amazon.carbonado.UniqueConstraintException
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.UnsupportedTypeException

+
+
No usage of com.amazon.carbonado.UnsupportedTypeException
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.Version

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/ConstraintDefinition.html b/apidocs/com/amazon/carbonado/constraint/ConstraintDefinition.html new file mode 100644 index 0000000..0b5234b --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/ConstraintDefinition.html @@ -0,0 +1,288 @@ + + + + + + +ConstraintDefinition (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.constraint
+

Annotation Type ConstraintDefinition

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=ANNOTATION_TYPE)
+public @interface ConstraintDefinition
    +
    Allows annotations to be defined that restrict property values. The + annotation is just a pointer to a constraint checking class. If the + constraint class is not explicitly provided, it defaults to a static inner + class named "Constraint" in the annotation itself. + +

    The constraint class must have a public constructor that accepts the + annotation that has the ConstraintDefinition annotation. It must also define + several "constrain" methods which perform constraint checks on specific + property types. +

    + Example integer constraint: + 

    + @Documented
+ @Retention(RetentionPolicy.RUNTIME)
+ @Target(ElementType.METHOD)
+ @ConstraintDefinition
+ public @interface IntegerConstraint {
+     int min() default Integer.MIN_VALUE;
+
+     int max() default Integer.MAX_VALUE;
+
+     public static class Constraint {
+         private final String propertyName;
+         private final int min;
+         private final int max;
+
+         // Constructor may throw a MalformedTypeException if
+         // params supplied by annotation are illegal.
+
+         /**
+          * @param type optional type of object that contains the constrained property
+          * @param propertyName name of property with constraint
+          * @param annotation specific annotation that binds to this constraint class
+          */
+         public Constraint(Class type, String propertyName, IntegerConstraint annotation) {
+             this.propertyName = propertyName;
+             this.min = annotation.min();
+             this.max = annotation.max();
+         }
+
+         // Define a constrain method for each supported property type.
+
+         /**
+          * @param propertyValue specific value to constrain
+          */
+         public void constrain(int propertyValue) throws IllegalArgumentException {
+             if (propertyValue < min || propertyValue > max) {
+                 throw new IllegalArgumentException
+                     ("Value for \"" + propertyName + "\" must be in range " +
+                      min + ".." + max + ": " + propertyValue);
+             }
+         }
+     }
+ }
+
    + + The newly defined integer constraint can be applied to property mutators. + + 
    + public interface UserInfo extends Storable {
+     ...
+
+     int getAge();
+     // Constraint is called before setting age.
+     @IntegerConstraint(min=0, max=120)
+     void setAge(int value);
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.Classimplementation +
      Specify class which will perform constraint checking.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        implementation

        +
        public abstract java.lang.Class implementation
        +
        Specify class which will perform constraint checking. Must have a public + constructor with the signature + (Class type, String propertyName, Annotation), + where Annotation refers to the annotation with the + constraint definition. + +

        The implementation class need not be explicitly specified. By + default, the constraint class must be a static inner class of the + annotation, named "Constraint".

        +
        +
        Default:
        +
        void.class
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/FloatConstraint.Constraint.html b/apidocs/com/amazon/carbonado/constraint/FloatConstraint.Constraint.html new file mode 100644 index 0000000..2ec9cdf --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/FloatConstraint.Constraint.html @@ -0,0 +1,330 @@ + + + + + + +FloatConstraint.Constraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.constraint
+

Class FloatConstraint.Constraint

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    FloatConstraint
    +
    +
    +
    +
    public static class FloatConstraint.Constraint
+extends java.lang.Object
    +
    Constraint implementation for FloatConstraint.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      FloatConstraint.Constraint(java.lang.Class<?> type, + java.lang.String propertyName, + double min, + double max, + double[] allowed, + double[] disallowed) 
      FloatConstraint.Constraint(java.lang.Class<?> type, + java.lang.String propertyName, + FloatConstraint ann) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidconstrain(char propertyValue) 
      voidconstrain(char[] propertyValue) 
      voidconstrain(java.lang.CharSequence propertyValue) 
      voidconstrain(double propertyValue) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FloatConstraint.Constraint

        +
        public FloatConstraint.Constraint(java.lang.Class<?> type,
+                          java.lang.String propertyName,
+                          FloatConstraint ann)
        +
        Parameters:
        type - type of object that contains the constrained property
        propertyName - name of property with constraint
        ann - specific annotation that binds to this constraint class
        +
        • +
      + + + +
        +
      • +

        FloatConstraint.Constraint

        +
        public FloatConstraint.Constraint(java.lang.Class<?> type,
+                          java.lang.String propertyName,
+                          double min,
+                          double max,
+                          double[] allowed,
+                          double[] disallowed)
        +
        Parameters:
        type - type of object that contains the constrained property
        propertyName - name of property with constraint
        min - minimum allowed value
        max - maximum allowed value
        allowed - optional set of allowed values
        disallowed - optional set of disallowed values
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        constrain

        +
        public void constrain(double propertyValue)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(java.lang.CharSequence propertyValue)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(char propertyValue)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(char[] propertyValue)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/FloatConstraint.html b/apidocs/com/amazon/carbonado/constraint/FloatConstraint.html new file mode 100644 index 0000000..2df53d5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/FloatConstraint.html @@ -0,0 +1,289 @@ + + + + + + +FloatConstraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.constraint
+

Annotation Type FloatConstraint

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+@ConstraintDefinition
+public @interface FloatConstraint
    +
    Limits the value of a property to be a member of a specific set. The + property value may be a boxed or unboxed float, double, String, + CharSequence, char, Character, or character array. If the property value is + outside the set, an IllegalArgumentException is thrown. + +

    Example:

    + public interface PolarCoordinate extends Storable {
+     double getTheta();
+     @FloatConstraint(min=0, max=Math.PI * 2, disallowed=Double.NaN)
+     void setTheta(double radians);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    IntegerConstraint, +TextConstraint
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      double[]allowed +
      Specific allowed values for property.
      +
      double[]disallowed +
      Specific disallowed values for property.
      +
      doublemax +
      Specify maximum allowed value for float/double property.
      +
      doublemin +
      Specify minimum allowed value for float/double property.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        allowed

        +
        public abstract double[] allowed
        +
        Specific allowed values for property. Default is unlimited.
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      + + + +
        +
      • +

        disallowed

        +
        public abstract double[] disallowed
        +
        Specific disallowed values for property. Default is none.
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      + + + +
        +
      • +

        min

        +
        public abstract double min
        +
        Specify minimum allowed value for float/double property. Default is unlimited.
        +
        +
        Default:
        +
        -1d/0d
        +
        +
        • +
      + + + +
        +
      • +

        max

        +
        public abstract double max
        +
        Specify maximum allowed value for float/double property. Default is unlimited.
        +
        +
        Default:
        +
        1d/0d
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html b/apidocs/com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html new file mode 100644 index 0000000..a5baafb --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html @@ -0,0 +1,343 @@ + + + + + + +IntegerConstraint.Constraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.constraint
+

Class IntegerConstraint.Constraint

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    IntegerConstraint
    +
    +
    +
    +
    public static class IntegerConstraint.Constraint
+extends java.lang.Object
    +
    Constraint implementation for IntegerConstraint.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidconstrain(char propertyValue) 
      voidconstrain(char[] propertyValue) 
      voidconstrain(java.lang.CharSequence propertyValue) 
      voidconstrain(double propertyValue) 
      voidconstrain(long propertyValue) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        IntegerConstraint.Constraint

        +
        public IntegerConstraint.Constraint(java.lang.Class<?> type,
+                            java.lang.String propertyName,
+                            IntegerConstraint ann)
        +
        Parameters:
        type - type of object that contains the constrained property
        propertyName - name of property with constraint
        ann - specific annotation that binds to this constraint class
        +
        • +
      + + + +
        +
      • +

        IntegerConstraint.Constraint

        +
        public IntegerConstraint.Constraint(java.lang.Class<?> type,
+                            java.lang.String propertyName,
+                            long min,
+                            long max,
+                            long[] allowed,
+                            long[] disallowed)
        +
        Parameters:
        type - type of object that contains the constrained property
        propertyName - name of property with constraint
        min - minimum allowed value
        max - maximum allowed value
        allowed - optional set of allowed values
        disallowed - optional set of disallowed values
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        constrain

        +
        public void constrain(long propertyValue)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(double propertyValue)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(java.lang.CharSequence propertyValue)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(char propertyValue)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(char[] propertyValue)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/IntegerConstraint.html b/apidocs/com/amazon/carbonado/constraint/IntegerConstraint.html new file mode 100644 index 0000000..eee9195 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/IntegerConstraint.html @@ -0,0 +1,293 @@ + + + + + + +IntegerConstraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.constraint
+

Annotation Type IntegerConstraint

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+@ConstraintDefinition
+public @interface IntegerConstraint
    +
    Limits the value of a property to be a member of a specific set. The + property value may be a boxed or unboxed byte, short, int, long, float, + double, String, CharSequence, char, Character, or character array. If the + property value is outside the set, an IllegalArgumentException is thrown. + +

    Example:

    + public interface UserInfo extends Storable {
+     int getAge();
+     @IntegerConstraint(min=0, max=120)
+     void setAge(int value);
+
+     int getRoleID();
+     @IntegerConstraint(allowed={ROLE_REGULAR, ROLE_ADMIN})
+     void setRoleID(int role);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    FloatConstraint, +TextConstraint
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      long[]allowed +
      Specific allowed values for property.
      +
      long[]disallowed +
      Specific disallowed values for property.
      +
      longmax +
      Specify maximum allowed value for integer property.
      +
      longmin +
      Specify minimum allowed value for integer property.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        allowed

        +
        public abstract long[] allowed
        +
        Specific allowed values for property. Default is unlimited.
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      + + + +
        +
      • +

        disallowed

        +
        public abstract long[] disallowed
        +
        Specific disallowed values for property. Default is none.
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      + + + +
        +
      • +

        min

        +
        public abstract long min
        +
        Specify minimum allowed value for integer property. Default is unlimited.
        +
        +
        Default:
        +
        -9223372036854775808L
        +
        +
        • +
      + + + +
        +
      • +

        max

        +
        public abstract long max
        +
        Specify maximum allowed value for integer property. Default is unlimited.
        +
        +
        Default:
        +
        9223372036854775807L
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/LengthConstraint.Constraint.html b/apidocs/com/amazon/carbonado/constraint/LengthConstraint.Constraint.html new file mode 100644 index 0000000..49687a5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/LengthConstraint.Constraint.html @@ -0,0 +1,404 @@ + + + + + + +LengthConstraint.Constraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.constraint
+

Class LengthConstraint.Constraint

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    LengthConstraint
    +
    +
    +
    +
    public static class LengthConstraint.Constraint
+extends java.lang.Object
    +
    Constraint implementation for LengthConstraint.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidconstrain(boolean[] array) 
      voidconstrain(byte[] array) 
      voidconstrain(char[] array) 
      voidconstrain(java.lang.CharSequence str) 
      voidconstrain(double[] array) 
      voidconstrain(float[] array) 
      voidconstrain(int[] array) 
      voidconstrain(long[] array) 
      voidconstrain(java.lang.Object[] array) 
      voidconstrain(short[] array) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LengthConstraint.Constraint

        +
        public LengthConstraint.Constraint(java.lang.Class<?> type,
+                           java.lang.String propertyName,
+                           LengthConstraint ann)
        +
        Parameters:
        type - type of object that contains the constrained property
        propertyName - name of property with constraint
        ann - specific annotation that binds to this constraint class
        +
        • +
      + + + +
        +
      • +

        LengthConstraint.Constraint

        +
        public LengthConstraint.Constraint(java.lang.Class<?> type,
+                           java.lang.String propertyName,
+                           int min,
+                           int max)
        +
        Parameters:
        type - type of object that contains the constrained property
        propertyName - name of property with constraint
        min - minimum allowed length
        max - maximum allowed length
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        constrain

        +
        public void constrain(java.lang.CharSequence str)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(boolean[] array)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(byte[] array)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(short[] array)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(char[] array)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(int[] array)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(long[] array)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(float[] array)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(double[] array)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(java.lang.Object[] array)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/LengthConstraint.html b/apidocs/com/amazon/carbonado/constraint/LengthConstraint.html new file mode 100644 index 0000000..378a28b --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/LengthConstraint.html @@ -0,0 +1,247 @@ + + + + + + +LengthConstraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.constraint
+

Annotation Type LengthConstraint

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+@ConstraintDefinition
+public @interface LengthConstraint
    +
    Limits the value of a property to lie within a specific length range. The + property value may be a String, CharSequence, or any kind of array. If the + set property length is outside the range, an IllegalArgumentException is + thrown. + +

    Example:

    + public interface UserInfo extends Storable {
+     String getFirstName();
+     @LengthConstraint(min=1, max=50)
+     void setFirstName(String name);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      intmax +
      Specify maximum allowed length for property.
      +
      intmin +
      Specify minimum allowed length for property.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        min

        +
        public abstract int min
        +
        Specify minimum allowed length for property. Default is zero.
        +
        +
        Default:
        +
        0
        +
        +
        • +
      + + + +
        +
      • +

        max

        +
        public abstract int max
        +
        Specify maximum allowed length for property. Default is unlimited.
        +
        +
        Default:
        +
        2147483647
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/TextConstraint.Constraint.html b/apidocs/com/amazon/carbonado/constraint/TextConstraint.Constraint.html new file mode 100644 index 0000000..3b005f0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/TextConstraint.Constraint.html @@ -0,0 +1,326 @@ + + + + + + +TextConstraint.Constraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.constraint
+

Class TextConstraint.Constraint

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    TextConstraint
    +
    +
    +
    +
    public static class TextConstraint.Constraint
+extends java.lang.Object
    +
    Constraint implementation for TextConstraint.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      TextConstraint.Constraint(java.lang.Class<?> type, + java.lang.String propertyName, + java.lang.String[] allowed, + java.lang.String[] disallowed) 
      TextConstraint.Constraint(java.lang.Class<?> type, + java.lang.String propertyName, + TextConstraint ann) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidconstrain(char propertyValue) 
      voidconstrain(char[] propertyValue) 
      voidconstrain(java.lang.CharSequence propertyValue) 
      voidconstrain(java.lang.String propertyValue) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TextConstraint.Constraint

        +
        public TextConstraint.Constraint(java.lang.Class<?> type,
+                         java.lang.String propertyName,
+                         TextConstraint ann)
        +
        Parameters:
        type - type of object that contains the constrained property
        propertyName - name of property with constraint
        ann - specific annotation that binds to this constraint class
        +
        • +
      + + + +
        +
      • +

        TextConstraint.Constraint

        +
        public TextConstraint.Constraint(java.lang.Class<?> type,
+                         java.lang.String propertyName,
+                         java.lang.String[] allowed,
+                         java.lang.String[] disallowed)
        +
        Parameters:
        type - type of object that contains the constrained property
        propertyName - name of property with constraint
        allowed - optional set of allowed values
        disallowed - optional set of disallowed values
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        constrain

        +
        public void constrain(java.lang.CharSequence propertyValue)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(java.lang.String propertyValue)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(char propertyValue)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(char[] propertyValue)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/TextConstraint.html b/apidocs/com/amazon/carbonado/constraint/TextConstraint.html new file mode 100644 index 0000000..e163aa2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/TextConstraint.html @@ -0,0 +1,249 @@ + + + + + + +TextConstraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.constraint
+

Annotation Type TextConstraint

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+@ConstraintDefinition
+public @interface TextConstraint
    +
    Limits the value of a property to be a member of a specific set. The + property value may be a String, CharSequence, char, Character, or character + array. If the property value is outside the set, an IllegalArgumentException + is thrown. + +

    Example:

    + public interface UserInfo extends Storable {
+     char isActive();
+     @TextConstraint(allowed={"Y", "N"})
+     void setActive(char value);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    IntegerConstraint, +FloatConstraint
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.String[]allowed +
      Specific allowed values for property.
      +
      java.lang.String[]disallowed +
      Specific disallowed values for property.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        allowed

        +
        public abstract java.lang.String[] allowed
        +
        Specific allowed values for property. Default is unlimited.
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      + + + +
        +
      • +

        disallowed

        +
        public abstract java.lang.String[] disallowed
        +
        Specific disallowed values for property. Default is none.
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.constraint.ConstraintDefinition

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

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

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

Uses of Class
com.amazon.carbonado.constraint.FloatConstraint.Constraint

+
+
No usage of com.amazon.carbonado.constraint.FloatConstraint.Constraint
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.constraint.FloatConstraint

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

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

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

Uses of Class
com.amazon.carbonado.constraint.IntegerConstraint.Constraint

+
+
No usage of com.amazon.carbonado.constraint.IntegerConstraint.Constraint
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/class-use/IntegerConstraint.html b/apidocs/com/amazon/carbonado/constraint/class-use/IntegerConstraint.html new file mode 100644 index 0000000..4c188f6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/class-use/IntegerConstraint.html @@ -0,0 +1,187 @@ + + + + + + +Uses of Class com.amazon.carbonado.constraint.IntegerConstraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.constraint.IntegerConstraint

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

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

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

Uses of Class
com.amazon.carbonado.constraint.LengthConstraint.Constraint

+
+
No usage of com.amazon.carbonado.constraint.LengthConstraint.Constraint
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.constraint.LengthConstraint

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

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

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

Uses of Class
com.amazon.carbonado.constraint.TextConstraint.Constraint

+
+
No usage of com.amazon.carbonado.constraint.TextConstraint.Constraint
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.constraint.TextConstraint

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/package-frame.html b/apidocs/com/amazon/carbonado/constraint/package-frame.html new file mode 100644 index 0000000..c16cc70 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/package-frame.html @@ -0,0 +1,31 @@ + + + + + + +com.amazon.carbonado.constraint (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.constraint

+
+

Classes

+ +

Annotation Types

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/constraint/package-summary.html b/apidocs/com/amazon/carbonado/constraint/package-summary.html new file mode 100644 index 0000000..02a0986 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/package-summary.html @@ -0,0 +1,206 @@ + + + + + + +com.amazon.carbonado.constraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.constraint

+
+
Contains annotations and implementations for supporting property constraints.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.constraint Description

+
Contains annotations and implementations for supporting property constraints.
+
See Also:
ConstraintDefinition
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/package-tree.html b/apidocs/com/amazon/carbonado/constraint/package-tree.html new file mode 100644 index 0000000..1ec966e --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/package-tree.html @@ -0,0 +1,141 @@ + + + + + + +com.amazon.carbonado.constraint Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.constraint

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Annotation Type Hierarchy

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/package-use.html b/apidocs/com/amazon/carbonado/constraint/package-use.html new file mode 100644 index 0000000..1348147 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/package-use.html @@ -0,0 +1,197 @@ + + + + + + +Uses of Package com.amazon.carbonado.constraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.constraint

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/AbstractCursor.html b/apidocs/com/amazon/carbonado/cursor/AbstractCursor.html new file mode 100644 index 0000000..401e185 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/AbstractCursor.html @@ -0,0 +1,430 @@ + + + + + + +AbstractCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class AbstractCursor<S>

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected AbstractCursor() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      intcopyInto(java.util.Collection<? super S> c) +
      Copies all remaining next elements into the given collection.
      +
      intcopyInto(java.util.Collection<? super S> c, + int limit) +
      Copies a limited amount of remaining next elements into the given + collection.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      java.util.List<S>toList() +
      Copies all remaining next elements into a new modifiable list.
      +
      java.util.List<S>toList(int limit) +
      Copies a limited amount of remaining next elements into a new modifiable + list.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AbstractCursor

        +
        protected AbstractCursor()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        copyInto

        +
        public int copyInto(java.util.Collection<? super S> c)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Copies all remaining next elements into the given collection. This + method is roughly equivalent to the following: + 
        + Cursor cursor;
+ ...
+ while (cursor.hasNext()) {
+     c.add(cursor.next());
+ }
+
        + +

        As a side-effect of calling this method, the cursor is closed.

        +
        +
        Specified by:
        +
        copyInto in interface Cursor<S>
        +
        Returns:
        actual amount of results added
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        copyInto

        +
        public int copyInto(java.util.Collection<? super S> c,
+           int limit)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Copies a limited amount of remaining next elements into the given + collection. This method is roughly equivalent to the following: + 
        + Cursor cursor;
+ ...
+ while (--limit >= 0 && cursor.hasNext()) {
+     c.add(cursor.next());
+ }
+
        +
        +
        Specified by:
        +
        copyInto in interface Cursor<S>
        +
        limit - maximum amount of elements to copy
        +
        Returns:
        actual amount of results added
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public java.util.List<S> toList()
+                         throws FetchException
        +
        Description copied from interface: Cursor
        +
        Copies all remaining next elements into a new modifiable list. This + method is roughly equivalent to the following: + 
        + Cursor<S> cursor;
+ ...
+ List<S> list = new ...
+ cursor.copyInto(list);
+
        + +

        As a side-effect of calling this method, the cursor is closed.

        +
        +
        Specified by:
        +
        toList in interface Cursor<S>
        +
        Returns:
        a new modifiable list
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public java.util.List<S> toList(int limit)
+                         throws FetchException
        +
        Description copied from interface: Cursor
        +
        Copies a limited amount of remaining next elements into a new modifiable + list. This method is roughly equivalent to the following: + 
        + Cursor<S> cursor;
+ ...
+ List<S> list = new ...
+ cursor.copyInto(list, limit);
+
        +
        +
        Specified by:
        +
        toList in interface Cursor<S>
        +
        Parameters:
        limit - maximum amount of elements to copy
        +
        Returns:
        a new modifiable list
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<S>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/ArraySortBuffer.html b/apidocs/com/amazon/carbonado/cursor/ArraySortBuffer.html new file mode 100644 index 0000000..0b6613c --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/ArraySortBuffer.html @@ -0,0 +1,395 @@ + + + + + + +ArraySortBuffer (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class ArraySortBuffer<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    SortBuffer<S>, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<S>, java.util.Collection<S>, java.util.List<S>, java.util.RandomAccess
    +
    +
    +
    +
    public class ArraySortBuffer<S>
+extends java.util.ArrayList<S>
+implements SortBuffer<S>
    +
    Sort buffer implementation backed by an ArrayList.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    SortedCursor, +Serialized Form
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class java.util.AbstractList

        +modCount
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Clear and close buffer.
      +
      voidprepare(java.util.Comparator<S> comparator) +
      Clears buffer and assigns a comparator for sorting.
      +
      voidsort() +
      Finish sorting buffer.
      +
      +
        +
      • + + +

        Methods inherited from class java.util.ArrayList

        +add, add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeRange, retainAll, set, size, subList, toArray, toArray, trimToSize
        • +
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractList

        +equals, hashCode
        • +
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractCollection

        +containsAll, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.Collection

        +add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.List

        +containsAll, equals, hashCode
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ArraySortBuffer

        +
        public ArraySortBuffer()
        +
        • +
      + + + +
        +
      • +

        ArraySortBuffer

        +
        public ArraySortBuffer(int initialCapacity)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        prepare

        +
        public void prepare(java.util.Comparator<S> comparator)
        +
        Description copied from interface: SortBuffer
        +
        Clears buffer and assigns a comparator for sorting.
        +
        +
        Specified by:
        +
        prepare in interface SortBuffer<S>
        +
        +
        • +
      + + + +
        +
      • +

        sort

        +
        public void sort()
        +
        Description copied from interface: SortBuffer
        +
        Finish sorting buffer.
        +
        +
        Specified by:
        +
        sort in interface SortBuffer<S>
        +
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
        +
        Description copied from interface: SortBuffer
        +
        Clear and close buffer.
        +
        +
        Specified by:
        +
        close in interface SortBuffer<S>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/ControllerCursor.html b/apidocs/com/amazon/carbonado/cursor/ControllerCursor.html new file mode 100644 index 0000000..b91dded --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/ControllerCursor.html @@ -0,0 +1,317 @@ + + + + + + +ControllerCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class ControllerCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class ControllerCursor<S>
+extends AbstractCursor<S>
    +
    Wraps another cursor and periodically calls a controller.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static <S> Cursor<S>apply(Cursor<S> source, + Query.Controller controller) +
      Returns a ControllerCursor depending on whether a controller instance is + passed in or not.
      +
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        apply

        +
        public static <S> Cursor<S> apply(Cursor<S> source,
+                  Query.Controller controller)
        +
        Returns a ControllerCursor depending on whether a controller instance is + passed in or not.
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if source is null
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/DifferenceCursor.html b/apidocs/com/amazon/carbonado/cursor/DifferenceCursor.html new file mode 100644 index 0000000..9b2169e --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/DifferenceCursor.html @@ -0,0 +1,341 @@ + + + + + + +DifferenceCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class DifferenceCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class DifferenceCursor<S>
+extends AbstractCursor<S>
    +
    Wraps two Cursors and performs an asymmetric set difference + operation. + +

    Both cursors must return results in the same order. Ordering is preserved + by the difference.

    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    UnionCursor, +IntersectionCursor, +SymmetricDifferenceCursor
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      DifferenceCursor(Cursor<S> left, + Cursor<S> right, + java.util.Comparator<S> order) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DifferenceCursor

        +
        public DifferenceCursor(Cursor<S> left,
+                Cursor<S> right,
+                java.util.Comparator<S> order)
        +
        Parameters:
        left - cursor to wrap
        right - cursor to wrap whose results are completely discarded
        order - describes sort ordering of wrapped cursors, which must be + a total ordering
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/EmptyCursor.html b/apidocs/com/amazon/carbonado/cursor/EmptyCursor.html new file mode 100644 index 0000000..c00cbc6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/EmptyCursor.html @@ -0,0 +1,401 @@ + + + + + + +EmptyCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class EmptyCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class EmptyCursor<S>
+extends java.lang.Object
+implements Cursor<S>
    +
    Special cursor implementation that is empty.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    SingletonCursor
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Does nothing.
      +
      intcopyInto(java.util.Collection<? super S> c) +
      Performs no copy and always returns 0.
      +
      intcopyInto(java.util.Collection<? super S> c, + int limit) +
      Performs no copy and always returns 0.
      +
      booleanhasNext() +
      Always returns false.
      +
      Snext() +
      Always throws NoSuchElementException.
      +
      intskipNext(int amount) +
      Always returns 0.
      +
      static <S> Cursor<S>the() +
      Returns the empty cursor instance.
      +
      java.util.List<S>toList() +
      Always returns an empty list.
      +
      java.util.List<S>toList(int limit) +
      Always returns an empty list.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        the

        +
        public static <S> Cursor<S> the()
        +
        Returns the empty cursor instance.
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
        +
        Does nothing.
        +
        +
        Specified by:
        +
        close in interface Cursor<S>
        +
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
        +
        Always returns false.
        +
        +
        Specified by:
        +
        hasNext in interface Cursor<S>
        +
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
        +
        Always throws NoSuchElementException.
        +
        +
        Specified by:
        +
        next in interface Cursor<S>
        +
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
        +
        Always returns 0.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<S>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        • +
      + + + +
        +
      • +

        copyInto

        +
        public int copyInto(java.util.Collection<? super S> c)
        +
        Performs no copy and always returns 0.
        +
        +
        Specified by:
        +
        copyInto in interface Cursor<S>
        +
        Returns:
        actual amount of results added
        +
        • +
      + + + +
        +
      • +

        copyInto

        +
        public int copyInto(java.util.Collection<? super S> c,
+           int limit)
        +
        Performs no copy and always returns 0.
        +
        +
        Specified by:
        +
        copyInto in interface Cursor<S>
        +
        limit - maximum amount of elements to copy
        +
        Returns:
        actual amount of results added
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public java.util.List<S> toList()
        +
        Always returns an empty list.
        +
        +
        Specified by:
        +
        toList in interface Cursor<S>
        +
        Returns:
        a new modifiable list
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public java.util.List<S> toList(int limit)
        +
        Always returns an empty list.
        +
        +
        Specified by:
        +
        toList in interface Cursor<S>
        +
        Parameters:
        limit - maximum amount of elements to copy
        +
        Returns:
        a new modifiable list
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/FetchAheadCursor.html b/apidocs/com/amazon/carbonado/cursor/FetchAheadCursor.html new file mode 100644 index 0000000..79de3f8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/FetchAheadCursor.html @@ -0,0 +1,331 @@ + + + + + + +FetchAheadCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class FetchAheadCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class FetchAheadCursor<S>
+extends AbstractCursor<S>
    +
    Cursor implementation which fetches records in advance, in order to release locks.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      FetchAheadCursor(Cursor<S> source, + int fetchAhead) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FetchAheadCursor

        +
        public FetchAheadCursor(Cursor<S> source,
+                int fetchAhead)
        +
        Parameters:
        fetchAhead - how much to fetch ahead from source
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/FilteredCursor.html b/apidocs/com/amazon/carbonado/cursor/FilteredCursor.html new file mode 100644 index 0000000..add9572 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/FilteredCursor.html @@ -0,0 +1,436 @@ + + + + + + +FilteredCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class FilteredCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public abstract class FilteredCursor<S>
+extends AbstractCursor<S>
    +
    Wraps another cursor and applies custom filtering to reduce the set of + results.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected FilteredCursor(Cursor<S> cursor) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static <S extends Storable> 
      Cursor<S>      		applyFilter(Cursor<S> cursor, + java.lang.Class<S> type, + java.lang.String filter, + java.lang.Object... filterValues) +
      Returns a Cursor that is filtered by the given filter expression and values.
      +
      static <S extends Storable> 
      Cursor<S>      		applyFilter(Filter<S> filter, + FilterValues<S> filterValues, + Cursor<S> cursor) +
      Returns a Cursor that is filtered by the given Filter and FilterValues.
      +
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      protected abstract booleanisAllowed(S storable) 
      Snext() +
      Returns the next element from this cursor.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FilteredCursor

        +
        protected FilteredCursor(Cursor<S> cursor)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        applyFilter

        +
        public static <S extends Storable> Cursor<S> applyFilter(Cursor<S> cursor,
+                                         java.lang.Class<S> type,
+                                         java.lang.String filter,
+                                         java.lang.Object... filterValues)
        +
        Returns a Cursor that is filtered by the given filter expression and values.
        +
        Parameters:
        cursor - cursor to wrap
        type - type of storable
        filter - filter to apply
        filterValues - values for filter
        +
        Returns:
        wrapped cursor which filters results
        +
        Throws:
        +
        java.lang.IllegalStateException - if any values are not specified
        +
        java.lang.IllegalArgumentException - if any argument is null
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        applyFilter

        +
        public static <S extends Storable> Cursor<S> applyFilter(Filter<S> filter,
+                                         FilterValues<S> filterValues,
+                                         Cursor<S> cursor)
        +
        Returns a Cursor that is filtered by the given Filter and FilterValues. + The given Filter must be composed only of the same PropertyFilter + instances as used to construct the FilterValues. An + IllegalStateException will result otherwise.
        +
        Parameters:
        filter - filter to apply
        filterValues - values for filter, which may be null if filter has no parameters
        cursor - cursor to wrap
        +
        Returns:
        wrapped cursor which filters results
        +
        Throws:
        +
        java.lang.IllegalStateException - if any values are not specified
        +
        java.lang.IllegalArgumentException - if filter is closed
        +
        • +
      + + + + + +
        +
      • +

        isAllowed

        +
        protected abstract boolean isAllowed(S storable)
+                              throws FetchException
        +
        Returns:
        false if object should not be in results
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<S>
        +
        Overrides:
        +
        skipNext in class AbstractCursor<S>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/GroupedCursor.html b/apidocs/com/amazon/carbonado/cursor/GroupedCursor.html new file mode 100644 index 0000000..dd3c96c --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/GroupedCursor.html @@ -0,0 +1,488 @@ + + + + + + +GroupedCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class GroupedCursor<S,G>

+
+
+ +
+
    +
  • +
    Type Parameters:
    S - source type, can be anything
    G - aggregate type, can be anything
    +
    +
    All Implemented Interfaces:
    +
    Cursor<G>
    +
    +
    +
    +
    public abstract class GroupedCursor<S,G>
+extends AbstractCursor<G>
    +
    Abstract cursor for aggregation and finding distinct data. The source cursor + must be ordered in some fashion by the grouping properties. The arrangement of + properties must match, but it does not matter if they are ascending or + descending.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    SortedCursor
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected GroupedCursor(Cursor<S> cursor, + java.lang.Class<S> type, + java.lang.String... groupProperties) +
      Create a GroupedCursor using properties to define the group + comparator.
      +
      protected GroupedCursor(Cursor<S> cursor, + java.util.Comparator<S> groupComparator) +
      Create a GroupedCursor with an existing group comparator.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected abstract voidaddToGroup(S groupMember) +
      This method is called when more entries are found for the current + group.
      +
      protected abstract voidbeginGroup(S groupLeader) +
      This method is called for the first entry in a group.
      +
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      java.util.Comparator<S>comparator() +
      Returns the comparator used to identify group boundaries.
      +
      protected abstract GfinishGroup() +
      This method is called when a group is finished, and it can return an + aggregate.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Gnext() +
      Returns the next element from this cursor.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GroupedCursor

        +
        protected GroupedCursor(Cursor<S> cursor,
+             java.util.Comparator<S> groupComparator)
        +
        Create a GroupedCursor with an existing group comparator. The comparator + defines the ordering of the source cursor, and it should be a partial + odering. If group comparator defines a total ordering, then all groups + have one member.
        +
        Parameters:
        cursor - source of elements which must be ordered properly
        groupComparator - comparator which defines ordering of source cursor
        +
        • +
      + + + +
        +
      • +

        GroupedCursor

        +
        protected GroupedCursor(Cursor<S> cursor,
+             java.lang.Class<S> type,
+             java.lang.String... groupProperties)
        +
        Create a GroupedCursor using properties to define the group + comparator. The set of properties defines the ordering of the source + cursor, and it should be a partial ordering. If properties define a + total ordering, then all groups have one member.
        +
        Parameters:
        cursor - source of elements which must be ordered properly
        type - type of storable to create cursor for
        groupProperties - list of properties to group by
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any property is null or not a member + of storable type
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        comparator

        +
        public java.util.Comparator<S> comparator()
        +
        Returns the comparator used to identify group boundaries.
        +
        • +
      + + + + + +
        +
      • +

        beginGroup

        +
        protected abstract void beginGroup(S groupLeader)
+                            throws FetchException
        +
        This method is called for the first entry in a group. This method is not + called again until after finishGroup is called.
        +
        Parameters:
        groupLeader - first entry in group
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + + + +
        +
      • +

        addToGroup

        +
        protected abstract void addToGroup(S groupMember)
+                            throws FetchException
        +
        This method is called when more entries are found for the current + group. This method is not called until after beginGroup has been + called. It may called multiple times until finishGroup is called.
        +
        Parameters:
        groupMember - additional entry in group
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        finishGroup

        +
        protected abstract G finishGroup()
+                          throws FetchException
        +
        This method is called when a group is finished, and it can return an + aggregate. Simply return null if aggregate should be filtered out.
        +
        Returns:
        aggregate, or null to filter it out
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public G next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<G>
        +
        Overrides:
        +
        skipNext in class AbstractCursor<G>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/IntersectionCursor.html b/apidocs/com/amazon/carbonado/cursor/IntersectionCursor.html new file mode 100644 index 0000000..69a6db5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/IntersectionCursor.html @@ -0,0 +1,341 @@ + + + + + + +IntersectionCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class IntersectionCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class IntersectionCursor<S>
+extends AbstractCursor<S>
    +
    Wraps two Cursors and performs a set intersection operation. In + boolean logic, this is an and operation. + +

    Both cursors must return results in the same order. Ordering is preserved + by the intersection.

    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    UnionCursor, +DifferenceCursor, +SymmetricDifferenceCursor
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        IntersectionCursor

        +
        public IntersectionCursor(Cursor<S> left,
+                  Cursor<S> right,
+                  java.util.Comparator<S> order)
        +
        Parameters:
        left - cursor to wrap
        right - cursor to wrap
        order - describes sort ordering of wrapped cursors, which must be + a total ordering
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/IteratorCursor.html b/apidocs/com/amazon/carbonado/cursor/IteratorCursor.html new file mode 100644 index 0000000..c8d0ab4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/IteratorCursor.html @@ -0,0 +1,348 @@ + + + + + + +IteratorCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class IteratorCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class IteratorCursor<S>
+extends AbstractCursor<S>
    +
    Adapts an Iterator into a Cursor.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      IteratorCursor(java.lang.Iterable<S> iterable) 
      IteratorCursor(java.lang.Iterable<S> iterable, + java.util.concurrent.locks.Lock lock) 
      IteratorCursor(java.util.Iterator<S> iterator) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        IteratorCursor

        +
        public IteratorCursor(java.lang.Iterable<S> iterable)
        +
        Parameters:
        iterable - collection to iterate over, or null for empty cursor
        +
        • +
      + + + +
        +
      • +

        IteratorCursor

        +
        public IteratorCursor(java.lang.Iterable<S> iterable,
+              java.util.concurrent.locks.Lock lock)
        +
        Parameters:
        iterable - collection to iterate over, or null for empty cursor
        lock - optional lock to hold while cursor is open
        +
        • +
      + + + +
        +
      • +

        IteratorCursor

        +
        public IteratorCursor(java.util.Iterator<S> iterator)
        +
        Parameters:
        iterator - iterator to wrap, or null for empty cursor
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/LimitCursor.html b/apidocs/com/amazon/carbonado/cursor/LimitCursor.html new file mode 100644 index 0000000..7663d24 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/LimitCursor.html @@ -0,0 +1,366 @@ + + + + + + +LimitCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class LimitCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class LimitCursor<S>
+extends AbstractCursor<S>
    +
    Wraps another cursor to limit the amount of elements.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    SkipCursor
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      LimitCursor(Cursor<S> source, + long limit) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LimitCursor

        +
        public LimitCursor(Cursor<S> source,
+           long limit)
        +
        Parameters:
        limit - maximum amount of elements
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if source is null or limit is negative
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<S>
        +
        Overrides:
        +
        skipNext in class AbstractCursor<S>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/MergeSortBuffer.html b/apidocs/com/amazon/carbonado/cursor/MergeSortBuffer.html new file mode 100644 index 0000000..15e325d --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/MergeSortBuffer.html @@ -0,0 +1,546 @@ + + + + + + +MergeSortBuffer (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class MergeSortBuffer<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    SortBuffer<S>, java.lang.Iterable<S>, java.util.Collection<S>
    +
    +
    +
    +
    public class MergeSortBuffer<S extends Storable>
+extends java.util.AbstractCollection<S>
+implements SortBuffer<S>
    +
    Sort buffer implemented via a merge sort algorithm. If there are too many + storables to fit in the reserved memory buffer, they are sorted and + serialized to temporary files. + +

    The following system properties can be set to change the default + performance characteristics of the merge sort. Each property name must be + prefixed with "com.amazon.carbonado.cursor.MergeSortBuffer." + + 

    + Property            Default    Notes
+ ------------------- ---------- ----------------------------------------------
+ maxArrayCapacity    8192       Larger value greatly improves performance, but
+                                more memory is used for each running sort.
+
+ maxOpenFileCount    100        Larger value may reduce the amount of file
+                                merges, but there is an increased risk of
+                                running out of file descriptors.
+
+ outputBufferSize    10000      Larger value may improve performance of file
+                                writing, but not by much.
+
+ tmpdir                         Merge sort files by default are placed in the
+                                Java temp directory. Override to place them
+                                somewhere else.
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    SortedCursor
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanadd(S storable) 
      voidclear() 
      voidclose() +
      Clear and close buffer.
      +
      java.util.Iterator<S>iterator() 
      voidprepare(java.util.Comparator<S> comparator) +
      Clears buffer and assigns a comparator for sorting.
      +
      intsize() 
      voidsort() +
      Finish sorting buffer.
      +
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractCollection

        +addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.Collection

        +addAll, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, toArray, toArray
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MergeSortBuffer

        +
        public MergeSortBuffer()
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        MergeSortBuffer

        +
        public MergeSortBuffer(Query.Controller controller)
        +
        Parameters:
        controller - optional controller which can abort query operation
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        MergeSortBuffer

        +
        public MergeSortBuffer(Storage<S> storage)
        +
        Parameters:
        storage - storage for elements; if null use first Storable to + prepare reloaded Storables
        +
        • +
      + + + +
        +
      • +

        MergeSortBuffer

        +
        public MergeSortBuffer(Storage<S> storage,
+               Query.Controller controller)
        +
        Parameters:
        storage - storage for elements; if null use first Storable to + prepare reloaded Storables
        controller - optional controller which can abort query operation
        +
        • +
      + + + +
        +
      • +

        MergeSortBuffer

        +
        public MergeSortBuffer(Storage<S> storage,
+               java.lang.String tempDir)
        +
        Parameters:
        storage - storage for elements; if null use first Storable to + prepare reloaded Storables
        tempDir - directory to store temp files for merging, or null for default
        +
        • +
      + + + +
        +
      • +

        MergeSortBuffer

        +
        public MergeSortBuffer(Storage<S> storage,
+               java.lang.String tempDir,
+               int maxArrayCapacity)
        +
        Parameters:
        storage - storage for elements; if null use first Storable to + prepare reloaded Storables
        tempDir - directory to store temp files for merging, or null for default
        maxArrayCapacity - maximum amount of storables to keep in an array + before serializing to a file
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if storage is null
        +
        • +
      + + + +
        +
      • +

        MergeSortBuffer

        +
        public MergeSortBuffer(Storage<S> storage,
+               java.lang.String tempDir,
+               int maxArrayCapacity,
+               Query.Controller controller)
        +
        Parameters:
        storage - storage for elements; if null use first Storable to + prepare reloaded Storables
        tempDir - directory to store temp files for merging, or null for default
        maxArrayCapacity - maximum amount of storables to keep in an array + before serializing to a file
        controller - optional controller which can abort query operation
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if storage is null
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        prepare

        +
        public void prepare(java.util.Comparator<S> comparator)
        +
        Description copied from interface: SortBuffer
        +
        Clears buffer and assigns a comparator for sorting.
        +
        +
        Specified by:
        +
        prepare in interface SortBuffer<S extends Storable>
        +
        +
        • +
      + + + + + +
        +
      • +

        add

        +
        public boolean add(S storable)
        +
        +
        Specified by:
        +
        add in interface java.util.Collection<S extends Storable>
        +
        Overrides:
        +
        add in class java.util.AbstractCollection<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        +
        Specified by:
        +
        size in interface java.util.Collection<S extends Storable>
        +
        Specified by:
        +
        size in class java.util.AbstractCollection<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<S> iterator()
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<S extends Storable>
        +
        Specified by:
        +
        iterator in interface java.util.Collection<S extends Storable>
        +
        Specified by:
        +
        iterator in class java.util.AbstractCollection<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        clear

        +
        public void clear()
        +
        +
        Specified by:
        +
        clear in interface java.util.Collection<S extends Storable>
        +
        Overrides:
        +
        clear in class java.util.AbstractCollection<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        sort

        +
        public void sort()
        +
        Description copied from interface: SortBuffer
        +
        Finish sorting buffer.
        +
        +
        Specified by:
        +
        sort in interface SortBuffer<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
        +
        Description copied from interface: SortBuffer
        +
        Clear and close buffer.
        +
        +
        Specified by:
        +
        close in interface SortBuffer<S extends Storable>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/MultiTransformedCursor.html b/apidocs/com/amazon/carbonado/cursor/MultiTransformedCursor.html new file mode 100644 index 0000000..b286fc6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/MultiTransformedCursor.html @@ -0,0 +1,388 @@ + + + + + + +MultiTransformedCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class MultiTransformedCursor<S,T>

+
+
+ +
+
    +
  • +
    Type Parameters:
    S - source type, can be anything
    T - target type, can be anything
    +
    +
    All Implemented Interfaces:
    +
    Cursor<T>
    +
    +
    +
    +
    public abstract class MultiTransformedCursor<S,T>
+extends AbstractCursor<T>
    +
    Abstract cursor which wraps another cursor and transforms each storable + result into a set of target storables. This class can be used for + implementing one-to-many joins. Use TransformedCursor for one-to-one + joins.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Tnext() +
      Returns the next element from this cursor.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      protected abstract Cursor<T>transform(S storable) +
      This method must be implemented to transform storables.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MultiTransformedCursor

        +
        protected MultiTransformedCursor(Cursor<S> cursor)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        transform

        +
        protected abstract Cursor<T> transform(S storable)
+                                throws FetchException
        +
        This method must be implemented to transform storables. If the storable + cannot be transformed, either throw a FetchException or return null. If + null is returned, the storable is simply filtered out.
        +
        Returns:
        transformed storables, or null to filter it out
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public T next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<T>
        +
        Overrides:
        +
        skipNext in class AbstractCursor<T>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/SingletonCursor.html b/apidocs/com/amazon/carbonado/cursor/SingletonCursor.html new file mode 100644 index 0000000..859ba03 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/SingletonCursor.html @@ -0,0 +1,475 @@ + + + + + + +SingletonCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class SingletonCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class SingletonCursor<S>
+extends java.lang.Object
+implements Cursor<S>
    +
    Special cursor implementation that returns only one element.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    EmptyCursor
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      SingletonCursor(S object) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      intcopyInto(java.util.Collection<? super S> c) +
      Copies all remaining next elements into the given collection.
      +
      intcopyInto(java.util.Collection<? super S> c, + int limit) +
      Copies a limited amount of remaining next elements into the given + collection.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      java.util.List<S>toList() +
      Copies all remaining next elements into a new modifiable list.
      +
      java.util.List<S>toList(int limit) +
      Copies a limited amount of remaining next elements into a new modifiable + list.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + + + +
        +
      • +

        SingletonCursor

        +
        public SingletonCursor(S object)
        +
        Parameters:
        object - single object to return from cursor, must not be null
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if object is null
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        +
        Specified by:
        +
        close in interface Cursor<S>
        +
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        +
        Specified by:
        +
        hasNext in interface Cursor<S>
        +
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        +
        Specified by:
        +
        next in interface Cursor<S>
        +
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
        +
        Description copied from interface: Cursor
        +
        Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<S>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        • +
      + + + +
        +
      • +

        copyInto

        +
        public int copyInto(java.util.Collection<? super S> c)
        +
        Description copied from interface: Cursor
        +
        Copies all remaining next elements into the given collection. This + method is roughly equivalent to the following: + 
        + Cursor cursor;
+ ...
+ while (cursor.hasNext()) {
+     c.add(cursor.next());
+ }
+
        + +

        As a side-effect of calling this method, the cursor is closed.

        +
        +
        Specified by:
        +
        copyInto in interface Cursor<S>
        +
        Returns:
        actual amount of results added
        +
        • +
      + + + +
        +
      • +

        copyInto

        +
        public int copyInto(java.util.Collection<? super S> c,
+           int limit)
        +
        Description copied from interface: Cursor
        +
        Copies a limited amount of remaining next elements into the given + collection. This method is roughly equivalent to the following: + 
        + Cursor cursor;
+ ...
+ while (--limit >= 0 && cursor.hasNext()) {
+     c.add(cursor.next());
+ }
+
        +
        +
        Specified by:
        +
        copyInto in interface Cursor<S>
        +
        limit - maximum amount of elements to copy
        +
        Returns:
        actual amount of results added
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public java.util.List<S> toList()
        +
        Description copied from interface: Cursor
        +
        Copies all remaining next elements into a new modifiable list. This + method is roughly equivalent to the following: + 
        + Cursor<S> cursor;
+ ...
+ List<S> list = new ...
+ cursor.copyInto(list);
+
        + +

        As a side-effect of calling this method, the cursor is closed.

        +
        +
        Specified by:
        +
        toList in interface Cursor<S>
        +
        Returns:
        a new modifiable list
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public java.util.List<S> toList(int limit)
        +
        Description copied from interface: Cursor
        +
        Copies a limited amount of remaining next elements into a new modifiable + list. This method is roughly equivalent to the following: + 
        + Cursor<S> cursor;
+ ...
+ List<S> list = new ...
+ cursor.copyInto(list, limit);
+
        +
        +
        Specified by:
        +
        toList in interface Cursor<S>
        +
        Parameters:
        limit - maximum amount of elements to copy
        +
        Returns:
        a new modifiable list
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/SkipCursor.html b/apidocs/com/amazon/carbonado/cursor/SkipCursor.html new file mode 100644 index 0000000..219b516 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/SkipCursor.html @@ -0,0 +1,366 @@ + + + + + + +SkipCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class SkipCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class SkipCursor<S>
+extends AbstractCursor<S>
    +
    Wraps another cursor to skip an initial amount of elements.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    LimitCursor
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      SkipCursor(Cursor<S> source, + long skip) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SkipCursor

        +
        public SkipCursor(Cursor<S> source,
+          long skip)
        +
        Parameters:
        skip - initial amount of elements to skip
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if source is null or skip is negative
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<S>
        +
        Overrides:
        +
        skipNext in class AbstractCursor<S>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/SortBuffer.html b/apidocs/com/amazon/carbonado/cursor/SortBuffer.html new file mode 100644 index 0000000..dc2c593 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/SortBuffer.html @@ -0,0 +1,274 @@ + + + + + + +SortBuffer (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Interface SortBuffer<S>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.util.Collection<S>, java.lang.Iterable<S>
    +
    +
    +
    All Known Implementing Classes:
    +
    ArraySortBuffer, MergeSortBuffer
    +
    +
    +
    +
    public interface SortBuffer<S>
+extends java.util.Collection<S>
    +
    Buffers up Storable instances allowing them to be sorted. Should any method + need to throw an undeclared exception, wrap it with an + UndeclaredThrowableException.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    SortedCursor
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Clear and close buffer.
      +
      voidprepare(java.util.Comparator<S> comparator) +
      Clears buffer and assigns a comparator for sorting.
      +
      voidsort() +
      Finish sorting buffer.
      +
      +
        +
      • + + +

        Methods inherited from interface java.util.Collection

        +add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        prepare

        +
        void prepare(java.util.Comparator<S> comparator)
        +
        Clears buffer and assigns a comparator for sorting.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if comparator is null
        +
        • +
      + + + +
        +
      • +

        sort

        +
        void sort()
+          throws FetchException
        +
        Finish sorting buffer.
        +
        Throws:
        +
        java.lang.IllegalStateException - if prepare was never called
        +
        FetchException
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/SortedCursor.html b/apidocs/com/amazon/carbonado/cursor/SortedCursor.html new file mode 100644 index 0000000..56ddfc2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/SortedCursor.html @@ -0,0 +1,476 @@ + + + + + + +SortedCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class SortedCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class SortedCursor<S>
+extends AbstractCursor<S>
    +
    Wraps another Cursor and ensures the results are sorted. If the elements in + the source cursor are already partially sorted, a handled comparator can be + passed in which specifies the partial ordering. Elements are then processed + in smaller chunks rather than sorting the entire set. The handled comparator + can represent ascending or descending order of source elements.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      SortedCursor(Cursor<S> cursor, + SortBuffer<S> buffer, + java.lang.Class<S> type, + java.lang.String... orderProperties) 
      SortedCursor(Cursor<S> cursor, + SortBuffer<S> buffer, + java.util.Comparator<S> handled, + java.util.Comparator<S> finisher) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      java.util.Comparator<S>comparator() +
      Returns a comparator representing the effective sort order of this cursor.
      +
      static <S> java.util.Comparator<S>createComparator(java.lang.Class<S> type, + java.lang.String... orderProperties) +
      Convenience method to create a comparator which orders storables by the + given order-by properties.
      +
      static <S extends Storable> 
      java.util.Comparator<S>      		createComparator(java.util.List<OrderedProperty<S>> properties) +
      Convenience method to create a comparator which orders storables by the + given properties.
      +
      static <S extends Storable> 
      java.util.Comparator<S>      		createComparator(OrderedProperty<S>... properties) +
      Convenience method to create a comparator which orders storables by the + given properties.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SortedCursor

        +
        public SortedCursor(Cursor<S> cursor,
+            SortBuffer<S> buffer,
+            java.util.Comparator<S> handled,
+            java.util.Comparator<S> finisher)
        +
        Parameters:
        cursor - cursor to wrap
        buffer - required buffer to hold results
        handled - optional comparator which represents how the results are + already sorted
        finisher - required comparator which finishes the sort
        +
        • +
      + + + +
        +
      • +

        SortedCursor

        +
        public SortedCursor(Cursor<S> cursor,
+            SortBuffer<S> buffer,
+            java.lang.Class<S> type,
+            java.lang.String... orderProperties)
        +
        Parameters:
        cursor - cursor to wrap
        buffer - required buffer to hold results
        type - type of storable to create cursor for
        orderProperties - list of properties to order by
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any property is null or not a member + of storable type
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        createComparator

        +
        public static <S> java.util.Comparator<S> createComparator(java.lang.Class<S> type,
+                                           java.lang.String... orderProperties)
        +
        Convenience method to create a comparator which orders storables by the + given order-by properties. The property names may be prefixed with '+' + or '-' to indicate ascending or descending order. If the prefix is + omitted, ascending order is assumed.
        +
        Parameters:
        type - type of storable to create comparator for
        orderProperties - list of properties to order by
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any property is null or not a member + of storable type
        +
        • +
      + + + +
        +
      • +

        createComparator

        +
        public static <S extends Storable> java.util.Comparator<S> createComparator(OrderedProperty<S>... properties)
        +
        Convenience method to create a comparator which orders storables by the + given properties.
        +
        Parameters:
        properties - list of properties to order by
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if no properties or if any property is null
        +
        • +
      + + + +
        +
      • +

        createComparator

        +
        public static <S extends Storable> java.util.Comparator<S> createComparator(java.util.List<OrderedProperty<S>> properties)
        +
        Convenience method to create a comparator which orders storables by the + given properties.
        +
        Parameters:
        properties - list of properties to order by
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if no properties or if any property is null
        +
        • +
      + + + +
        +
      • +

        comparator

        +
        public java.util.Comparator<S> comparator()
        +
        Returns a comparator representing the effective sort order of this cursor.
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<S>
        +
        Overrides:
        +
        skipNext in class AbstractCursor<S>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html b/apidocs/com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html new file mode 100644 index 0000000..334ad60 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html @@ -0,0 +1,364 @@ + + + + + + +SymmetricDifferenceCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class SymmetricDifferenceCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class SymmetricDifferenceCursor<S>
+extends AbstractCursor<S>
    +
    Wraps two Cursors and performs a symmetric set difference + operation. In boolean logic, this is an exclusive or operation. + +

    Both cursors must return results in the same order. Ordering is preserved + by the difference.

    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    UnionCursor, +IntersectionCursor, +DifferenceCursor
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      intcompareNext() +
      Returns 0 if no next element available, <0 if next element is + from left source cursor, and >0 if next element is from right + source cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SymmetricDifferenceCursor

        +
        public SymmetricDifferenceCursor(Cursor<S> left,
+                         Cursor<S> right,
+                         java.util.Comparator<S> order)
        +
        Parameters:
        left - cursor to wrap
        right - cursor to wrap
        order - describes sort ordering of wrapped cursors, which must be + a total ordering
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        compareNext

        +
        public int compareNext()
+                throws FetchException
        +
        Returns 0 if no next element available, <0 if next element is + from left source cursor, and >0 if next element is from right + source cursor.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/ThrottledCursor.html b/apidocs/com/amazon/carbonado/cursor/ThrottledCursor.html new file mode 100644 index 0000000..6210a94 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/ThrottledCursor.html @@ -0,0 +1,362 @@ + + + + + + +ThrottledCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class ThrottledCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class ThrottledCursor<S>
+extends AbstractCursor<S>
    +
    Wraps another cursor and fetches results at a reduced speed.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ThrottledCursor(Cursor<S> cursor, + double throttle) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ThrottledCursor

        +
        public ThrottledCursor(Cursor<S> cursor,
+               double throttle)
        +
        Parameters:
        cursor - cursor to wrap
        throttle - 1.0 = fetch at full speed, 0.5 = fetch at half speed, + 0.1 = fetch at one tenth speed, etc.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<S>
        +
        Overrides:
        +
        skipNext in class AbstractCursor<S>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/TransformedCursor.html b/apidocs/com/amazon/carbonado/cursor/TransformedCursor.html new file mode 100644 index 0000000..521abf4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/TransformedCursor.html @@ -0,0 +1,387 @@ + + + + + + +TransformedCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class TransformedCursor<S,T>

+
+
+ +
+
    +
  • +
    Type Parameters:
    S - source type, can be anything
    T - target type, can be anything
    +
    +
    All Implemented Interfaces:
    +
    Cursor<T>
    +
    +
    +
    +
    public abstract class TransformedCursor<S,T>
+extends AbstractCursor<T>
    +
    Abstract cursor which wraps another cursor and transforms each storable + result into a target storable. This class can be used for implementing + one-to-one joins. Use MultiTransformedCursor for one-to-many joins.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected TransformedCursor(Cursor<S> cursor) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Tnext() +
      Returns the next element from this cursor.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      protected abstract Ttransform(S storable) +
      This method must be implemented to transform storables.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TransformedCursor

        +
        protected TransformedCursor(Cursor<S> cursor)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        transform

        +
        protected abstract T transform(S storable)
+                        throws FetchException
        +
        This method must be implemented to transform storables. If the storable + cannot be transformed, either throw a FetchException or return null. If + null is returned, the storable is simply filtered out.
        +
        Returns:
        transformed storable, or null to filter it out
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public T next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<T>
        +
        Overrides:
        +
        skipNext in class AbstractCursor<T>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/UnionCursor.html b/apidocs/com/amazon/carbonado/cursor/UnionCursor.html new file mode 100644 index 0000000..165ef60 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/UnionCursor.html @@ -0,0 +1,341 @@ + + + + + + +UnionCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class UnionCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class UnionCursor<S>
+extends AbstractCursor<S>
    +
    Wraps two Cursors and performs a set union operation. In boolean + logic, this is an or operation. + +

    Both cursors must return results in the same order. Ordering is preserved + by the union.

    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    IntersectionCursor, +DifferenceCursor, +SymmetricDifferenceCursor
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      UnionCursor(Cursor<S> left, + Cursor<S> right, + java.util.Comparator<S> order) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        UnionCursor

        +
        public UnionCursor(Cursor<S> left,
+           Cursor<S> right,
+           java.util.Comparator<S> order)
        +
        Parameters:
        left - cursor to wrap
        right - cursor to wrap
        order - describes sort ordering of wrapped cursors, which must be + a total ordering
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/class-use/AbstractCursor.html b/apidocs/com/amazon/carbonado/cursor/class-use/AbstractCursor.html new file mode 100644 index 0000000..060c4ed --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/class-use/AbstractCursor.html @@ -0,0 +1,278 @@ + + + + + + +Uses of Class com.amazon.carbonado.cursor.AbstractCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.cursor.AbstractCursor

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

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

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

Uses of Class
com.amazon.carbonado.cursor.ArraySortBuffer

+
+
No usage of com.amazon.carbonado.cursor.ArraySortBuffer
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.ControllerCursor

+
+
No usage of com.amazon.carbonado.cursor.ControllerCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.DifferenceCursor

+
+
No usage of com.amazon.carbonado.cursor.DifferenceCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.EmptyCursor

+
+
No usage of com.amazon.carbonado.cursor.EmptyCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.FetchAheadCursor

+
+
No usage of com.amazon.carbonado.cursor.FetchAheadCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.FilteredCursor

+
+
No usage of com.amazon.carbonado.cursor.FilteredCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.GroupedCursor

+
+
No usage of com.amazon.carbonado.cursor.GroupedCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.IntersectionCursor

+
+
No usage of com.amazon.carbonado.cursor.IntersectionCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.IteratorCursor

+
+
No usage of com.amazon.carbonado.cursor.IteratorCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.LimitCursor

+
+
No usage of com.amazon.carbonado.cursor.LimitCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.MergeSortBuffer

+
+
No usage of com.amazon.carbonado.cursor.MergeSortBuffer
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.MultiTransformedCursor

+
+
No usage of com.amazon.carbonado.cursor.MultiTransformedCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.SingletonCursor

+
+
No usage of com.amazon.carbonado.cursor.SingletonCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.SkipCursor

+
+
No usage of com.amazon.carbonado.cursor.SkipCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Interface
com.amazon.carbonado.cursor.SortBuffer

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

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

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

Uses of Class
com.amazon.carbonado.cursor.SortedCursor

+
+
No usage of com.amazon.carbonado.cursor.SortedCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.SymmetricDifferenceCursor

+
+
No usage of com.amazon.carbonado.cursor.SymmetricDifferenceCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.ThrottledCursor

+
+
No usage of com.amazon.carbonado.cursor.ThrottledCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.TransformedCursor

+
+
No usage of com.amazon.carbonado.cursor.TransformedCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.UnionCursor

+
+
No usage of com.amazon.carbonado.cursor.UnionCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/package-frame.html b/apidocs/com/amazon/carbonado/cursor/package-frame.html new file mode 100644 index 0000000..52a0fe8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/package-frame.html @@ -0,0 +1,43 @@ + + + + + + +com.amazon.carbonado.cursor (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.cursor

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/cursor/package-summary.html b/apidocs/com/amazon/carbonado/cursor/package-summary.html new file mode 100644 index 0000000..e72c8d3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/package-summary.html @@ -0,0 +1,284 @@ + + + + + + +com.amazon.carbonado.cursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.cursor

+
+
Support for advanced processing of cursor results, including basic set + theory operations.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.cursor Description

+
Support for advanced processing of cursor results, including basic set + theory operations.
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/package-tree.html b/apidocs/com/amazon/carbonado/cursor/package-tree.html new file mode 100644 index 0000000..46b2f56 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/package-tree.html @@ -0,0 +1,176 @@ + + + + + + +com.amazon.carbonado.cursor Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.cursor

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/package-use.html b/apidocs/com/amazon/carbonado/cursor/package-use.html new file mode 100644 index 0000000..1625ce6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/package-use.html @@ -0,0 +1,207 @@ + + + + + + +Uses of Package com.amazon.carbonado.cursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.cursor

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/filter/AndFilter.html b/apidocs/com/amazon/carbonado/filter/AndFilter.html new file mode 100644 index 0000000..00e4c87 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/AndFilter.html @@ -0,0 +1,392 @@ + + + + + + +AndFilter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.filter
+

Class AndFilter<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Appender, java.io.Serializable
    +
    +
    +
    +
    public class AndFilter<S extends Storable>
+extends BinaryOpFilter<S>
    +
    Filter tree node that performs a logical 'and' test.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        not

        +
        public Filter<S> not()
        +
        Description copied from class: Filter
        +
        Returns the logical negation of this filter.
        +
        +
        Specified by:
        +
        not in class Filter<S extends Storable>
        +
        Returns:
        canonical Filter instance
        +
        • +
      + + + + + +
        +
      • +

        accept

        +
        public <R,P> R accept(Visitor<S,R,P> visitor,
+             P param)
        +
        Description copied from class: Filter
        +
        Accept the given visitor subclass to traverse the filter tree.
        +
        +
        Specified by:
        +
        accept in class Filter<S extends Storable>
        +
        Parameters:
        visitor - visitor to traverse through the tree
        param - generic input parameter passed to visit methods
        +
        Returns:
        generic return value passed from visit methods
        +
        • +
      + + + +
        +
      • +

        unbind

        +
        public Filter<S> unbind()
        +
        Description copied from class: Filter
        +
        Undoes the effect of a bind operation. The returned filter might still + report itself as bound if it doesn't make a distinction between these + states.
        +
        +
        Specified by:
        +
        unbind in class Filter<S extends Storable>
        +
        Returns:
        canonical Filter instance with unbound property filters
        +
        • +
      + + + + + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Specified by:
        +
        equals in class Filter<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        appendTo

        +
        public void appendTo(java.lang.Appendable app,
+            FilterValues<S> values)
+              throws java.io.IOException
        +
        Description copied from class: Filter
        +
        Appends the string value of this filter into the given Appendable.
        +
        +
        Specified by:
        +
        appendTo in class Filter<S extends Storable>
        +
        values - optionally supply filter values
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/filter/BinaryOpFilter.html b/apidocs/com/amazon/carbonado/filter/BinaryOpFilter.html new file mode 100644 index 0000000..d5eb470 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/BinaryOpFilter.html @@ -0,0 +1,322 @@ + + + + + + +BinaryOpFilter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.filter
+

Class BinaryOpFilter<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Appender, java.io.Serializable
    +
    +
    +
    Direct Known Subclasses:
    +
    AndFilter, OrFilter
    +
    +
    +
    +
    public abstract class BinaryOpFilter<S extends Storable>
+extends Filter<S>
    +
    Base class for filter tree nodes that have a left and right child.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/filter/ClosedFilter.html b/apidocs/com/amazon/carbonado/filter/ClosedFilter.html new file mode 100644 index 0000000..dca312a --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/ClosedFilter.html @@ -0,0 +1,589 @@ + + + + + + +ClosedFilter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.filter
+

Class ClosedFilter<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Appender, java.io.Serializable
    +
    +
    +
    +
    public class ClosedFilter<S extends Storable>
+extends Filter<S>
    +
    Filter which blocks any results from passing through.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isClosed

        +
        public final boolean isClosed()
        +
        Always returns true.
        +
        +
        Overrides:
        +
        isClosed in class Filter<S extends Storable>
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        and

        +
        public ClosedFilter<S> and(Filter<S> filter)
        +
        Description copied from class: Filter
        +
        Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.
        +
        +
        Overrides:
        +
        and in class Filter<S extends Storable>
        +
        Returns:
        canonical Filter instance
        +
        • +
      + + + +
        +
      • +

        or

        +
        public Filter<S> or(Filter<S> filter)
        +
        Description copied from class: Filter
        +
        Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.
        +
        +
        Overrides:
        +
        or in class Filter<S extends Storable>
        +
        Returns:
        canonical Filter instance
        +
        • +
      + + + +
        +
      • +

        not

        +
        public OpenFilter<S> not()
        +
        Description copied from class: Filter
        +
        Returns the logical negation of this filter.
        +
        +
        Specified by:
        +
        not in class Filter<S extends Storable>
        +
        Returns:
        canonical Filter instance
        +
        • +
      + + + +
        +
      • +

        disjunctiveNormalFormSplit

        +
        public java.util.List<Filter<S>> disjunctiveNormalFormSplit()
        +
        Description copied from class: Filter
        +
        Splits the filter from its disjunctive normal form. Or'ng the filters + together produces the full disjunctive normal form.
        +
        +
        Overrides:
        +
        disjunctiveNormalFormSplit in class Filter<S extends Storable>
        +
        Returns:
        unmodifiable list of sub filters which don't perform any 'or' + operations
        Since:
        +
        1.1.1
        +
        • +
      + + + +
        +
      • +

        conjunctiveNormalFormSplit

        +
        public java.util.List<Filter<S>> conjunctiveNormalFormSplit()
        +
        Description copied from class: Filter
        +
        Splits the filter from its conjunctive normal form. And'ng the filters + together produces the full conjunctive normal form.
        +
        +
        Overrides:
        +
        conjunctiveNormalFormSplit in class Filter<S extends Storable>
        +
        Returns:
        unmodifiable list of sub filters which don't perform any 'and' + operations
        Since:
        +
        1.1.1
        +
        • +
      + + + +
        +
      • +

        initialFilterValues

        +
        public FilterValues<S> initialFilterValues()
        +
        Description copied from class: Filter
        +
        Returns a FilterValues instance for assigning values to a + Filter. Returns null if Filter has no parameters. + +

        Note: The returned FilterValues instance may reference a different + filter instance than this one. Call getFilter to retrieve it. The + difference is caused by the filter property values being bound.

        +
        +
        Overrides:
        +
        initialFilterValues in class Filter<S extends Storable>
        +
        +
        • +
      + + + + + +
        +
      • +

        accept

        +
        public <R,P> R accept(Visitor<S,R,P> visitor,
+             P param)
        +
        Description copied from class: Filter
        +
        Accept the given visitor subclass to traverse the filter tree.
        +
        +
        Specified by:
        +
        accept in class Filter<S extends Storable>
        +
        Parameters:
        visitor - visitor to traverse through the tree
        param - generic input parameter passed to visit methods
        +
        Returns:
        generic return value passed from visit methods
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public ClosedFilter<S> bind()
        +
        Description copied from class: Filter
        +
        Walks through each property filter, assigning a bind ID to it. This step + is automatically performed for proper dnf/cnf conversion, and for + building FilterValues.
        +
        +
        Specified by:
        +
        bind in class Filter<S extends Storable>
        +
        Returns:
        canonical Filter instance with bound property filters
        +
        • +
      + + + +
        +
      • +

        unbind

        +
        public ClosedFilter<S> unbind()
        +
        Description copied from class: Filter
        +
        Undoes the effect of a bind operation. The returned filter might still + report itself as bound if it doesn't make a distinction between these + states.
        +
        +
        Specified by:
        +
        unbind in class Filter<S extends Storable>
        +
        Returns:
        canonical Filter instance with unbound property filters
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Specified by:
        +
        equals in class Filter<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Description copied from class: Filter
        +
        Returns the string value of this filter, which is also parsable.
        +
        +
        Overrides:
        +
        toString in class Filter<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        appendTo

        +
        public void appendTo(java.lang.Appendable app,
+            FilterValues<S> values)
+              throws java.io.IOException
        +
        Description copied from class: Filter
        +
        Appends the string value of this filter into the given Appendable.
        +
        +
        Specified by:
        +
        appendTo in class Filter<S extends Storable>
        +
        values - optionally supply filter values
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/filter/ExistsFilter.html b/apidocs/com/amazon/carbonado/filter/ExistsFilter.html new file mode 100644 index 0000000..56340e6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/ExistsFilter.html @@ -0,0 +1,509 @@ + + + + + + +ExistsFilter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.filter
+

Class ExistsFilter<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Appender, java.io.Serializable
    +
    +
    +
    +
    public class ExistsFilter<S extends Storable>
+extends Filter<S>
    +
    Filter tree node that performs an existence or non-existence test against a + join property.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getChainedProperty

        +
        public ChainedProperty<S> getChainedProperty()
        +
        Returns the join property that is being checked for existence or + non-existence. The last property in the chain is a one-to-many or + many-to-one join, but it is a many-to-one join only if the sub-filter is + also open.
        +
        Returns:
        chained property whose last property is a join
        +
        • +
      + + + +
        +
      • +

        getSubFilter

        +
        public Filter<?> getSubFilter()
        +
        Returns the filter applied to the join, which might be open. For a + many-to-one join, the sub-filter is always open.
        +
        Returns:
        filter which is applied to last property of chain
        +
        • +
      + + + +
        +
      • +

        isNotExists

        +
        public boolean isNotExists()
        +
        Returns:
        true if this filter is testing for "not exists"
        +
        • +
      + + + +
        +
      • +

        not

        +
        public Filter<S> not()
        +
        Description copied from class: Filter
        +
        Returns the logical negation of this filter.
        +
        +
        Specified by:
        +
        not in class Filter<S extends Storable>
        +
        Returns:
        canonical Filter instance
        +
        • +
      + + + +
        +
      • +

        initialFilterValues

        +
        public FilterValues<S> initialFilterValues()
        +
        Description copied from class: Filter
        +
        Returns a FilterValues instance for assigning values to a + Filter. Returns null if Filter has no parameters. + +

        Note: The returned FilterValues instance may reference a different + filter instance than this one. Call getFilter to retrieve it. The + difference is caused by the filter property values being bound.

        +
        +
        Overrides:
        +
        initialFilterValues in class Filter<S extends Storable>
        +
        +
        • +
      + + + + + +
        +
      • +

        accept

        +
        public <R,P> R accept(Visitor<S,R,P> visitor,
+             P param)
        +
        Description copied from class: Filter
        +
        Accept the given visitor subclass to traverse the filter tree.
        +
        +
        Specified by:
        +
        accept in class Filter<S extends Storable>
        +
        Parameters:
        visitor - visitor to traverse through the tree
        param - generic input parameter passed to visit methods
        +
        Returns:
        generic return value passed from visit methods
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public ExistsFilter<S> bind()
        +
        Description copied from class: Filter
        +
        Walks through each property filter, assigning a bind ID to it. This step + is automatically performed for proper dnf/cnf conversion, and for + building FilterValues.
        +
        +
        Specified by:
        +
        bind in class Filter<S extends Storable>
        +
        Returns:
        canonical Filter instance with bound property filters
        +
        • +
      + + + +
        +
      • +

        unbind

        +
        public ExistsFilter<S> unbind()
        +
        Description copied from class: Filter
        +
        Undoes the effect of a bind operation. The returned filter might still + report itself as bound if it doesn't make a distinction between these + states.
        +
        +
        Specified by:
        +
        unbind in class Filter<S extends Storable>
        +
        Returns:
        canonical Filter instance with unbound property filters
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Specified by:
        +
        equals in class Filter<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        appendTo

        +
        public void appendTo(java.lang.Appendable app,
+            FilterValues<S> values)
+              throws java.io.IOException
        +
        Description copied from class: Filter
        +
        Appends the string value of this filter into the given Appendable.
        +
        +
        Specified by:
        +
        appendTo in class Filter<S extends Storable>
        +
        values - optionally supply filter values
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/filter/Filter.NotJoined.html b/apidocs/com/amazon/carbonado/filter/Filter.NotJoined.html new file mode 100644 index 0000000..8be4c34 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/Filter.NotJoined.html @@ -0,0 +1,301 @@ + + + + + + +Filter.NotJoined (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.filter
+

Class Filter.NotJoined

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object obj) 
      Filter<?>getNotJoinedFilter() +
      Returns the filter which is no longer as from a join.
      +
      Filter<S>getRemainderFilter() +
      Returns the filter which could not be separated.
      +
      inthashCode() 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getNotJoinedFilter

        +
        public Filter<?> getNotJoinedFilter()
        +
        Returns the filter which is no longer as from a join.
        +
        Returns:
        not joined filter or open filter if none
        +
        • +
      + + + +
        +
      • +

        getRemainderFilter

        +
        public Filter<S> getRemainderFilter()
        +
        Returns the filter which could not be separated.
        +
        Returns:
        remainder filter or open filter if none
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/filter/Filter.html b/apidocs/com/amazon/carbonado/filter/Filter.html new file mode 100644 index 0000000..93a2974 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/Filter.html @@ -0,0 +1,1151 @@ + + + + + + +Filter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.filter
+

Class Filter<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Appender, java.io.Serializable
    +
    +
    +
    Direct Known Subclasses:
    +
    BinaryOpFilter, ClosedFilter, ExistsFilter, OpenFilter, PropertyFilter
    +
    +
    +
    +
    public abstract class Filter<S extends Storable>
+extends java.lang.Object
+implements java.io.Serializable, Appender
    +
    An immutable tree structure representing a query result filter. Filters can + be created using a builder pattern, by expression parsing, or by a + combination of techniques. Filter instances are canonical, which means that + equivalent instances can be compared for equality using the '==' operator. + +

    Any method that accepts a filter expression parses against the following + syntax: + + 

    + Filter          = OrFilter
+ OrFilter        = AndFilter { "|" AndFilter }
+ AndFilter       = NotFilter { "&" NotFilter }
+ NotFilter       = [ "!" ] EntityFilter
+ EntityFilter    = PropertyFilter
+                 | ChainedFilter
+                 | "(" Filter ")"
+ PropertyFilter  = ChainedProperty RelOp "?"
+ RelOp           = "=" | "!=" | "<" | ">=" | ">" | "<="
+ ChainedFilter   = ChainedProperty "(" [ Filter ] ")"
+ ChainedProperty = Identifier
+                 | InnerJoin "." ChainedProperty
+                 | OuterJoin "." ChainedProperty
+ InnerJoin       = Identifier
+ OuterJoin       = "(" Identifier ")"
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      abstract <R,P> Raccept(Visitor<S,R,P> visitor, + P param) +
      Accept the given visitor subclass to traverse the filter tree.
      +
      Filter<S>and(Filter<S> filter) +
      Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.
      +
      Filter<S>and(java.lang.String expression) +
      Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.
      +
      Filter<S>and(java.lang.String propertyName, + RelOp operator) +
      Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.
      +
      Filter<S>and(java.lang.String propertyName, + RelOp operator, + java.lang.Object constantValue) +
      Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.
      +
      Filter<S>andExists(java.lang.String propertyName, + Filter<?> subFilter) +
      Returns a combined filter instance that accepts records which are only + accepted by this filter and the "exists" test applied to a join.
      +
      Filter<S>andNotExists(java.lang.String propertyName, + Filter<?> subFilter) +
      Returns a combined filter instance that accepts records which are only + accepted by this filter and the "not exists" test applied to a join.
      +
      voidappendTo(java.lang.Appendable app) +
      Appends the string value of this filter into the given Appendable.
      +
      abstract voidappendTo(java.lang.Appendable app, + FilterValues<S> values) +
      Appends the string value of this filter into the given Appendable.
      +
      <T extends Storable> 
      Filter<T>      		asJoinedFrom(ChainedProperty<T> joinProperty) +
      Prepends a join property to all properties of this filter.
      +
      <T extends Storable> 
      Filter<T>      		asJoinedFrom(java.lang.Class<T> type, + java.lang.String joinProperty) +
      Prepends a join property to all properties of this filter.
      +
      abstract <T extends Storable> 
      Filter<T>      		asJoinedFromAny(ChainedProperty<T> joinProperty) +
      Allows join from any property type, including one-to-many joins.
      +
      abstract Filter<S>bind() +
      Walks through each property filter, assigning a bind ID to it.
      +
      Filter<S>conjunctiveNormalForm() +
      Returns an equivalent filter that is in conjunctive normal form.
      +
      java.util.List<Filter<S>>conjunctiveNormalFormSplit() +
      Splits the filter from its conjunctive normal form.
      +
      Filter<S>disjunctiveNormalForm() +
      Returns an equivalent filter that is in disjunctive normal form.
      +
      java.util.List<Filter<S>>disjunctiveNormalFormSplit() +
      Splits the filter from its disjunctive normal form.
      +
      abstract booleanequals(java.lang.Object obj) 
      static <S extends Storable> 
      Filter<S>      		filterFor(java.lang.Class<S> type, + java.lang.String expression) +
      Returns a cached filter instance that operates on the given type and + filter expression.
      +
      static <S extends Storable> 
      ClosedFilter<S>      		getClosedFilter(java.lang.Class<S> type) +
      Returns a cached filter instance that operates on the given type, which + prevents any results from passing through.
      +
      static <S extends Storable> 
      OpenFilter<S>      		getOpenFilter(java.lang.Class<S> type) +
      Returns a cached filter instance that operates on the given type, which + allows all results to pass through.
      +
      java.lang.Class<S>getStorableType() +
      Returns the storable type that this filter operates on.
      +
      inthashCode() 
      FilterValues<S>initialFilterValues() +
      Returns a FilterValues instance for assigning values to a + Filter.
      +
      abstract booleanisBound() +
      Returns true if all property filters are known to be properly + bound.
      +
      booleanisClosed() +
      Returns true if filter prevents any results from passing through.
      +
      booleanisOpen() +
      Returns true if filter allows all results to pass through.
      +
      abstract Filter<S>not() +
      Returns the logical negation of this filter.
      +
      Filter.NotJoinednotJoinedFrom(ChainedProperty<S> joinProperty) +
      Removes a join property prefix from all applicable properties of this + filter.
      +
      Filter.NotJoinednotJoinedFrom(java.lang.String joinProperty) +
      Removes a join property prefix from all applicable properties of this + filter.
      +
      Filter<S>or(Filter<S> filter) +
      Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.
      +
      Filter<S>or(java.lang.String expression) +
      Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.
      +
      Filter<S>or(java.lang.String propertyName, + RelOp operator) +
      Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.
      +
      Filter<S>or(java.lang.String propertyName, + RelOp operator, + java.lang.Object constantValue) +
      Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.
      +
      Filter<S>orExists(java.lang.String propertyName, + Filter<?> subFilter) +
      Returns a combined filter instance that accepts records which are + accepted either by this filter or the "exists" test applied to a join.
      +
      Filter<S>orNotExists(java.lang.String propertyName, + Filter<?> subFilter) +
      Returns a combined filter instance that accepts records which are + accepted either by this filter or the "not exists" test applied to a + join.
      +
      Filter<S>reduce() +
      Returns an equivalent filter with redundant terms eliminated.
      +
      java.lang.StringtoString() +
      Returns the string value of this filter, which is also parsable.
      +
      abstract Filter<S>unbind() +
      Undoes the effect of a bind operation.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        filterFor

        +
        public static <S extends Storable> Filter<S> filterFor(java.lang.Class<S> type,
+                                       java.lang.String expression)
        +
        Returns a cached filter instance that operates on the given type and + filter expression.
        +
        Parameters:
        type - type of Storable that query is made against
        expression - query filter expression to parse
        +
        Returns:
        canonical Filter instance
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if type or filter expression is null
        +
        MalformedFilterException - if filter expression is malformed
        +
        • +
      + + + +
        +
      • +

        getOpenFilter

        +
        public static <S extends Storable> OpenFilter<S> getOpenFilter(java.lang.Class<S> type)
        +
        Returns a cached filter instance that operates on the given type, which + allows all results to pass through.
        +
        Parameters:
        type - type of Storable that query is made against
        +
        Returns:
        canonical Filter instance
        See Also:
        OpenFilter
        +
        • +
      + + + +
        +
      • +

        getClosedFilter

        +
        public static <S extends Storable> ClosedFilter<S> getClosedFilter(java.lang.Class<S> type)
        +
        Returns a cached filter instance that operates on the given type, which + prevents any results from passing through.
        +
        Parameters:
        type - type of Storable that query is made against
        +
        Returns:
        canonical Filter instance
        See Also:
        ClosedFilter
        +
        • +
      + + + +
        +
      • +

        getStorableType

        +
        public java.lang.Class<S> getStorableType()
        +
        Returns the storable type that this filter operates on.
        +
        • +
      + + + +
        +
      • +

        initialFilterValues

        +
        public FilterValues<S> initialFilterValues()
        +
        Returns a FilterValues instance for assigning values to a + Filter. Returns null if Filter has no parameters. + +

        Note: The returned FilterValues instance may reference a different + filter instance than this one. Call getFilter to retrieve it. The + difference is caused by the filter property values being bound.

        +
        • +
      + + + +
        +
      • +

        and

        +
        public final Filter<S> and(java.lang.String expression)
        +
        Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.
        +
        Parameters:
        expression - query filter expression to parse
        +
        Returns:
        canonical Filter instance
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if filter is null
        +
        • +
      + + + +
        +
      • +

        and

        +
        public Filter<S> and(Filter<S> filter)
        +
        Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.
        +
        Returns:
        canonical Filter instance
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if filter is null
        +
        • +
      + + + +
        +
      • +

        and

        +
        public final Filter<S> and(java.lang.String propertyName,
+            RelOp operator)
        +
        Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.
        +
        Parameters:
        propertyName - property name to match on, which may be a chained property
        operator - relational operator
        +
        Returns:
        canonical Filter instance
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if property is not found
        +
        • +
      + + + +
        +
      • +

        and

        +
        public final Filter<S> and(java.lang.String propertyName,
+            RelOp operator,
+            java.lang.Object constantValue)
        +
        Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.
        +
        Parameters:
        propertyName - property name to match on, which may be a chained property
        operator - relational operator
        constantValue - constant value to match
        +
        Returns:
        canonical Filter instance
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if property is not found
        +
        • +
      + + + +
        +
      • +

        andExists

        +
        public final Filter<S> andExists(java.lang.String propertyName,
+                  Filter<?> subFilter)
        +
        Returns a combined filter instance that accepts records which are only + accepted by this filter and the "exists" test applied to a join.
        +
        Parameters:
        propertyName - join property name, which may be a chained property
        subFilter - sub-filter to apply to join, which may be null to test + for any existing
        +
        Returns:
        canonical Filter instance
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if property is not found
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        andNotExists

        +
        public final Filter<S> andNotExists(java.lang.String propertyName,
+                     Filter<?> subFilter)
        +
        Returns a combined filter instance that accepts records which are only + accepted by this filter and the "not exists" test applied to a join.
        +
        Parameters:
        propertyName - join property name, which may be a chained property
        subFilter - sub-filter to apply to join, which may be null to test + for any not existing
        +
        Returns:
        canonical Filter instance
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if property is not found
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        or

        +
        public final Filter<S> or(java.lang.String expression)
        +
        Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.
        +
        Parameters:
        expression - query filter expression to parse
        +
        Returns:
        canonical Filter instance
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if filter is null
        +
        • +
      + + + +
        +
      • +

        or

        +
        public Filter<S> or(Filter<S> filter)
        +
        Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.
        +
        Returns:
        canonical Filter instance
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if filter is null
        +
        • +
      + + + +
        +
      • +

        or

        +
        public final Filter<S> or(java.lang.String propertyName,
+           RelOp operator)
        +
        Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.
        +
        Parameters:
        propertyName - property name to match on, which may be a chained property
        operator - relational operator
        +
        Returns:
        canonical Filter instance
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if property is not found
        +
        • +
      + + + +
        +
      • +

        or

        +
        public final Filter<S> or(java.lang.String propertyName,
+           RelOp operator,
+           java.lang.Object constantValue)
        +
        Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.
        +
        Parameters:
        propertyName - property name to match on, which may be a chained property
        operator - relational operator
        constantValue - constant value to match
        +
        Returns:
        canonical Filter instance
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if property is not found
        +
        • +
      + + + +
        +
      • +

        orExists

        +
        public final Filter<S> orExists(java.lang.String propertyName,
+                 Filter<?> subFilter)
        +
        Returns a combined filter instance that accepts records which are + accepted either by this filter or the "exists" test applied to a join.
        +
        Parameters:
        propertyName - one-to-many join property name, which may be a chained property
        subFilter - sub-filter to apply to join, which may be null to test + for any existing
        +
        Returns:
        canonical Filter instance
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if property is not found
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        orNotExists

        +
        public final Filter<S> orNotExists(java.lang.String propertyName,
+                    Filter<?> subFilter)
        +
        Returns a combined filter instance that accepts records which are + accepted either by this filter or the "not exists" test applied to a + join.
        +
        Parameters:
        propertyName - one-to-many join property name, which may be a chained property
        subFilter - sub-filter to apply to join, which may be null to test + for any not existing
        +
        Returns:
        canonical Filter instance
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if property is not found
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        not

        +
        public abstract Filter<S> not()
        +
        Returns the logical negation of this filter.
        +
        Returns:
        canonical Filter instance
        +
        • +
      + + + +
        +
      • +

        disjunctiveNormalForm

        +
        public final Filter<S> disjunctiveNormalForm()
        +
        Returns an equivalent filter that is in disjunctive normal form. In this + form, all logical 'and' operations are performed before all logical 'or' + operations. This method often returns a filter with more terms than + before. + +

        The tree is also normalized such that all terms in a common logical + operation are ordered left to right. For example, expressions of the + form "(a = ? & b = ?) & (c = ? & d = ?)" are converted to + "(((a = ?) & (b = ?)) & c = ?) & d = ?". + +

        Although the disjunctive normal filter may have more terms, it can be + used to extract values from a FilterValues instance created from this + filter. This works because the disjunctive normal filter is composed of + the same set of PropertyFilter instances.

        +
        Returns:
        canonical Filter instance
        +
        • +
      + + + +
        +
      • +

        disjunctiveNormalFormSplit

        +
        public java.util.List<Filter<S>> disjunctiveNormalFormSplit()
        +
        Splits the filter from its disjunctive normal form. Or'ng the filters + together produces the full disjunctive normal form.
        +
        Returns:
        unmodifiable list of sub filters which don't perform any 'or' + operations
        Since:
        +
        1.1.1
        +
        • +
      + + + +
        +
      • +

        conjunctiveNormalForm

        +
        public final Filter<S> conjunctiveNormalForm()
        +
        Returns an equivalent filter that is in conjunctive normal form. In this + form, all logical 'or' operations are performed before all logical 'and' + operations. This method often returns a filter with more terms than + before. + +

        The tree is also normalized such that all terms in a common logical + operation are ordered left to right. For example, expressions of the + form "(a = ? | b = ?) | (c = ? | d = ?)" are converted to + "(((a = ?) | (b = ?)) | c = ?) | d = ?". + +

        Although the conjunctive normal filter may have more terms, it can be + used to extract values from a FilterValues instance created from this + filter. This works because the conjunctive normal filter is composed of + the same set of PropertyFilter instances.

        +
        Returns:
        canonical Filter instance
        +
        • +
      + + + +
        +
      • +

        conjunctiveNormalFormSplit

        +
        public java.util.List<Filter<S>> conjunctiveNormalFormSplit()
        +
        Splits the filter from its conjunctive normal form. And'ng the filters + together produces the full conjunctive normal form.
        +
        Returns:
        unmodifiable list of sub filters which don't perform any 'and' + operations
        Since:
        +
        1.1.1
        +
        • +
      + + + + + +
        +
      • +

        accept

        +
        public abstract <R,P> R accept(Visitor<S,R,P> visitor,
+             P param)
        +
        Accept the given visitor subclass to traverse the filter tree.
        +
        Parameters:
        visitor - visitor to traverse through the tree
        param - generic input parameter passed to visit methods
        +
        Returns:
        generic return value passed from visit methods
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public abstract Filter<S> bind()
        +
        Walks through each property filter, assigning a bind ID to it. This step + is automatically performed for proper dnf/cnf conversion, and for + building FilterValues.
        +
        Returns:
        canonical Filter instance with bound property filters
        +
        • +
      + + + +
        +
      • +

        unbind

        +
        public abstract Filter<S> unbind()
        +
        Undoes the effect of a bind operation. The returned filter might still + report itself as bound if it doesn't make a distinction between these + states.
        +
        Returns:
        canonical Filter instance with unbound property filters
        +
        • +
      + + + + + + + +
        +
      • +

        reduce

        +
        public final Filter<S> reduce()
        +
        Returns an equivalent filter with redundant terms eliminated. The tree + is also normalized such that all terms in a common logical operation are + ordered left to right. For example, expressions of the form + "(a = ? & b = ?) & (c = ? & d = ?)" are converted to + "(((a = ?) & (b = ?)) & c = ?) & d = ?".
        +
        Returns:
        canonical Filter instance
        +
        • +
      + + + +
        +
      • +

        asJoinedFrom

        +
        public final <T extends Storable> Filter<T> asJoinedFrom(java.lang.Class<T> type,
+                                          java.lang.String joinProperty)
        +
        Prepends a join property to all properties of this filter. For example, + consider two Storable types, Person and Address. Person has a property + "homeAddress" which joins to Address. An Address filter, "city = ?", as + joined from Person's "homeAddress", becomes "homeAddress.city = ?". + + 
        + Filter<Address> addressFilter = Filter.filterFor(Address.class, "city = ?");
+ Filter<Person> personFilter = addressFilter.asJoinedFrom(Person.class, "homeAddress");
+
+ // Equivalent filter:
+ Filter<Person> personFilter2 = Filter.filterFor(Person.class, "homeAddress.city = ?");
+
        +
        Parameters:
        type - type of T which contains join property
        joinProperty - property of T which joins to this Filter's Storable type
        +
        Returns:
        filter for type T
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if property does not exist or is not a + join to type S
        +
        • +
      + + + +
        +
      • +

        asJoinedFrom

        +
        public final <T extends Storable> Filter<T> asJoinedFrom(ChainedProperty<T> joinProperty)
        +
        Prepends a join property to all properties of this filter. For example, + consider two Storable types, Person and Address. Person has a property + "homeAddress" which joins to Address. An Address filter, "city = ?", as + joined from Person's "homeAddress", becomes "homeAddress.city = ?".
        +
        Parameters:
        joinProperty - property of T which joins to this Filter's Storable type
        +
        Returns:
        filter for type T
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if property is not a join to type S
        +
        • +
      + + + +
        +
      • +

        asJoinedFromAny

        +
        public abstract <T extends Storable> Filter<T> asJoinedFromAny(ChainedProperty<T> joinProperty)
        +
        Allows join from any property type, including one-to-many joins.
        +
        • +
      + + + +
        +
      • +

        notJoinedFrom

        +
        public final Filter.NotJoined notJoinedFrom(java.lang.String joinProperty)
        +
        Removes a join property prefix from all applicable properties of this + filter. For example, consider two Storable types, Person and + Address. Person has a property "homeAddress" which joins to Address. A + Person filter might be "homeAddress.city = ? & lastName = ?". When not + joined from "homeAddress", it becomes "city = ?" on Address with a + remainder of "lastName = ?" on Person. + +

        The resulting remainder filter (if any) is always logically and'd to + the not joined filter. In order to achieve this, the original filter is + first converted to conjunctive normal form. And as a side affect, both + the remainder and not joined filters are bound.

        +
        Parameters:
        joinProperty - property to not join from
        +
        Returns:
        not join result
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if property does not exist or if + property does not refer to a Storable
        +
        • +
      + + + +
        +
      • +

        notJoinedFrom

        +
        public final Filter.NotJoined notJoinedFrom(ChainedProperty<S> joinProperty)
        +
        Removes a join property prefix from all applicable properties of this + filter. For example, consider two Storable types, Person and + Address. Person has a property "homeAddress" which joins to Address. A + Person filter might be "homeAddress.city = ? & lastName = ?". When not + joined from "homeAddress", it becomes "city = ?" on Address with a + remainder of "lastName = ?" on Person. + +

        The resulting remainder filter (if any) is always logically and'd to + the not joined filter. In order to achieve this, the original filter is + first converted to conjunctive normal form. And as a side affect, both + the remainder and not joined filters are bound.

        +
        Parameters:
        joinProperty - property to not join from
        +
        Returns:
        not join result
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if property does not refer to a Storable
        +
        • +
      + + + +
        +
      • +

        isOpen

        +
        public boolean isOpen()
        +
        Returns true if filter allows all results to pass through.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        isClosed

        +
        public boolean isClosed()
        +
        Returns true if filter prevents any results from passing through.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public abstract boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Returns the string value of this filter, which is also parsable.
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        appendTo

        +
        public void appendTo(java.lang.Appendable app)
+              throws java.io.IOException
        +
        Appends the string value of this filter into the given Appendable.
        +
        +
        Specified by:
        +
        appendTo in interface Appender
        +
        Parameters:
        app - Appendable object to receive string representation
        +
        Throws:
        +
        java.io.IOException - if thrown from given Appendable
        +
        • +
      + + + +
        +
      • +

        appendTo

        +
        public abstract void appendTo(java.lang.Appendable app,
+            FilterValues<S> values)
+                       throws java.io.IOException
        +
        Appends the string value of this filter into the given Appendable.
        +
        Parameters:
        values - optionally supply filter values
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/filter/FilterValues.html b/apidocs/com/amazon/carbonado/filter/FilterValues.html new file mode 100644 index 0000000..6bf1751 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/FilterValues.html @@ -0,0 +1,677 @@ + + + + + + +FilterValues (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.filter
+

Class FilterValues<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Appender, java.io.Serializable
    +
    +
    +
    +
    public class FilterValues<S extends Storable>
+extends java.lang.Object
+implements java.io.Serializable, Appender
    +
    Assigns values to Filter placeholders. FilterValues instances are + immutable.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidappendTo(java.lang.Appendable app) +
      Append the string representation of this object to the given Appendable.
      +
      booleanequals(java.lang.Object obj) 
      java.lang.ObjectgetAssignedValue(PropertyFilter<S> propFilter) +
      Returns the value assigned to the given PropertyFilter, throwing an + exception if not assigned.
      +
      intgetBlankParameterCount() +
      Returns the amount of values yet to be assigned.
      +
      Filter<S>getFilter() +
      Returns the Filter that this FilterValues instance applies to.
      +
      java.lang.Object[]getSuppliedValues() +
      Returns all supplied values in this object.
      +
      java.lang.Object[]getSuppliedValuesFor(Filter<S> filter) +
      Returns all supplied values in this object, as required by the given + Filter.
      +
      java.lang.ObjectgetValue(PropertyFilter<S> propFilter) +
      Returns the value assigned to the given PropertyFilter.
      +
      java.lang.Object[]getValues() +
      Returns all values in this object, including those provided by filter + constants.
      +
      java.lang.Object[]getValuesFor(Filter<S> filter) +
      Returns all values in this object, as required by the given Filter.
      +
      inthashCode() 
      booleanisAssigned(PropertyFilter<S> propFilter) +
      Returns true if a value is assigned to the given PropertyFilter.
      +
      java.lang.StringtoString() +
      Returns the string value of the filter with any values substituted.
      +
      FilterValues<S>with(boolean value) +
      Returns a new FilterValues instance with the next blank parameter filled in.
      +
      FilterValues<S>with(byte value) +
      Returns a new FilterValues instance with the next blank parameter filled in.
      +
      FilterValues<S>with(char value) +
      Returns a new FilterValues instance with the next blank parameter filled in.
      +
      FilterValues<S>with(double value) +
      Returns a new FilterValues instance with the next blank parameter filled in.
      +
      FilterValues<S>with(float value) +
      Returns a new FilterValues instance with the next blank parameter filled in.
      +
      FilterValues<S>with(int value) +
      Returns a new FilterValues instance with the next blank parameter filled in.
      +
      FilterValues<S>with(long value) +
      Returns a new FilterValues instance with the next blank parameter filled in.
      +
      FilterValues<S>with(java.lang.Object value) +
      Returns a new FilterValues instance with the next blank parameter filled in.
      +
      FilterValues<S>with(short value) +
      Returns a new FilterValues instance with the next blank parameter filled in.
      +
      FilterValues<S>withValues(java.lang.Object... values) +
      Returns a new FilterValues instance with the next blank parameters filled in.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFilter

        +
        public Filter<S> getFilter()
        +
        Returns the Filter that this FilterValues instance applies to.
        +
        • +
      + + + +
        +
      • +

        with

        +
        public FilterValues<S> with(int value)
        +
        Returns a new FilterValues instance with the next blank parameter filled in.
        +
        Parameters:
        value - parameter value to fill in
        +
        Throws:
        +
        java.lang.IllegalStateException - if no blank parameters
        +
        java.lang.IllegalArgumentException - if type doesn't match
        +
        • +
      + + + +
        +
      • +

        with

        +
        public FilterValues<S> with(long value)
        +
        Returns a new FilterValues instance with the next blank parameter filled in.
        +
        Parameters:
        value - parameter value to fill in
        +
        Throws:
        +
        java.lang.IllegalStateException - if no blank parameters
        +
        java.lang.IllegalArgumentException - if type doesn't match
        +
        • +
      + + + +
        +
      • +

        with

        +
        public FilterValues<S> with(float value)
        +
        Returns a new FilterValues instance with the next blank parameter filled in.
        +
        Parameters:
        value - parameter value to fill in
        +
        Throws:
        +
        java.lang.IllegalStateException - if no blank parameters
        +
        java.lang.IllegalArgumentException - if type doesn't match
        +
        • +
      + + + +
        +
      • +

        with

        +
        public FilterValues<S> with(double value)
        +
        Returns a new FilterValues instance with the next blank parameter filled in.
        +
        Parameters:
        value - parameter value to fill in
        +
        Throws:
        +
        java.lang.IllegalStateException - if no blank parameters
        +
        java.lang.IllegalArgumentException - if type doesn't match
        +
        • +
      + + + +
        +
      • +

        with

        +
        public FilterValues<S> with(boolean value)
        +
        Returns a new FilterValues instance with the next blank parameter filled in.
        +
        Parameters:
        value - parameter value to fill in
        +
        Throws:
        +
        java.lang.IllegalStateException - if no blank parameters
        +
        java.lang.IllegalArgumentException - if type doesn't match
        +
        • +
      + + + +
        +
      • +

        with

        +
        public FilterValues<S> with(char value)
        +
        Returns a new FilterValues instance with the next blank parameter filled in.
        +
        Parameters:
        value - parameter value to fill in
        +
        Throws:
        +
        java.lang.IllegalStateException - if no blank parameters
        +
        java.lang.IllegalArgumentException - if type doesn't match
        +
        • +
      + + + +
        +
      • +

        with

        +
        public FilterValues<S> with(byte value)
        +
        Returns a new FilterValues instance with the next blank parameter filled in.
        +
        Parameters:
        value - parameter value to fill in
        +
        Throws:
        +
        java.lang.IllegalStateException - if no blank parameters
        +
        java.lang.IllegalArgumentException - if type doesn't match
        +
        • +
      + + + +
        +
      • +

        with

        +
        public FilterValues<S> with(short value)
        +
        Returns a new FilterValues instance with the next blank parameter filled in.
        +
        Parameters:
        value - parameter value to fill in
        +
        Throws:
        +
        java.lang.IllegalStateException - if no blank parameters
        +
        java.lang.IllegalArgumentException - if type doesn't match
        +
        • +
      + + + +
        +
      • +

        with

        +
        public FilterValues<S> with(java.lang.Object value)
        +
        Returns a new FilterValues instance with the next blank parameter filled in.
        +
        Parameters:
        value - parameter value to fill in
        +
        Throws:
        +
        java.lang.IllegalStateException - if no blank parameters
        +
        java.lang.IllegalArgumentException - if type doesn't match
        +
        • +
      + + + +
        +
      • +

        withValues

        +
        public FilterValues<S> withValues(java.lang.Object... values)
        +
        Returns a new FilterValues instance with the next blank parameters filled in.
        +
        Parameters:
        values - parameter values to fill in; if null or empty, this + FilterValues instance is returned
        +
        Throws:
        +
        java.lang.IllegalStateException - if no blank parameters or if too many + parameter values supplied
        +
        java.lang.IllegalArgumentException - if type doesn't match
        +
        • +
      + + + +
        +
      • +

        getBlankParameterCount

        +
        public int getBlankParameterCount()
        +
        Returns the amount of values yet to be assigned.
        +
        • +
      + + + +
        +
      • +

        getValue

        +
        public java.lang.Object getValue(PropertyFilter<S> propFilter)
        +
        Returns the value assigned to the given PropertyFilter. If null, value + may be unassigned. Call getAssignedValue to have an exception thrown + instead.
        +
        • +
      + + + +
        +
      • +

        getAssignedValue

        +
        public java.lang.Object getAssignedValue(PropertyFilter<S> propFilter)
+                                  throws java.lang.IllegalStateException
        +
        Returns the value assigned to the given PropertyFilter, throwing an + exception if not assigned. Call getValue to have null returned instead.
        +
        Throws:
        +
        java.lang.IllegalStateException - if value is blank
        +
        • +
      + + + +
        +
      • +

        isAssigned

        +
        public boolean isAssigned(PropertyFilter<S> propFilter)
        +
        Returns true if a value is assigned to the given PropertyFilter.
        +
        • +
      + + + +
        +
      • +

        getValues

        +
        public java.lang.Object[] getValues()
+                             throws java.lang.IllegalStateException
        +
        Returns all values in this object, including those provided by filter + constants. An IllegalStateException will result if any values are blank.
        +
        Returns:
        new object array
        +
        Throws:
        +
        java.lang.IllegalStateException - if any values are blank
        +
        • +
      + + + +
        +
      • +

        getSuppliedValues

        +
        public java.lang.Object[] getSuppliedValues()
        +
        Returns all supplied values in this object. Constant filter values are + not included.
        +
        Returns:
        new object array
        +
        • +
      + + + +
        +
      • +

        getValuesFor

        +
        public java.lang.Object[] getValuesFor(Filter<S> filter)
+                                throws java.lang.IllegalStateException
        +
        Returns all values in this object, as required by the given Filter. The + given Filter must be composed only of the same PropertyFilter instances + as used to construct this object. An IllegalStateException will result + otherwise.
        +
        Parameters:
        filter - filter must be bound
        +
        Returns:
        new object array
        +
        Throws:
        +
        java.lang.IllegalStateException - if any values are blank
        +
        • +
      + + + +
        +
      • +

        getSuppliedValuesFor

        +
        public java.lang.Object[] getSuppliedValuesFor(Filter<S> filter)
+                                        throws java.lang.IllegalStateException
        +
        Returns all supplied values in this object, as required by the given + Filter. Constant filter values are not included. The given Filter must + be composed only of the same PropertyFilter instances as used to + construct this object. An IllegalStateException will result otherwise.
        +
        Parameters:
        filter - filter must be bound
        +
        Returns:
        new object array
        +
        Throws:
        +
        java.lang.IllegalStateException
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Returns the string value of the filter with any values substituted.
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        appendTo

        +
        public void appendTo(java.lang.Appendable app)
+              throws java.io.IOException
        +
        Description copied from interface: Appender
        +
        Append the string representation of this object to the given Appendable.
        +
        +
        Specified by:
        +
        appendTo in interface Appender
        +
        Parameters:
        app - Appendable object to receive string representation
        +
        Throws:
        +
        java.io.IOException - if thrown from given Appendable
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/filter/OpenFilter.html b/apidocs/com/amazon/carbonado/filter/OpenFilter.html new file mode 100644 index 0000000..33bdada --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/OpenFilter.html @@ -0,0 +1,589 @@ + + + + + + +OpenFilter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.filter
+

Class OpenFilter<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Appender, java.io.Serializable
    +
    +
    +
    +
    public class OpenFilter<S extends Storable>
+extends Filter<S>
    +
    Filter which lets all results pass through.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isOpen

        +
        public final boolean isOpen()
        +
        Always returns true.
        +
        +
        Overrides:
        +
        isOpen in class Filter<S extends Storable>
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        and

        +
        public Filter<S> and(Filter<S> filter)
        +
        Description copied from class: Filter
        +
        Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.
        +
        +
        Overrides:
        +
        and in class Filter<S extends Storable>
        +
        Returns:
        canonical Filter instance
        +
        • +
      + + + +
        +
      • +

        or

        +
        public OpenFilter<S> or(Filter<S> filter)
        +
        Description copied from class: Filter
        +
        Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.
        +
        +
        Overrides:
        +
        or in class Filter<S extends Storable>
        +
        Returns:
        canonical Filter instance
        +
        • +
      + + + +
        +
      • +

        not

        +
        public ClosedFilter<S> not()
        +
        Description copied from class: Filter
        +
        Returns the logical negation of this filter.
        +
        +
        Specified by:
        +
        not in class Filter<S extends Storable>
        +
        Returns:
        canonical Filter instance
        +
        • +
      + + + +
        +
      • +

        disjunctiveNormalFormSplit

        +
        public java.util.List<Filter<S>> disjunctiveNormalFormSplit()
        +
        Description copied from class: Filter
        +
        Splits the filter from its disjunctive normal form. Or'ng the filters + together produces the full disjunctive normal form.
        +
        +
        Overrides:
        +
        disjunctiveNormalFormSplit in class Filter<S extends Storable>
        +
        Returns:
        unmodifiable list of sub filters which don't perform any 'or' + operations
        Since:
        +
        1.1.1
        +
        • +
      + + + +
        +
      • +

        conjunctiveNormalFormSplit

        +
        public java.util.List<Filter<S>> conjunctiveNormalFormSplit()
        +
        Description copied from class: Filter
        +
        Splits the filter from its conjunctive normal form. And'ng the filters + together produces the full conjunctive normal form.
        +
        +
        Overrides:
        +
        conjunctiveNormalFormSplit in class Filter<S extends Storable>
        +
        Returns:
        unmodifiable list of sub filters which don't perform any 'and' + operations
        Since:
        +
        1.1.1
        +
        • +
      + + + +
        +
      • +

        initialFilterValues

        +
        public FilterValues<S> initialFilterValues()
        +
        Description copied from class: Filter
        +
        Returns a FilterValues instance for assigning values to a + Filter. Returns null if Filter has no parameters. + +

        Note: The returned FilterValues instance may reference a different + filter instance than this one. Call getFilter to retrieve it. The + difference is caused by the filter property values being bound.

        +
        +
        Overrides:
        +
        initialFilterValues in class Filter<S extends Storable>
        +
        +
        • +
      + + + + + +
        +
      • +

        accept

        +
        public <R,P> R accept(Visitor<S,R,P> visitor,
+             P param)
        +
        Description copied from class: Filter
        +
        Accept the given visitor subclass to traverse the filter tree.
        +
        +
        Specified by:
        +
        accept in class Filter<S extends Storable>
        +
        Parameters:
        visitor - visitor to traverse through the tree
        param - generic input parameter passed to visit methods
        +
        Returns:
        generic return value passed from visit methods
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public OpenFilter<S> bind()
        +
        Description copied from class: Filter
        +
        Walks through each property filter, assigning a bind ID to it. This step + is automatically performed for proper dnf/cnf conversion, and for + building FilterValues.
        +
        +
        Specified by:
        +
        bind in class Filter<S extends Storable>
        +
        Returns:
        canonical Filter instance with bound property filters
        +
        • +
      + + + +
        +
      • +

        unbind

        +
        public OpenFilter<S> unbind()
        +
        Description copied from class: Filter
        +
        Undoes the effect of a bind operation. The returned filter might still + report itself as bound if it doesn't make a distinction between these + states.
        +
        +
        Specified by:
        +
        unbind in class Filter<S extends Storable>
        +
        Returns:
        canonical Filter instance with unbound property filters
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Specified by:
        +
        equals in class Filter<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Description copied from class: Filter
        +
        Returns the string value of this filter, which is also parsable.
        +
        +
        Overrides:
        +
        toString in class Filter<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        appendTo

        +
        public void appendTo(java.lang.Appendable app,
+            FilterValues<S> values)
+              throws java.io.IOException
        +
        Description copied from class: Filter
        +
        Appends the string value of this filter into the given Appendable.
        +
        +
        Specified by:
        +
        appendTo in class Filter<S extends Storable>
        +
        values - optionally supply filter values
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/filter/OrFilter.html b/apidocs/com/amazon/carbonado/filter/OrFilter.html new file mode 100644 index 0000000..c18decb --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/OrFilter.html @@ -0,0 +1,392 @@ + + + + + + +OrFilter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.filter
+

Class OrFilter<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Appender, java.io.Serializable
    +
    +
    +
    +
    public class OrFilter<S extends Storable>
+extends BinaryOpFilter<S>
    +
    Filter tree node that performs a logical 'or' test.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        not

        +
        public Filter<S> not()
        +
        Description copied from class: Filter
        +
        Returns the logical negation of this filter.
        +
        +
        Specified by:
        +
        not in class Filter<S extends Storable>
        +
        Returns:
        canonical Filter instance
        +
        • +
      + + + + + +
        +
      • +

        accept

        +
        public <R,P> R accept(Visitor<S,R,P> visitor,
+             P param)
        +
        Description copied from class: Filter
        +
        Accept the given visitor subclass to traverse the filter tree.
        +
        +
        Specified by:
        +
        accept in class Filter<S extends Storable>
        +
        Parameters:
        visitor - visitor to traverse through the tree
        param - generic input parameter passed to visit methods
        +
        Returns:
        generic return value passed from visit methods
        +
        • +
      + + + +
        +
      • +

        unbind

        +
        public Filter<S> unbind()
        +
        Description copied from class: Filter
        +
        Undoes the effect of a bind operation. The returned filter might still + report itself as bound if it doesn't make a distinction between these + states.
        +
        +
        Specified by:
        +
        unbind in class Filter<S extends Storable>
        +
        Returns:
        canonical Filter instance with unbound property filters
        +
        • +
      + + + + + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Specified by:
        +
        equals in class Filter<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        appendTo

        +
        public void appendTo(java.lang.Appendable app,
+            FilterValues<S> values)
+              throws java.io.IOException
        +
        Description copied from class: Filter
        +
        Appends the string value of this filter into the given Appendable.
        +
        +
        Specified by:
        +
        appendTo in class Filter<S extends Storable>
        +
        values - optionally supply filter values
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/filter/PropertyFilter.html b/apidocs/com/amazon/carbonado/filter/PropertyFilter.html new file mode 100644 index 0000000..b783cc4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/PropertyFilter.html @@ -0,0 +1,609 @@ + + + + + + +PropertyFilter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.filter
+

Class PropertyFilter<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Appender, java.io.Serializable
    +
    +
    +
    +
    public class PropertyFilter<S extends Storable>
+extends Filter<S>
    +
    Filter tree node that performs a relational test against a specific property + value.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        not

        +
        public PropertyFilter<S> not()
        +
        Description copied from class: Filter
        +
        Returns the logical negation of this filter.
        +
        +
        Specified by:
        +
        not in class Filter<S extends Storable>
        +
        Returns:
        canonical Filter instance
        +
        • +
      + + + +
        +
      • +

        disjunctiveNormalFormSplit

        +
        public java.util.List<Filter<S>> disjunctiveNormalFormSplit()
        +
        Description copied from class: Filter
        +
        Splits the filter from its disjunctive normal form. Or'ng the filters + together produces the full disjunctive normal form.
        +
        +
        Overrides:
        +
        disjunctiveNormalFormSplit in class Filter<S extends Storable>
        +
        Returns:
        unmodifiable list of sub filters which don't perform any 'or' + operations
        Since:
        +
        1.1.1
        +
        • +
      + + + +
        +
      • +

        conjunctiveNormalFormSplit

        +
        public java.util.List<Filter<S>> conjunctiveNormalFormSplit()
        +
        Description copied from class: Filter
        +
        Splits the filter from its conjunctive normal form. And'ng the filters + together produces the full conjunctive normal form.
        +
        +
        Overrides:
        +
        conjunctiveNormalFormSplit in class Filter<S extends Storable>
        +
        Returns:
        unmodifiable list of sub filters which don't perform any 'and' + operations
        Since:
        +
        1.1.1
        +
        • +
      + + + + + +
        +
      • +

        accept

        +
        public <R,P> R accept(Visitor<S,R,P> visitor,
+             P param)
        +
        Description copied from class: Filter
        +
        Accept the given visitor subclass to traverse the filter tree.
        +
        +
        Specified by:
        +
        accept in class Filter<S extends Storable>
        +
        Parameters:
        visitor - visitor to traverse through the tree
        param - generic input parameter passed to visit methods
        +
        Returns:
        generic return value passed from visit methods
        +
        • +
      + + + + + + + +
        +
      • +

        getType

        +
        public java.lang.Class<?> getType()
        +
        Returns the type of the ChainedProperty.
        +
        • +
      + + + +
        +
      • +

        getBoxedType

        +
        public java.lang.Class<?> getBoxedType()
        +
        Returns the type of the ChainedProperty property, boxed into an object + if primitive.
        +
        • +
      + + + +
        +
      • +

        getOperator

        +
        public RelOp getOperator()
        +
        • +
      + + + +
        +
      • +

        getBindID

        +
        public int getBindID()
        +
        Bind ID is used to distinguish this PropertyFilter instance from another + against the same property. For example, the filter "a = ? | a = ?" + references the property 'a' twice. Each '?' parameter is bound to a + different value, and so the bind ID for each property filter is + different. "a = ?[1] | a = ?[2]".
        +
        Returns:
        assigned bind ID, or 0 if unbound
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public PropertyFilter<S> bind()
        +
        Description copied from class: Filter
        +
        Walks through each property filter, assigning a bind ID to it. This step + is automatically performed for proper dnf/cnf conversion, and for + building FilterValues.
        +
        +
        Specified by:
        +
        bind in class Filter<S extends Storable>
        +
        Returns:
        canonical Filter instance with bound property filters
        +
        • +
      + + + +
        +
      • +

        unbind

        +
        public PropertyFilter<S> unbind()
        +
        Description copied from class: Filter
        +
        Undoes the effect of a bind operation. The returned filter might still + report itself as bound if it doesn't make a distinction between these + states.
        +
        +
        Specified by:
        +
        unbind in class Filter<S extends Storable>
        +
        Returns:
        canonical Filter instance with unbound property filters
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        constant

        +
        public PropertyFilter<S> constant(java.lang.Object value)
        +
        Returns another PropertyFilter instance which is bound to the given constant value.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if value is not compatible with property type
        +
        • +
      + + + +
        +
      • +

        constant

        +
        public java.lang.Object constant()
        +
        Returns the constant value of this PropertyFilter, which is valid only + if isConstant returns true.
        +
        • +
      + + + +
        +
      • +

        isConstant

        +
        public boolean isConstant()
        +
        Returns true if this PropertyFilter has a constant value.
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Specified by:
        +
        equals in class Filter<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        appendTo

        +
        public void appendTo(java.lang.Appendable app,
+            FilterValues<S> values)
+              throws java.io.IOException
        +
        Description copied from class: Filter
        +
        Appends the string value of this filter into the given Appendable.
        +
        +
        Specified by:
        +
        appendTo in class Filter<S extends Storable>
        +
        values - optionally supply filter values
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/filter/RelOp.html b/apidocs/com/amazon/carbonado/filter/RelOp.html new file mode 100644 index 0000000..d675b01 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/RelOp.html @@ -0,0 +1,425 @@ + + + + + + +RelOp (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.filter
+

Enum RelOp

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<RelOp>
    +
    +
    +
    +
    public enum RelOp
+extends java.lang.Enum<RelOp>
    +
    Relational operator enumeration.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      EQ +
      Equals
      +
      GE +
      Greator than or Equal
      +
      GT +
      Greator Than
      +
      LE +
      Less than or Equal
      +
      LT +
      Less Than
      +
      NE +
      Not Equals
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      RelOpreverse() 
      java.lang.StringtoString() +
      Returns one of "=", "!=", "<", ">=", ">", or "<=".
      +
      static RelOpvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static RelOp[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        EQ

        +
        public static final RelOp EQ
        +
        Equals
        +
        • +
      + + + +
        +
      • +

        NE

        +
        public static final RelOp NE
        +
        Not Equals
        +
        • +
      + + + +
        +
      • +

        LT

        +
        public static final RelOp LT
        +
        Less Than
        +
        • +
      + + + +
        +
      • +

        GE

        +
        public static final RelOp GE
        +
        Greator than or Equal
        +
        • +
      + + + +
        +
      • +

        GT

        +
        public static final RelOp GT
        +
        Greator Than
        +
        • +
      + + + +
        +
      • +

        LE

        +
        public static final RelOp LE
        +
        Less than or Equal
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static RelOp[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (RelOp c : RelOp.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in +the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static RelOp valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Returns one of "=", "!=", "<", ">=", ">", or "<=".
        +
        +
        Overrides:
        +
        toString in class java.lang.Enum<RelOp>
        +
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public RelOp reverse()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/filter/Visitor.html b/apidocs/com/amazon/carbonado/filter/Visitor.html new file mode 100644 index 0000000..aca92ed --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/Visitor.html @@ -0,0 +1,355 @@ + + + + + + +Visitor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.filter
+

Class Visitor<S extends Storable,R,P>

+
+
+ +
+
    +
  • +
    +
    +
    public abstract class Visitor<S extends Storable,R,P>
+extends java.lang.Object
    +
    Traverses a filter tree in its canonical order. By overriding a visit + method, individual nodes can be captured and processed based on their + type. Call super.visit inside the overridden visit method to ensure that the + node's children are properly traversed.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Visitor() 
      +
      • +
    + + +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.filter.AndFilter

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

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

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

Uses of Class
com.amazon.carbonado.filter.BinaryOpFilter

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/filter/class-use/ClosedFilter.html b/apidocs/com/amazon/carbonado/filter/class-use/ClosedFilter.html new file mode 100644 index 0000000..27a6ff4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/class-use/ClosedFilter.html @@ -0,0 +1,196 @@ + + + + + + +Uses of Class com.amazon.carbonado.filter.ClosedFilter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.filter.ClosedFilter

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

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

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

Uses of Class
com.amazon.carbonado.filter.ExistsFilter

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

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

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

Uses of Class
com.amazon.carbonado.filter.Filter.NotJoined

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

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

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

Uses of Class
com.amazon.carbonado.filter.Filter

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/filter/class-use/FilterValues.html b/apidocs/com/amazon/carbonado/filter/class-use/FilterValues.html new file mode 100644 index 0000000..5e977ad --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/class-use/FilterValues.html @@ -0,0 +1,742 @@ + + + + + + +Uses of Class com.amazon.carbonado.filter.FilterValues (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.filter.FilterValues

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

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

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

Uses of Class
com.amazon.carbonado.filter.OpenFilter

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

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

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

Uses of Class
com.amazon.carbonado.filter.OrFilter

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/filter/class-use/PropertyFilter.html b/apidocs/com/amazon/carbonado/filter/class-use/PropertyFilter.html new file mode 100644 index 0000000..6d40e5f --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/class-use/PropertyFilter.html @@ -0,0 +1,279 @@ + + + + + + +Uses of Class com.amazon.carbonado.filter.PropertyFilter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.filter.PropertyFilter

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

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

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

Uses of Class
com.amazon.carbonado.filter.RelOp

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

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

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

Uses of Class
com.amazon.carbonado.filter.Visitor

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/filter/package-frame.html b/apidocs/com/amazon/carbonado/filter/package-frame.html new file mode 100644 index 0000000..68c5117 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/package-frame.html @@ -0,0 +1,33 @@ + + + + + + +com.amazon.carbonado.filter (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.filter

+
+

Classes

+ +

Enums

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/filter/package-summary.html b/apidocs/com/amazon/carbonado/filter/package-summary.html new file mode 100644 index 0000000..31b4347 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/package-summary.html @@ -0,0 +1,220 @@ + + + + + + +com.amazon.carbonado.filter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.filter

+
+
Contains classes for representing query filters.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.filter Description

+
Contains classes for representing query filters.
+
See Also:
Filter
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/filter/package-tree.html b/apidocs/com/amazon/carbonado/filter/package-tree.html new file mode 100644 index 0000000..0410ad2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/package-tree.html @@ -0,0 +1,158 @@ + + + + + + +com.amazon.carbonado.filter Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.filter

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Enum Hierarchy

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/filter/package-use.html b/apidocs/com/amazon/carbonado/filter/package-use.html new file mode 100644 index 0000000..48fedce --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/package-use.html @@ -0,0 +1,302 @@ + + + + + + +Uses of Package com.amazon.carbonado.filter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.filter

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/CodeBuilderUtil.html b/apidocs/com/amazon/carbonado/gen/CodeBuilderUtil.html new file mode 100644 index 0000000..c20d420 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/CodeBuilderUtil.html @@ -0,0 +1,792 @@ + + + + + + +CodeBuilderUtil (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.gen
+

Class CodeBuilderUtil

+
+
+ +
+
    +
  • +
    +
    +
    public class CodeBuilderUtil
+extends java.lang.Object
    +
    Collection of useful utilities for generating Carbonado code.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Don Schneider, Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      CodeBuilderUtil() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidaddEqualsCall(org.cojen.classfile.CodeBuilder b, + java.lang.String fieldName, + org.cojen.classfile.TypeDesc fieldType, + boolean testForNull, + org.cojen.classfile.Label fail, + org.cojen.classfile.LocalVariable other) +
      Generates code to compare a field in this object against the same one in a + different instance.
      +
      static voidaddValueHashCodeCall(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc valueType, + boolean testForNull, + boolean mixIn) +
      Generates code to compute a hashcode for a value on the stack, consuming + the value.
      +
      static voidaddValuesEqualCall(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc valueType, + boolean testForNull, + org.cojen.classfile.Label label, + boolean choice) +
      Generates code to compare two values on the stack, and branch to the + provided Label if they are not equal.
      +
      static voidassertParameterNotNull(org.cojen.classfile.CodeBuilder b, + int paramIndex) +
      Generate code to throw an exception if a parameter is null
      +
      static org.cojen.classfile.TypeDescbindQueryParam(java.lang.Class clazz) +
      Determines which overloaded "with" method on Query should be bound to.
      +
      static voidblankValue(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc type) +
      Generates code to push a blank value to the stack.
      +
      static voidcallStringBuilderAppendChar(org.cojen.classfile.CodeBuilder b) +
      Appends a char to a StringBuilder.
      +
      static voidcallStringBuilderAppendString(org.cojen.classfile.CodeBuilder b) +
      Appends a String to a StringBuilder.
      +
      static voidcallStringBuilderLength(org.cojen.classfile.CodeBuilder b) +
      Calls length on a StringBuilder on the stack, leaving an int on the stack.
      +
      static voidcallStringBuilderSetLength(org.cojen.classfile.CodeBuilder b) +
      Calls setLength on a StringBuilder.
      +
      static voidcallStringBuilderToString(org.cojen.classfile.CodeBuilder b) +
      Calls toString on a StringBuilder.
      +
      static voidconvertValue(org.cojen.classfile.CodeBuilder b, + java.lang.Class from, + java.lang.Class to) +
      Converts a value on the stack.
      +
      static <S extends Storable> 
      org.cojen.classfile.ClassFile      		createStorableClassFile(org.cojen.util.ClassInjector ci, + java.lang.Class<S> type, + boolean isAbstract, + java.lang.String aSourcefileName) +
      Define a classfile appropriate for most Storables.
      +
      static voiddefineCopyBridges(org.cojen.classfile.ClassFile cf, + java.lang.Class leaf) +
      Add copy bridge methods for all classes/interfaces between the leaf + (genericised class) and the root (genericised baseclass).
      +
      static voiddefinePrepareBridges(org.cojen.classfile.ClassFile cf, + java.lang.Class leaf) +
      Add prepare bridge methods for all classes/interfaces between the leaf + (genericised class) and the root (genericised baseclass).
      +
      static voiddefinePrepareMethod(org.cojen.classfile.ClassFile cf, + java.lang.Class storableClass, + org.cojen.classfile.TypeDesc supportCtorType) +
      Defines a Storable prepare method, which assumes that a support field + exists and a single-argument constructor exists which accepts a support + instance.
      +
      static voiddefinePrepareMethod(org.cojen.classfile.ClassFile cf, + java.lang.Class storableClass, + org.cojen.classfile.TypeDesc supportCtorType, + java.lang.String supportFieldName, + org.cojen.classfile.TypeDesc supportFieldType) +
      Defines a Storable prepare method, which assumes that a support field + exists and a single-argument constructor exists which accepts a support + instance.
      +
      static java.util.Set<java.lang.Class>gatherAllBridgeTypes(java.util.Set<java.lang.Class> set, + java.lang.Class leaf) +
      Collect a set of all the interfaces and recursively all superclasses for the leaf + (genericised class) and root (genericised base class).
      +
      static voidincrementVersion(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc type) +
      Generates code to increment a version property value, already on the stack.
      +
      static voidinitialVersion(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc type, + int value) +
      Generates code to push an initial version property value on the stack.
      +
      static booleanisPublicMethodFinal(java.lang.Class clazz, + java.lang.String name, + org.cojen.classfile.TypeDesc retType, + org.cojen.classfile.TypeDesc[] params) +
      Returns true if a public final method exists which matches the given + specification.
      +
      static voidthrowConcatException(org.cojen.classfile.CodeBuilder b, + java.lang.Class type, + java.lang.String... messages) +
      Generate code to throw an exception with a message concatenated at runtime.
      +
      static voidthrowException(org.cojen.classfile.CodeBuilder b, + java.lang.Class type, + java.lang.String message) +
      Generate code to throw an exception with an optional message.
      +
      static org.cojen.classfile.LocalVariableuneraseGenericParameter(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc paramType, + int paramIndex) +
      Generate code to create a local variable containing the specified parameter coerced + to the specified type.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CodeBuilderUtil

        +
        public CodeBuilderUtil()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        assertParameterNotNull

        +
        public static void assertParameterNotNull(org.cojen.classfile.CodeBuilder b,
+                          int paramIndex)
        +
        Generate code to throw an exception if a parameter is null
        +
        Parameters:
        b - CodeBuilder into which to append the code
        paramIndex - index of the parameter to check
        +
        • +
      + + + +
        +
      • +

        uneraseGenericParameter

        +
        public static org.cojen.classfile.LocalVariable uneraseGenericParameter(org.cojen.classfile.CodeBuilder b,
+                                                        org.cojen.classfile.TypeDesc paramType,
+                                                        int paramIndex)
        +
        Generate code to create a local variable containing the specified parameter coerced + to the specified type. This is useful for re-interpreting erased generics into + the more specific genericized type.
        +
        Parameters:
        b - CodeBuilder into which to append the code
        paramType - the more specific type which was erased during compilation
        paramIndex - index of the parameter to unerase
        +
        Returns:
        a local variable referencing the type-cast parameter
        +
        • +
      + + + +
        +
      • +

        throwException

        +
        public static void throwException(org.cojen.classfile.CodeBuilder b,
+                  java.lang.Class type,
+                  java.lang.String message)
        +
        Generate code to throw an exception with an optional message.
        +
        Parameters:
        b - CodeBuilder to which to add code
        type - type of the object to throw
        message - optional message to provide to the constructor
        +
        • +
      + + + +
        +
      • +

        throwConcatException

        +
        public static void throwConcatException(org.cojen.classfile.CodeBuilder b,
+                        java.lang.Class type,
+                        java.lang.String... messages)
        +
        Generate code to throw an exception with a message concatenated at runtime.
        +
        Parameters:
        b - CodeBuilder to which to add code
        type - type of the object to throw
        messages - messages to concat at runtime
        +
        • +
      + + + +
        +
      • +

        gatherAllBridgeTypes

        +
        public static java.util.Set<java.lang.Class> gatherAllBridgeTypes(java.util.Set<java.lang.Class> set,
+                                                  java.lang.Class leaf)
        +
        Collect a set of all the interfaces and recursively all superclasses for the leaf + (genericised class) and root (genericised base class). Eg, for Object, all + classes and implemented interfaces for every superclass between foo (the leaf) and + Object (the base). +

        A copy must be coercible into any of these types, and copy bridge methods must be + provided to do so. + +

        Note that the official documentation for this is in draft form, and you have to be + psychic to have figured out the necessity in the first place.

        +
        Parameters:
        set - set into which the class types will be collected
        leaf - leaf class
        +
        Returns:
        same set as was passed in
        +
        • +
      + + + +
        +
      • +

        defineCopyBridges

        +
        public static void defineCopyBridges(org.cojen.classfile.ClassFile cf,
+                     java.lang.Class leaf)
        +
        Add copy bridge methods for all classes/interfaces between the leaf + (genericised class) and the root (genericised baseclass).
        +
        Parameters:
        cf - file to which to add the copy bridge
        leaf - leaf class
        +
        • +
      + + + +
        +
      • +

        definePrepareMethod

        +
        public static void definePrepareMethod(org.cojen.classfile.ClassFile cf,
+                       java.lang.Class storableClass,
+                       org.cojen.classfile.TypeDesc supportCtorType)
        +
        Defines a Storable prepare method, which assumes that a support field + exists and a single-argument constructor exists which accepts a support + instance.
        +
        Parameters:
        cf - file to which to add the prepare method
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        definePrepareMethod

        +
        public static void definePrepareMethod(org.cojen.classfile.ClassFile cf,
+                       java.lang.Class storableClass,
+                       org.cojen.classfile.TypeDesc supportCtorType,
+                       java.lang.String supportFieldName,
+                       org.cojen.classfile.TypeDesc supportFieldType)
        +
        Defines a Storable prepare method, which assumes that a support field + exists and a single-argument constructor exists which accepts a support + instance.
        +
        Parameters:
        cf - file to which to add the prepare method
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        definePrepareBridges

        +
        public static void definePrepareBridges(org.cojen.classfile.ClassFile cf,
+                        java.lang.Class leaf)
        +
        Add prepare bridge methods for all classes/interfaces between the leaf + (genericised class) and the root (genericised baseclass).
        +
        Parameters:
        cf - file to which to add the prepare bridge
        leaf - leaf class
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        isPublicMethodFinal

        +
        public static boolean isPublicMethodFinal(java.lang.Class clazz,
+                          java.lang.String name,
+                          org.cojen.classfile.TypeDesc retType,
+                          org.cojen.classfile.TypeDesc[] params)
        +
        Returns true if a public final method exists which matches the given + specification.
        +
        • +
      + + + +
        +
      • +

        createStorableClassFile

        +
        public static <S extends Storable> org.cojen.classfile.ClassFile createStorableClassFile(org.cojen.util.ClassInjector ci,
+                                                                         java.lang.Class<S> type,
+                                                                         boolean isAbstract,
+                                                                         java.lang.String aSourcefileName)
        +
        Define a classfile appropriate for most Storables. Specifically: +
          +
        • implements Storable
          • +
        • implements Cloneable +
        • abstract if appropriate +
        • marked synthetic +
        • targetted for java version 1.5 +
        +
        Parameters:
        ci - ClassInjector for the storable
        type - specific Storable implementation to generate
        isAbstract - true if the class should be abstract
        aSourcefileName - identifier for the classfile, typically the factory class name
        +
        Returns:
        ClassFile object ready to have methods added.
        +
        • +
      + + + +
        +
      • +

        addValueHashCodeCall

        +
        public static void addValueHashCodeCall(org.cojen.classfile.CodeBuilder b,
+                        org.cojen.classfile.TypeDesc valueType,
+                        boolean testForNull,
+                        boolean mixIn)
        +
        Generates code to compute a hashcode for a value on the stack, consuming + the value. After the code executes, the stack contains an int hashcode.
        +
        Parameters:
        b - CodeBuilder to which to add the code
        valueType - the type of the value
        testForNull - if true and the value is a reference and might be null
        mixIn - if true, stack has an existing hashcode followed by a value
        Since:
        +
        1.2.2
        +
        • +
      + + + +
        +
      • +

        addEqualsCall

        +
        public static void addEqualsCall(org.cojen.classfile.CodeBuilder b,
+                 java.lang.String fieldName,
+                 org.cojen.classfile.TypeDesc fieldType,
+                 boolean testForNull,
+                 org.cojen.classfile.Label fail,
+                 org.cojen.classfile.LocalVariable other)
        +
        Generates code to compare a field in this object against the same one in a + different instance. Branch to the provided Label if they are not equal.
        +
        Parameters:
        b - CodeBuilder to which to add the code
        fieldName - the name of the field
        fieldType - the type of the field
        testForNull - if true and the values are references, they will be considered + unequal unless neither or both are null. If false, assume neither is null.
        fail - the label to branch to
        other - the other instance to test
        +
        • +
      + + + +
        +
      • +

        addValuesEqualCall

        +
        public static void addValuesEqualCall(org.cojen.classfile.CodeBuilder b,
+                      org.cojen.classfile.TypeDesc valueType,
+                      boolean testForNull,
+                      org.cojen.classfile.Label label,
+                      boolean choice)
        +
        Generates code to compare two values on the stack, and branch to the + provided Label if they are not equal. Both values must be of the same + type. If they are floating point values, NaN is considered equal to NaN, + which is inconsistent with the usual treatment for NaN. + +

        The generated instruction consumes both values on the stack.

        +
        Parameters:
        b - CodeBuilder to which to add the code
        valueType - the type of the values
        testForNull - if true and the values are references, they will be considered + unequal unless neither or both are null. If false, assume neither is null.
        label - the label to branch to
        choice - when true, branch to label if values are equal, else + branch to label if values are unequal.
        +
        • +
      + + + +
        +
      • +

        convertValue

        +
        public static void convertValue(org.cojen.classfile.CodeBuilder b,
+                java.lang.Class from,
+                java.lang.Class to)
        +
        Converts a value on the stack. If "to" type is a String, then conversion + may call the String.valueOf(from).
        +
        • +
      + + + +
        +
      • +

        initialVersion

        +
        public static void initialVersion(org.cojen.classfile.CodeBuilder b,
+                  org.cojen.classfile.TypeDesc type,
+                  int value)
+                           throws SupportException
        +
        Generates code to push an initial version property value on the stack.
        +
        Throws:
        +
        SupportException - if version type is not supported
        +
        • +
      + + + +
        +
      • +

        incrementVersion

        +
        public static void incrementVersion(org.cojen.classfile.CodeBuilder b,
+                    org.cojen.classfile.TypeDesc type)
+                             throws SupportException
        +
        Generates code to increment a version property value, already on the stack.
        +
        Throws:
        +
        SupportException - if version type is not supported
        +
        • +
      + + + +
        +
      • +

        blankValue

        +
        public static void blankValue(org.cojen.classfile.CodeBuilder b,
+              org.cojen.classfile.TypeDesc type)
        +
        Generates code to push a blank value to the stack. For objects, it is + null, and for primitive types it is zero or false.
        +
        • +
      + + + +
        +
      • +

        bindQueryParam

        +
        public static org.cojen.classfile.TypeDesc bindQueryParam(java.lang.Class clazz)
        +
        Determines which overloaded "with" method on Query should be bound to.
        +
        • +
      + + + +
        +
      • +

        callStringBuilderAppendString

        +
        public static void callStringBuilderAppendString(org.cojen.classfile.CodeBuilder b)
        +
        Appends a String to a StringBuilder. A StringBuilder and String must be + on the stack, and a StringBuilder is left on the stack after the call.
        +
        • +
      + + + +
        +
      • +

        callStringBuilderAppendChar

        +
        public static void callStringBuilderAppendChar(org.cojen.classfile.CodeBuilder b)
        +
        Appends a char to a StringBuilder. A StringBuilder and char must be on + the stack, and a StringBuilder is left on the stack after the call.
        +
        • +
      + + + +
        +
      • +

        callStringBuilderLength

        +
        public static void callStringBuilderLength(org.cojen.classfile.CodeBuilder b)
        +
        Calls length on a StringBuilder on the stack, leaving an int on the stack.
        +
        • +
      + + + +
        +
      • +

        callStringBuilderSetLength

        +
        public static void callStringBuilderSetLength(org.cojen.classfile.CodeBuilder b)
        +
        Calls setLength on a StringBuilder. A StringBuilder and int must be on + the stack, and both are consumed after the call.
        +
        • +
      + + + +
        +
      • +

        callStringBuilderToString

        +
        public static void callStringBuilderToString(org.cojen.classfile.CodeBuilder b)
        +
        Calls toString on a StringBuilder. A StringBuilder must be on the stack, + and a String is left on the stack after the call.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/CommonMethodNames.html b/apidocs/com/amazon/carbonado/gen/CommonMethodNames.html new file mode 100644 index 0000000..7217bbf --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/CommonMethodNames.html @@ -0,0 +1,1091 @@ + + + + + + +CommonMethodNames (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.gen
+

Class CommonMethodNames

+
+
+ +
+
    +
  • +
    +
    +
    public class CommonMethodNames
+extends java.lang.Object
    +
    Collection of constant method names for the public API.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        LOAD_METHOD_NAME

        +
        public static final java.lang.String LOAD_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        INSERT_METHOD_NAME

        +
        public static final java.lang.String INSERT_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        UPDATE_METHOD_NAME

        +
        public static final java.lang.String UPDATE_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        DELETE_METHOD_NAME

        +
        public static final java.lang.String DELETE_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        TRY_LOAD_METHOD_NAME

        +
        public static final java.lang.String TRY_LOAD_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        TRY_INSERT_METHOD_NAME

        +
        public static final java.lang.String TRY_INSERT_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        TRY_UPDATE_METHOD_NAME

        +
        public static final java.lang.String TRY_UPDATE_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        TRY_DELETE_METHOD_NAME

        +
        public static final java.lang.String TRY_DELETE_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        STORABLE_TYPE_METHOD_NAME

        +
        public static final java.lang.String STORABLE_TYPE_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        COPY_METHOD_NAME

        +
        public static final java.lang.String COPY_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        CLONE_METHOD_NAME

        +
        public static final java.lang.String CLONE_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        COPY_ALL_PROPERTIES

        +
        public static final java.lang.String COPY_ALL_PROPERTIES
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        COPY_PRIMARY_KEY_PROPERTIES

        +
        public static final java.lang.String COPY_PRIMARY_KEY_PROPERTIES
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        COPY_VERSION_PROPERTY

        +
        public static final java.lang.String COPY_VERSION_PROPERTY
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        COPY_UNEQUAL_PROPERTIES

        +
        public static final java.lang.String COPY_UNEQUAL_PROPERTIES
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        COPY_DIRTY_PROPERTIES

        +
        public static final java.lang.String COPY_DIRTY_PROPERTIES
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        HAS_DIRTY_PROPERTIES

        +
        public static final java.lang.String HAS_DIRTY_PROPERTIES
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        MARK_PROPERTIES_CLEAN

        +
        public static final java.lang.String MARK_PROPERTIES_CLEAN
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        MARK_ALL_PROPERTIES_CLEAN

        +
        public static final java.lang.String MARK_ALL_PROPERTIES_CLEAN
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        MARK_PROPERTIES_DIRTY

        +
        public static final java.lang.String MARK_PROPERTIES_DIRTY
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        MARK_ALL_PROPERTIES_DIRTY

        +
        public static final java.lang.String MARK_ALL_PROPERTIES_DIRTY
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        IS_PROPERTY_UNINITIALIZED

        +
        public static final java.lang.String IS_PROPERTY_UNINITIALIZED
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        IS_PROPERTY_DIRTY

        +
        public static final java.lang.String IS_PROPERTY_DIRTY
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        IS_PROPERTY_CLEAN

        +
        public static final java.lang.String IS_PROPERTY_CLEAN
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        IS_PROPERTY_SUPPORTED

        +
        public static final java.lang.String IS_PROPERTY_SUPPORTED
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        GET_PROPERTY_VALUE

        +
        public static final java.lang.String GET_PROPERTY_VALUE
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        SET_PROPERTY_VALUE

        +
        public static final java.lang.String SET_PROPERTY_VALUE
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        PROPERTY_MAP

        +
        public static final java.lang.String PROPERTY_MAP
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        WRITE_TO

        +
        public static final java.lang.String WRITE_TO
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        READ_FROM

        +
        public static final java.lang.String READ_FROM
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        TO_STRING_KEY_ONLY_METHOD_NAME

        +
        public static final java.lang.String TO_STRING_KEY_ONLY_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        TO_STRING_METHOD_NAME

        +
        public static final java.lang.String TO_STRING_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        HASHCODE_METHOD_NAME

        +
        public static final java.lang.String HASHCODE_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        EQUALS_METHOD_NAME

        +
        public static final java.lang.String EQUALS_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        EQUAL_PRIMARY_KEYS_METHOD_NAME

        +
        public static final java.lang.String EQUAL_PRIMARY_KEYS_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        EQUAL_PROPERTIES_METHOD_NAME

        +
        public static final java.lang.String EQUAL_PROPERTIES_METHOD_NAME
        +
        Storable API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        QUERY_METHOD_NAME

        +
        public static final java.lang.String QUERY_METHOD_NAME
        +
        Storage API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        PREPARE_METHOD_NAME

        +
        public static final java.lang.String PREPARE_METHOD_NAME
        +
        Storage API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        LOAD_ONE_METHOD_NAME

        +
        public static final java.lang.String LOAD_ONE_METHOD_NAME
        +
        Query API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        TRY_LOAD_ONE_METHOD_NAME

        +
        public static final java.lang.String TRY_LOAD_ONE_METHOD_NAME
        +
        Query API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        AND_METHOD_NAME

        +
        public static final java.lang.String AND_METHOD_NAME
        +
        Query API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        WITH_METHOD_NAME

        +
        public static final java.lang.String WITH_METHOD_NAME
        +
        Query API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        FETCH_METHOD_NAME

        +
        public static final java.lang.String FETCH_METHOD_NAME
        +
        Query API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        STORAGE_FOR_METHOD_NAME

        +
        public static final java.lang.String STORAGE_FOR_METHOD_NAME
        +
        Repository API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        ENTER_TRANSACTION_METHOD_NAME

        +
        public static final java.lang.String ENTER_TRANSACTION_METHOD_NAME
        +
        Repository API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        GET_TRANSACTION_ISOLATION_LEVEL_METHOD_NAME

        +
        public static final java.lang.String GET_TRANSACTION_ISOLATION_LEVEL_METHOD_NAME
        +
        Repository API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        SET_FOR_UPDATE_METHOD_NAME

        +
        public static final java.lang.String SET_FOR_UPDATE_METHOD_NAME
        +
        Transaction API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        COMMIT_METHOD_NAME

        +
        public static final java.lang.String COMMIT_METHOD_NAME
        +
        Transaction API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        EXIT_METHOD_NAME

        +
        public static final java.lang.String EXIT_METHOD_NAME
        +
        Transaction API method name
        +
        See Also:
        Constant Field Values
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CommonMethodNames

        +
        public CommonMethodNames()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/DelegateStorableGenerator.html b/apidocs/com/amazon/carbonado/gen/DelegateStorableGenerator.html new file mode 100644 index 0000000..30c113f --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/DelegateStorableGenerator.html @@ -0,0 +1,245 @@ + + + + + + +DelegateStorableGenerator (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.gen
+

Class DelegateStorableGenerator<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public class DelegateStorableGenerator<S extends Storable>
+extends java.lang.Object
    +
    Generates and caches concrete implementations of Storable types + which delegate to DelegateSupport. The delegating classes extend + those generated by MasterStorableGenerator.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static <S extends Storable> 
      java.lang.Class<? extends S>      		getDelegateClass(java.lang.Class<S> type, + java.util.EnumSet<MasterFeature> features) +
      Delegate class has a constructor that accepts a DelegateSupport + instance.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDelegateClass

        +
        public static <S extends Storable> java.lang.Class<? extends S> getDelegateClass(java.lang.Class<S> type,
+                                                                 java.util.EnumSet<MasterFeature> features)
+                                                                      throws SupportException
        +
        Delegate class has a constructor that accepts a DelegateSupport + instance. + + 
        + public <init>(DelegateSupport);
+
        +
        Throws:
        +
        SupportException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/DelegateSupport.html b/apidocs/com/amazon/carbonado/gen/DelegateSupport.html new file mode 100644 index 0000000..eb2b2cc --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/DelegateSupport.html @@ -0,0 +1,298 @@ + + + + + + +DelegateSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.gen
+

Interface DelegateSupport<S extends Storable>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/DetachedStorableFactory.html b/apidocs/com/amazon/carbonado/gen/DetachedStorableFactory.html new file mode 100644 index 0000000..3d2c468 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/DetachedStorableFactory.html @@ -0,0 +1,267 @@ + + + + + + +DetachedStorableFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.gen
+

Class DetachedStorableFactory<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public class DetachedStorableFactory<S extends Storable>
+extends java.lang.Object
    +
    Creates Storable instances which are basic data containers. All load + and store operations throw an exception, as do accesses to join properties.
    +
    Since:
    +
    1.2.2
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      DetachedStorableFactory(java.lang.Class<S> type) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      <S extends Storable> 
      S      		newInstance() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        newInstance

        +
        public <S extends Storable> S newInstance()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/MasterFeature.html b/apidocs/com/amazon/carbonado/gen/MasterFeature.html new file mode 100644 index 0000000..1a3e680 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/MasterFeature.html @@ -0,0 +1,501 @@ + + + + + + +MasterFeature (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.gen
+

Enum MasterFeature

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<MasterFeature>
    +
    +
    +
    +
    public enum MasterFeature
+extends java.lang.Enum<MasterFeature>
    +
    Master feature to enable when using MasterStorableGenerator.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      DELETE_TXN +
      Ensure delete operation always is in a transaction.
      +
      DELETE_TXN_FOR_UPDATE +
      Ensure delete operation always is in a transaction, "for update".
      +
      INSERT_CHECK_REQUIRED +
      Insert operation checks that all required data properties have been set, + excluding automatic properties and version property.
      +
      INSERT_NO_CHECK_PRIMARY_PK +
      Insert operation never checks if primary key is filled in.
      +
      INSERT_SEQUENCES +
      Insert operation applies any sequences to unset properties.
      +
      INSERT_TXN +
      Ensure insert operation always is in a transaction.
      +
      INSERT_TXN_FOR_UPDATE +
      Ensure insert operation always is in a transaction, "for update".
      +
      NORMALIZE +
      Insert and update operations normalize property types such as BigDecimal.
      +
      PARTITIONING +
      Enforce rules for Storables which have a partition key
      +
      UPDATE_FULL +
      Update operations load clean copy first, to prevent destructive update.
      +
      UPDATE_TXN +
      Ensure update operation always is in a transaction.
      +
      UPDATE_TXN_FOR_UPDATE +
      Ensure update operation always is in a transaction, "for update".
      +
      VERSIONING +
      Insert and update operations implement record versioning, if version property exists.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static MasterFeaturevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static MasterFeature[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        VERSIONING

        +
        public static final MasterFeature VERSIONING
        +
        Insert and update operations implement record versioning, if version property exists.
        +
        • +
      + + + +
        +
      • +

        NORMALIZE

        +
        public static final MasterFeature NORMALIZE
        +
        Insert and update operations normalize property types such as BigDecimal.
        +
        • +
      + + + +
        +
      • +

        UPDATE_FULL

        +
        public static final MasterFeature UPDATE_FULL
        +
        Update operations load clean copy first, to prevent destructive update.
        +
        • +
      + + + +
        +
      • +

        UPDATE_TXN

        +
        public static final MasterFeature UPDATE_TXN
        +
        Ensure update operation always is in a transaction.
        +
        • +
      + + + +
        +
      • +

        UPDATE_TXN_FOR_UPDATE

        +
        public static final MasterFeature UPDATE_TXN_FOR_UPDATE
        +
        Ensure update operation always is in a transaction, "for update".
        +
        • +
      + + + +
        +
      • +

        INSERT_SEQUENCES

        +
        public static final MasterFeature INSERT_SEQUENCES
        +
        Insert operation applies any sequences to unset properties.
        +
        • +
      + + + +
        +
      • +

        INSERT_CHECK_REQUIRED

        +
        public static final MasterFeature INSERT_CHECK_REQUIRED
        +
        Insert operation checks that all required data properties have been set, + excluding automatic properties and version property.
        +
        • +
      + + + +
        +
      • +

        INSERT_NO_CHECK_PRIMARY_PK

        +
        public static final MasterFeature INSERT_NO_CHECK_PRIMARY_PK
        +
        Insert operation never checks if primary key is filled in.
        +
        • +
      + + + +
        +
      • +

        INSERT_TXN

        +
        public static final MasterFeature INSERT_TXN
        +
        Ensure insert operation always is in a transaction.
        +
        • +
      + + + +
        +
      • +

        INSERT_TXN_FOR_UPDATE

        +
        public static final MasterFeature INSERT_TXN_FOR_UPDATE
        +
        Ensure insert operation always is in a transaction, "for update".
        +
        • +
      + + + +
        +
      • +

        DELETE_TXN

        +
        public static final MasterFeature DELETE_TXN
        +
        Ensure delete operation always is in a transaction.
        +
        • +
      + + + +
        +
      • +

        DELETE_TXN_FOR_UPDATE

        +
        public static final MasterFeature DELETE_TXN_FOR_UPDATE
        +
        Ensure delete operation always is in a transaction, "for update".
        +
        • +
      + + + +
        +
      • +

        PARTITIONING

        +
        public static final MasterFeature PARTITIONING
        +
        Enforce rules for Storables which have a partition key
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static MasterFeature[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (MasterFeature c : MasterFeature.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in +the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static MasterFeature valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/MasterStorableGenerator.html b/apidocs/com/amazon/carbonado/gen/MasterStorableGenerator.html new file mode 100644 index 0000000..0c82aa7 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/MasterStorableGenerator.html @@ -0,0 +1,363 @@ + + + + + + +MasterStorableGenerator (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.gen
+

Class MasterStorableGenerator<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public final class MasterStorableGenerator<S extends Storable>
+extends java.lang.Object
    +
    Generates and caches abstract implementations of Storable types + suitable for use by master repositories. The generated classes extend those + generated by StorableGenerator. Subclasses need not worry about + transactions since this class takes care of that.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill, Olga Kuznetsova
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static <S extends Storable> 
      java.lang.Class<? extends S>      		getAbstractClass(java.lang.Class<S> type, + java.util.EnumSet<MasterFeature> features) +
      Returns an abstract implementation of the given Storable type, which + is fully thread-safe.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        DO_TRY_LOAD_MASTER_METHOD_NAME

        +
        public static final java.lang.String DO_TRY_LOAD_MASTER_METHOD_NAME
        +
        Name of protected abstract method in generated storable
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        DO_TRY_INSERT_MASTER_METHOD_NAME

        +
        public static final java.lang.String DO_TRY_INSERT_MASTER_METHOD_NAME
        +
        Name of protected abstract method in generated storable
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        DO_TRY_UPDATE_MASTER_METHOD_NAME

        +
        public static final java.lang.String DO_TRY_UPDATE_MASTER_METHOD_NAME
        +
        Name of protected abstract method in generated storable
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        DO_TRY_DELETE_MASTER_METHOD_NAME

        +
        public static final java.lang.String DO_TRY_DELETE_MASTER_METHOD_NAME
        +
        Name of protected abstract method in generated storable
        +
        See Also:
        Constant Field Values
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAbstractClass

        +
        public static <S extends Storable> java.lang.Class<? extends S> getAbstractClass(java.lang.Class<S> type,
+                                                                 java.util.EnumSet<MasterFeature> features)
+                                                                      throws SupportException,
+                                                                             java.lang.IllegalArgumentException
        +
        Returns an abstract implementation of the given Storable type, which + is fully thread-safe. The Storable type itself may be an interface or + a class. If it is a class, then it must not be final, and it must have a + public, no-arg constructor. The constructor for the returned abstract + class looks like this: + + 
        + public <init>(MasterSupport);
+
        + + Subclasses must implement the following abstract protected methods, + whose exact names are defined by constants in this class: + + 
        + // Load the object by examining the primary key.
+ protected abstract boolean doTryLoad() throws FetchException;
+
+ // Insert the object into the storage layer.
+ protected abstract boolean doTryInsert_master() throws PersistException;
+
+ // Update the object in the storage.
+ protected abstract boolean doTryUpdate_master() throws PersistException;
+
+ // Delete the object from the storage layer by the primary key.
+ protected abstract boolean doTryDelete_master() throws PersistException;
+
        + + Subclasses can access the MasterSupport instance via the protected field + named by SUPPORT_FIELD_NAME.
        +
        Throws:
        +
        MalformedTypeException - if Storable type is not well-formed
        +
        java.lang.IllegalArgumentException - if type is null
        +
        SupportException
        See Also:
        MasterSupport
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/MasterSupport.html b/apidocs/com/amazon/carbonado/gen/MasterSupport.html new file mode 100644 index 0000000..26380cb --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/MasterSupport.html @@ -0,0 +1,246 @@ + + + + + + +MasterSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.gen
+

Interface MasterSupport<S extends Storable>

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getSequenceValueProducer

        +
        SequenceValueProducer getSequenceValueProducer(java.lang.String name)
+                                               throws PersistException
        +
        Returns a sequence value producer by name, or throw PersistException if not found. + +

        Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.

        +
        Throws:
        +
        PersistException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/StorableCopier.From.html b/apidocs/com/amazon/carbonado/gen/StorableCopier.From.html new file mode 100644 index 0000000..452304b --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/StorableCopier.From.html @@ -0,0 +1,228 @@ + + + + + + +StorableCopier.From (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.gen
+

Class StorableCopier.From<S extends Storable>

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      <T extends Storable> 
      StorableCopier<S,T>      		to(java.lang.Class<T> target) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/StorableCopier.html b/apidocs/com/amazon/carbonado/gen/StorableCopier.html new file mode 100644 index 0000000..2d49f89 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/StorableCopier.html @@ -0,0 +1,370 @@ + + + + + + +StorableCopier (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.gen
+

Class StorableCopier<S extends Storable,T extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public abstract class StorableCopier<S extends Storable,T extends Storable>
+extends java.lang.Object
    +
    Copies properties between otherwise incompatible Storables. Only matched + properties are copied, and primitive types are converted.
    +
    Since:
    +
    1.2.2
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StorableCopier

        +
        protected StorableCopier()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + +
        +
      • +

        copyAllProperties

        +
        public abstract void copyAllProperties(S source,
+                     T target)
        +
        • +
      + + + + + +
        +
      • +

        copyPrimaryKeyProperties

        +
        public abstract void copyPrimaryKeyProperties(S source,
+                            T target)
        +
        • +
      + + + + + +
        +
      • +

        copyVersionProperty

        +
        public abstract void copyVersionProperty(S source,
+                       T target)
        +
        • +
      + + + + + +
        +
      • +

        copyUnequalProperties

        +
        public abstract void copyUnequalProperties(S source,
+                         T target)
        +
        • +
      + + + + + +
        +
      • +

        copyDirtyProperties

        +
        public abstract void copyDirtyProperties(S source,
+                       T target)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/StorableGenerator.html b/apidocs/com/amazon/carbonado/gen/StorableGenerator.html new file mode 100644 index 0000000..074f949 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/StorableGenerator.html @@ -0,0 +1,755 @@ + + + + + + +StorableGenerator (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.gen
+

Class StorableGenerator<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public final class StorableGenerator<S extends Storable>
+extends java.lang.Object
    +
    Generates and caches abstract implementations of Storable + types. This greatly simplifies the process of defining new kinds of Repositories, since most of the mundane code generation is taken + care of.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill, Don Schneider, Tobias Holgers
    +
    See Also:
    MasterStorableGenerator, +DelegateStorableGenerator
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.lang.StringADAPTER_FIELD_ELEMENT +
      Adapter field names are propertyName + "$adapter$" + number
      +
      static java.lang.StringCHECK_PK_FOR_DELETE_METHOD_NAME +
      Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.
      +
      static java.lang.StringCHECK_PK_FOR_INSERT_METHOD_NAME +
      Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.
      +
      static java.lang.StringCHECK_PK_FOR_LOAD_METHOD_NAME +
      Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.
      +
      static java.lang.StringCHECK_PK_FOR_UPDATE_METHOD_NAME +
      Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.
      +
      static java.lang.StringCONSTRAINT_FIELD_ELEMENT +
      Constraint field names are propertyName + "$constraint$" + number
      +
      static java.lang.StringDO_TRY_DELETE_METHOD_NAME +
      Name of protected abstract method in generated storable
      +
      static java.lang.StringDO_TRY_INSERT_METHOD_NAME +
      Name of protected abstract method in generated storable
      +
      static java.lang.StringDO_TRY_LOAD_METHOD_NAME +
      Name of protected abstract method in generated storable
      +
      static java.lang.StringDO_TRY_UPDATE_METHOD_NAME +
      Name of protected abstract method in generated storable
      +
      static java.lang.StringIS_ALT_KEY_INITIALIZED_PREFIX +
      Name prefix of protected method in generated storable that returns false + if a specific alternate key is uninitialized.
      +
      static java.lang.StringIS_PARTITION_KEY_INITIALIZED_METHOD_NAME +
      Name of protected method in generated storable that returns false if any + partition keys are uninitialized.
      +
      static java.lang.StringIS_PK_INITIALIZED_METHOD_NAME +
      Name of protected method in generated storable that returns false if any + primary keys are uninitialized.
      +
      static java.lang.StringIS_REQUIRED_DATA_INITIALIZED_METHOD_NAME +
      Name of protected method in generated storable that returns false if any + non-nullable, non-pk properties are uninitialized.
      +
      static java.lang.StringIS_VERSION_INITIALIZED_METHOD_NAME +
      Name of protected method in generated storable that returns false if + version property is uninitialized.
      +
      static java.lang.StringLOAD_COMPLETED_METHOD_NAME +
      Name of protected method which must be called after load to identify all + properties as valid and to fire any load triggers.
      +
      static intPROPERTY_STATE_CLEAN +
      Property state indicating that property value reflects a clean value
      +
      static intPROPERTY_STATE_DIRTY +
      Property state indicating that property has been set, but not saved
      +
      static java.lang.StringPROPERTY_STATE_FIELD_NAME +
      Prefix of protected field in generated storable that holds property + states.
      +
      static intPROPERTY_STATE_MASK +
      Property state mask is 3, to cover the two bits used by a property state
      +
      static intPROPERTY_STATE_UNINITIALIZED +
      Property state indicating that property has never been set, loaded, or saved
      +
      static java.lang.StringSUPPORT_FIELD_NAME +
      Reference to TriggerSupport instance
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static <S extends Storable> 
      java.lang.Class<? extends S>      		getAbstractClass(java.lang.Class<S> type) +
      Returns an abstract implementation of the given Storable type, which is + fully thread-safe.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        DO_TRY_LOAD_METHOD_NAME

        +
        public static final java.lang.String DO_TRY_LOAD_METHOD_NAME
        +
        Name of protected abstract method in generated storable
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        DO_TRY_INSERT_METHOD_NAME

        +
        public static final java.lang.String DO_TRY_INSERT_METHOD_NAME
        +
        Name of protected abstract method in generated storable
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        DO_TRY_UPDATE_METHOD_NAME

        +
        public static final java.lang.String DO_TRY_UPDATE_METHOD_NAME
        +
        Name of protected abstract method in generated storable
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        DO_TRY_DELETE_METHOD_NAME

        +
        public static final java.lang.String DO_TRY_DELETE_METHOD_NAME
        +
        Name of protected abstract method in generated storable
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        CHECK_PK_FOR_INSERT_METHOD_NAME

        +
        public static final java.lang.String CHECK_PK_FOR_INSERT_METHOD_NAME
        +
        Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        CHECK_PK_FOR_UPDATE_METHOD_NAME

        +
        public static final java.lang.String CHECK_PK_FOR_UPDATE_METHOD_NAME
        +
        Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        CHECK_PK_FOR_DELETE_METHOD_NAME

        +
        public static final java.lang.String CHECK_PK_FOR_DELETE_METHOD_NAME
        +
        Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        CHECK_PK_FOR_LOAD_METHOD_NAME

        +
        public static final java.lang.String CHECK_PK_FOR_LOAD_METHOD_NAME
        +
        Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        IS_PK_INITIALIZED_METHOD_NAME

        +
        public static final java.lang.String IS_PK_INITIALIZED_METHOD_NAME
        +
        Name of protected method in generated storable that returns false if any + primary keys are uninitialized.
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        IS_PARTITION_KEY_INITIALIZED_METHOD_NAME

        +
        public static final java.lang.String IS_PARTITION_KEY_INITIALIZED_METHOD_NAME
        +
        Name of protected method in generated storable that returns false if any + partition keys are uninitialized.
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        IS_ALT_KEY_INITIALIZED_PREFIX

        +
        public static final java.lang.String IS_ALT_KEY_INITIALIZED_PREFIX
        +
        Name prefix of protected method in generated storable that returns false + if a specific alternate key is uninitialized. The complete name is + formed by the prefix appended with the zero-based alternate key number.
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        IS_REQUIRED_DATA_INITIALIZED_METHOD_NAME

        +
        public static final java.lang.String IS_REQUIRED_DATA_INITIALIZED_METHOD_NAME
        +
        Name of protected method in generated storable that returns false if any + non-nullable, non-pk properties are uninitialized.
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        IS_VERSION_INITIALIZED_METHOD_NAME

        +
        public static final java.lang.String IS_VERSION_INITIALIZED_METHOD_NAME
        +
        Name of protected method in generated storable that returns false if + version property is uninitialized. If no version property exists, then + this method is not defined.
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        LOAD_COMPLETED_METHOD_NAME

        +
        public static final java.lang.String LOAD_COMPLETED_METHOD_NAME
        +
        Name of protected method which must be called after load to identify all + properties as valid and to fire any load triggers.
        +
        Since:
        +
        1.2
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        PROPERTY_STATE_FIELD_NAME

        +
        public static final java.lang.String PROPERTY_STATE_FIELD_NAME
        +
        Prefix of protected field in generated storable that holds property + states. Each property consumes two bits to hold its state, and so each + 32-bit field holds states for up to 16 properties.
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        ADAPTER_FIELD_ELEMENT

        +
        public static final java.lang.String ADAPTER_FIELD_ELEMENT
        +
        Adapter field names are propertyName + "$adapter$" + number
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        CONSTRAINT_FIELD_ELEMENT

        +
        public static final java.lang.String CONSTRAINT_FIELD_ELEMENT
        +
        Constraint field names are propertyName + "$constraint$" + number
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        SUPPORT_FIELD_NAME

        +
        public static final java.lang.String SUPPORT_FIELD_NAME
        +
        Reference to TriggerSupport instance
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        PROPERTY_STATE_UNINITIALIZED

        +
        public static final int PROPERTY_STATE_UNINITIALIZED
        +
        Property state indicating that property has never been set, loaded, or saved
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        PROPERTY_STATE_DIRTY

        +
        public static final int PROPERTY_STATE_DIRTY
        +
        Property state indicating that property has been set, but not saved
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        PROPERTY_STATE_CLEAN

        +
        public static final int PROPERTY_STATE_CLEAN
        +
        Property state indicating that property value reflects a clean value
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        PROPERTY_STATE_MASK

        +
        public static final int PROPERTY_STATE_MASK
        +
        Property state mask is 3, to cover the two bits used by a property state
        +
        See Also:
        Constant Field Values
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAbstractClass

        +
        public static <S extends Storable> java.lang.Class<? extends S> getAbstractClass(java.lang.Class<S> type)
+                                                                      throws java.lang.IllegalArgumentException
        +
        Returns an abstract implementation of the given Storable type, which is + fully thread-safe. The Storable type itself may be an interface or a + class. If it is a class, then it must not be final, and it must have a + public, no-arg constructor. The constructor signature for the returned + abstract class is defined as follows: + + 
        + /**
+  * @param support  Access to triggers
+  */
+ public <init>(TriggerSupport support);
+
        + +

        Subclasses must implement the following abstract protected methods, + whose exact names are defined by constants in this class: + + 

        + // Load the object by examining the primary key.
+ protected abstract boolean doTryLoad() throws FetchException;
+
+ // Insert the object into the storage layer.
+ protected abstract boolean doTryInsert() throws PersistException;
+
+ // Update the object in the storage.
+ protected abstract boolean doTryUpdate() throws PersistException;
+
+ // Delete the object from the storage layer by the primary key.
+ protected abstract boolean doTryDelete() throws PersistException;
+
        + + A set of protected hook methods are provided which ensure that all + primary keys are initialized before performing a repository + operation. Subclasses may override them, if they are capable of filling + in unspecified primary keys. One such example is applying a sequence on + insert. + + 
        + // Throws exception if any primary keys are uninitialized.
+ // Actual method name defined by CHECK_PK_FOR_INSERT_METHOD_NAME.
+ protected void checkPkForInsert() throws IllegalStateException;
+
+ // Throws exception if any primary keys are uninitialized.
+ // Actual method name defined by CHECK_PK_FOR_UPDATE_METHOD_NAME.
+ protected void checkPkForUpdate() throws IllegalStateException;
+
+ // Throws exception if any primary keys are uninitialized.
+ // Actual method name defined by CHECK_PK_FOR_DELETE_METHOD_NAME.
+ protected void checkPkForDelete() throws IllegalStateException;
+
        + + Each property value is defined as a protected field whose name and type + matches the property. Subclasses should access these fields directly + during loading and storing. For loading, it bypasses constraint + checks. For both, it provides better performance. + +

        Subclasses also have access to a set of property state bits stored + in protected int fields. Subclasses are not responsible for updating + these values. The intention is that these states may be used by + subclasses to support partial updates. They may otherwise be ignored. + +

        As a convenience, protected methods are provided to test and alter + the property state bits. Subclass constructors that fill all properties + with loaded values must call loadCompleted to ensure all properties are + identified as being valid and to fire any load triggers. + + 

        + // Returns true if all primary key properties have been set.
+ protected boolean isPkInitialized();
+
+ // Returns true if all partition key properties have been set.
+ protected boolean isPartitionKeyInitialized();
+
+ // Returns true if all required data properties are set.
+ // A required data property is a non-nullable, non-primary key.
+ protected boolean isRequiredDataInitialized();
+
+ // Returns true if a version property has been set.
+ // Note: This method is not generated if there is no version property.
+ protected boolean isVersionInitialized();
+
+ // Must be called after load to identify all properties as valid
+ // and to fire any load triggers.
+ // Actual method name defined by LOAD_COMPLETED_METHOD_NAME.
+ protected void loadCompleted() throws FetchException;
+
        + + Property state field names are defined by the concatenation of + PROPERTY_STATE_FIELD_NAME and a zero-based decimal + number. To determine which field holds a particular property's state, + the field number is computed as the property number divided by 16. The + specific two-bit state position is the remainder of this division times 2.
        +
        Throws:
        +
        MalformedTypeException - if Storable type is not well-formed
        +
        java.lang.IllegalArgumentException - if type is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/StorablePropertyMap.html b/apidocs/com/amazon/carbonado/gen/StorablePropertyMap.html new file mode 100644 index 0000000..8c78feb --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/StorablePropertyMap.html @@ -0,0 +1,461 @@ + + + + + + +StorablePropertyMap (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.gen
+

Class StorablePropertyMap<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.util.Map<java.lang.String,java.lang.Object>
    +
    +
    +
    +
    public class StorablePropertyMap<S extends Storable>
+extends java.util.AbstractMap<java.lang.String,java.lang.Object>
    +
    Basic implementation for Storable.propertyMap() method.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class java.util.AbstractMap

        +java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
        • +
      +
        +
      • + + +

        Nested classes/interfaces inherited from interface java.util.Map

        +java.util.Map.Entry<K,V>
        • +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclear() 
      booleancontainsKey(java.lang.Object key) 
      static <S extends Storable> 
      StorablePropertyMap<S>      		createMap(java.lang.Class<S> type, + S storable) 
      java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>>entrySet() 
      java.lang.Objectget(java.lang.Object key) 
      booleanisEmpty() 
      java.util.Set<java.lang.String>keySet() 
      java.lang.Objectput(java.lang.String key, + java.lang.Object value) 
      java.lang.Objectremove(java.lang.Object key) 
      intsize() 
      java.util.Collection<java.lang.Object>values() 
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractMap

        +clone, containsValue, equals, hashCode, putAll, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + + + +
        +
      • +

        size

        +
        public int size()
        +
        +
        Specified by:
        +
        size in interface java.util.Map<java.lang.String,java.lang.Object>
        +
        Overrides:
        +
        size in class java.util.AbstractMap<java.lang.String,java.lang.Object>
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        +
        Specified by:
        +
        isEmpty in interface java.util.Map<java.lang.String,java.lang.Object>
        +
        Overrides:
        +
        isEmpty in class java.util.AbstractMap<java.lang.String,java.lang.Object>
        +
        +
        • +
      + + + +
        +
      • +

        containsKey

        +
        public boolean containsKey(java.lang.Object key)
        +
        +
        Specified by:
        +
        containsKey in interface java.util.Map<java.lang.String,java.lang.Object>
        +
        Overrides:
        +
        containsKey in class java.util.AbstractMap<java.lang.String,java.lang.Object>
        +
        +
        • +
      + + + +
        +
      • +

        get

        +
        public java.lang.Object get(java.lang.Object key)
        +
        +
        Specified by:
        +
        get in interface java.util.Map<java.lang.String,java.lang.Object>
        +
        Overrides:
        +
        get in class java.util.AbstractMap<java.lang.String,java.lang.Object>
        +
        +
        • +
      + + + +
        +
      • +

        put

        +
        public java.lang.Object put(java.lang.String key,
+                   java.lang.Object value)
        +
        +
        Specified by:
        +
        put in interface java.util.Map<java.lang.String,java.lang.Object>
        +
        Overrides:
        +
        put in class java.util.AbstractMap<java.lang.String,java.lang.Object>
        +
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public java.lang.Object remove(java.lang.Object key)
        +
        +
        Specified by:
        +
        remove in interface java.util.Map<java.lang.String,java.lang.Object>
        +
        Overrides:
        +
        remove in class java.util.AbstractMap<java.lang.String,java.lang.Object>
        +
        +
        • +
      + + + +
        +
      • +

        clear

        +
        public void clear()
        +
        +
        Specified by:
        +
        clear in interface java.util.Map<java.lang.String,java.lang.Object>
        +
        Overrides:
        +
        clear in class java.util.AbstractMap<java.lang.String,java.lang.Object>
        +
        +
        • +
      + + + +
        +
      • +

        keySet

        +
        public java.util.Set<java.lang.String> keySet()
        +
        +
        Specified by:
        +
        keySet in interface java.util.Map<java.lang.String,java.lang.Object>
        +
        Overrides:
        +
        keySet in class java.util.AbstractMap<java.lang.String,java.lang.Object>
        +
        +
        • +
      + + + +
        +
      • +

        values

        +
        public java.util.Collection<java.lang.Object> values()
        +
        +
        Specified by:
        +
        values in interface java.util.Map<java.lang.String,java.lang.Object>
        +
        Overrides:
        +
        values in class java.util.AbstractMap<java.lang.String,java.lang.Object>
        +
        +
        • +
      + + + +
        +
      • +

        entrySet

        +
        public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> entrySet()
        +
        +
        Specified by:
        +
        entrySet in interface java.util.Map<java.lang.String,java.lang.Object>
        +
        Specified by:
        +
        entrySet in class java.util.AbstractMap<java.lang.String,java.lang.Object>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/StorableSupport.html b/apidocs/com/amazon/carbonado/gen/StorableSupport.html new file mode 100644 index 0000000..5ba4940 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/StorableSupport.html @@ -0,0 +1,237 @@ + + + + + + +StorableSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.gen
+

Interface StorableSupport<S extends Storable>

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      RepositorygetRootRepository() +
      Returns the root parent Repository that the Storable came from.
      +
      booleanisPropertySupported(java.lang.String propertyName) +
      Returns true if the given property exists and is supported.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getRootRepository

        +
        Repository getRootRepository()
        +
        Returns the root parent Repository that the Storable came from.
        +
        • +
      + + + +
        +
      • +

        isPropertySupported

        +
        boolean isPropertySupported(java.lang.String propertyName)
        +
        Returns true if the given property exists and is supported.
        +
        Parameters:
        propertyName - name of property to check
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/TriggerSupport.html b/apidocs/com/amazon/carbonado/gen/TriggerSupport.html new file mode 100644 index 0000000..6664e02 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/TriggerSupport.html @@ -0,0 +1,326 @@ + + + + + + +TriggerSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.gen
+

Interface TriggerSupport<S extends Storable>

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getInsertTrigger

        +
        Trigger<? super S> getInsertTrigger()
        +
        Returns a trigger which must be run for all insert operations.
        +
        Returns:
        null if no trigger
        +
        • +
      + + + +
        +
      • +

        getUpdateTrigger

        +
        Trigger<? super S> getUpdateTrigger()
        +
        Returns a trigger which must be run for all update operations.
        +
        Returns:
        null if no trigger
        +
        • +
      + + + +
        +
      • +

        getDeleteTrigger

        +
        Trigger<? super S> getDeleteTrigger()
        +
        Returns a trigger which must be run for all delete operations.
        +
        Returns:
        null if no trigger
        +
        • +
      + + + +
        +
      • +

        getLoadTrigger

        +
        Trigger<? super S> getLoadTrigger()
        +
        Returns a trigger which must be run for all load and fetch operations.
        +
        Returns:
        null if no trigger
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        locallyDisableLoadTrigger

        +
        void locallyDisableLoadTrigger()
        +
        Disables execution of load trigger for the current thread. Call + locallyEnableLoadTrigger to enable again. This call can be made multiple + times, but be sure to call locallyEnableLoadTrigger the same number of + times to fully enable.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        locallyEnableLoadTrigger

        +
        void locallyEnableLoadTrigger()
        +
        Enables execution of load trigger for the current thread, if they it + been disabled before.
        +
        Since:
        +
        1.2
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.gen.CodeBuilderUtil

+
+
No usage of com.amazon.carbonado.gen.CodeBuilderUtil
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.gen.CommonMethodNames

+
+
No usage of com.amazon.carbonado.gen.CommonMethodNames
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.gen.DelegateStorableGenerator

+
+
No usage of com.amazon.carbonado.gen.DelegateStorableGenerator
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Interface
com.amazon.carbonado.gen.DelegateSupport

+
+
No usage of com.amazon.carbonado.gen.DelegateSupport
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.gen.DetachedStorableFactory

+
+
No usage of com.amazon.carbonado.gen.DetachedStorableFactory
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.gen.MasterFeature

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

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

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

Uses of Class
com.amazon.carbonado.gen.MasterStorableGenerator

+
+
No usage of com.amazon.carbonado.gen.MasterStorableGenerator
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Interface
com.amazon.carbonado.gen.MasterSupport

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/class-use/StorableCopier.From.html b/apidocs/com/amazon/carbonado/gen/class-use/StorableCopier.From.html new file mode 100644 index 0000000..b5f4a8d --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/StorableCopier.From.html @@ -0,0 +1,159 @@ + + + + + + +Uses of Class com.amazon.carbonado.gen.StorableCopier.From (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.gen.StorableCopier.From

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/class-use/StorableCopier.html b/apidocs/com/amazon/carbonado/gen/class-use/StorableCopier.html new file mode 100644 index 0000000..6c69b53 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/StorableCopier.html @@ -0,0 +1,159 @@ + + + + + + +Uses of Class com.amazon.carbonado.gen.StorableCopier (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.gen.StorableCopier

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

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

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

Uses of Class
com.amazon.carbonado.gen.StorableGenerator

+
+
No usage of com.amazon.carbonado.gen.StorableGenerator
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/class-use/StorablePropertyMap.html b/apidocs/com/amazon/carbonado/gen/class-use/StorablePropertyMap.html new file mode 100644 index 0000000..6b5be53 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/StorablePropertyMap.html @@ -0,0 +1,160 @@ + + + + + + +Uses of Class com.amazon.carbonado.gen.StorablePropertyMap (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.gen.StorablePropertyMap

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/class-use/StorableSupport.html b/apidocs/com/amazon/carbonado/gen/class-use/StorableSupport.html new file mode 100644 index 0000000..53be458 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/StorableSupport.html @@ -0,0 +1,225 @@ + + + + + + +Uses of Interface com.amazon.carbonado.gen.StorableSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.gen.StorableSupport

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/class-use/TriggerSupport.html b/apidocs/com/amazon/carbonado/gen/class-use/TriggerSupport.html new file mode 100644 index 0000000..62d1c01 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/TriggerSupport.html @@ -0,0 +1,219 @@ + + + + + + +Uses of Interface com.amazon.carbonado.gen.TriggerSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.gen.TriggerSupport

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/package-frame.html b/apidocs/com/amazon/carbonado/gen/package-frame.html new file mode 100644 index 0000000..2a3cb8a --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/package-frame.html @@ -0,0 +1,39 @@ + + + + + + +com.amazon.carbonado.gen (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.gen

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/gen/package-summary.html b/apidocs/com/amazon/carbonado/gen/package-summary.html new file mode 100644 index 0000000..5b325cc --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/package-summary.html @@ -0,0 +1,249 @@ + + + + + + +com.amazon.carbonado.gen (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.gen

+
+
Storable code generation support intended for use by repository implementations.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.gen Description

+
Storable code generation support intended for use by repository implementations.
+
Since:
+
1.2
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/package-tree.html b/apidocs/com/amazon/carbonado/gen/package-tree.html new file mode 100644 index 0000000..5a392c8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/package-tree.html @@ -0,0 +1,170 @@ + + + + + + +com.amazon.carbonado.gen Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.gen

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/gen/package-use.html b/apidocs/com/amazon/carbonado/gen/package-use.html new file mode 100644 index 0000000..64fe2be --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/package-use.html @@ -0,0 +1,250 @@ + + + + + + +Uses of Package com.amazon.carbonado.gen (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.gen

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/ChainedProperty.html b/apidocs/com/amazon/carbonado/info/ChainedProperty.html new file mode 100644 index 0000000..de0ae35 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/ChainedProperty.html @@ -0,0 +1,625 @@ + + + + + + +ChainedProperty (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.info
+

Class ChainedProperty<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Appender, java.io.Serializable
    +
    +
    +
    +
    public class ChainedProperty<S extends Storable>
+extends java.lang.Object
+implements java.io.Serializable, Appender
    +
    Represents a property to filter on or to order by. Properties may be + specified in a simple form, like "firstName", or in a chained form, like + "address.state". In both forms, the first property is the "prime" + property. All properties that follow are chained.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        get

        +
        public static <S extends Storable> ChainedProperty<S> get(StorableProperty<S> prime)
        +
        Returns a canonical instance which has no chain.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if prime is null
        +
        • +
      + + + +
        +
      • +

        get

        +
        public static <S extends Storable> ChainedProperty<S> get(StorableProperty<S> prime,
+                                          StorableProperty<?>... chain)
        +
        Returns a canonical instance.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if prime is null or if chained + properties are not formed properly
        +
        • +
      + + + +
        +
      • +

        get

        +
        public static <S extends Storable> ChainedProperty<S> get(StorableProperty<S> prime,
+                                          StorableProperty<?>[] chain,
+                                          boolean[] outerJoin)
        +
        Returns a canonical instance.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if prime is null or if chained + properties are not formed properly
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        parse

        +
        public static <S extends Storable> ChainedProperty<S> parse(StorableInfo<S> info,
+                                            java.lang.String str)
+                                                 throws java.lang.IllegalArgumentException
        +
        Parses a chained property.
        +
        Parameters:
        info - Info for Storable type containing property
        str - string to parse
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any parameter is null or string + format is incorrect
        +
        • +
      + + + + + + + +
        +
      • +

        getType

        +
        public java.lang.Class<?> getType()
        +
        Returns the type of the last property in the chain, or of the prime + property if the chain is empty.
        +
        • +
      + + + +
        +
      • +

        isNullable

        +
        public boolean isNullable()
        +
        Returns true if any property in the chain can be null.
        +
        Since:
        +
        1.2
        +
        See Also:
        Nullable
        +
        • +
      + + + +
        +
      • +

        isDerived

        +
        public boolean isDerived()
        +
        Returns true if any property in the chain is derived.
        +
        Since:
        +
        1.2
        +
        See Also:
        Derived
        +
        • +
      + + + +
        +
      • +

        getLastProperty

        +
        public StorableProperty<?> getLastProperty()
        +
        Returns the last property in the chain, or the prime property if chain + is empty.
        +
        • +
      + + + +
        +
      • +

        getChainCount

        +
        public int getChainCount()
        +
        Returns amount of properties chained from prime property, which may be + zero.
        +
        • +
      + + + +
        +
      • +

        getChainedProperty

        +
        public StorableProperty<?> getChainedProperty(int index)
+                                       throws java.lang.IndexOutOfBoundsException
        +
        Parameters:
        index - valid range is 0 to chainCount - 1
        +
        Throws:
        +
        java.lang.IndexOutOfBoundsException
        +
        • +
      + + + +
        +
      • +

        isOuterJoin

        +
        public boolean isOuterJoin(int index)
+                    throws java.lang.IndexOutOfBoundsException
        +
        Returns true if the property at the given index should be treated as an + outer join. Index zero is the prime property.
        +
        Parameters:
        index - valid range is 0 to chainCount
        +
        Throws:
        +
        java.lang.IndexOutOfBoundsException
        Since:
        +
        1.2
        +
        • +
      + + + + + + + +
        +
      • +

        append

        +
        public ChainedProperty<S> append(StorableProperty<?> property,
+                        boolean outerJoin)
        +
        Returns a new ChainedProperty with another property appended.
        +
        Parameters:
        outerJoin - pass true for outer join
        Since:
        +
        1.2
        +
        • +
      + + + + + + + +
        +
      • +

        trim

        +
        public ChainedProperty<S> trim()
        +
        Returns a new ChainedProperty with the last property in the chain removed.
        +
        Throws:
        +
        java.lang.IllegalStateException - if chain count is zero
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public ChainedProperty<?> tail()
        +
        Returns a new ChainedProperty which contains everything that follows + this ChainedProperty's prime property.
        +
        Throws:
        +
        java.lang.IllegalStateException - if chain count is zero
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Returns the chained property formatted as "name.subname.subsubname". + This format is parseable only if the chain is composed of valid + many-to-one joins.
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        appendTo

        +
        public void appendTo(java.lang.Appendable app)
+              throws java.io.IOException
        +
        Appends the chained property formatted as "name.subname.subsubname". + This format is parseable only if the chain is composed of valid + many-to-one joins.
        +
        +
        Specified by:
        +
        appendTo in interface Appender
        +
        Parameters:
        app - Appendable object to receive string representation
        +
        Throws:
        +
        java.io.IOException - if thrown from given Appendable
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/Direction.html b/apidocs/com/amazon/carbonado/info/Direction.html new file mode 100644 index 0000000..b1e7db0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/Direction.html @@ -0,0 +1,388 @@ + + + + + + +Direction (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.info
+

Enum Direction

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<Direction>
    +
    +
    +
    +
    public enum Direction
+extends java.lang.Enum<Direction>
    +
    Describes a property sorting direction.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static DirectionfromCharacter(char c) +
      Returns ASCENDING for '+', DESCENDING for '-', UNSPECIFIED for anything + else.
      +
      Directionreverse() +
      Returns the reverse direction of this.
      +
      chartoCharacter() +
      Returns '+' for ASCENDING, '-' for DESCENDING, and '~' for UNSPECIFIED.
      +
      static DirectionvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static Direction[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        ASCENDING

        +
        public static final Direction ASCENDING
        +
        • +
      + + + +
        +
      • +

        DESCENDING

        +
        public static final Direction DESCENDING
        +
        • +
      + + + +
        +
      • +

        UNSPECIFIED

        +
        public static final Direction UNSPECIFIED
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static Direction[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (Direction c : Direction.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in +the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static Direction valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public Direction reverse()
        +
        Returns the reverse direction of this.
        +
        • +
      + + + +
        +
      • +

        toCharacter

        +
        public char toCharacter()
        +
        Returns '+' for ASCENDING, '-' for DESCENDING, and '~' for UNSPECIFIED.
        +
        • +
      + + + +
        +
      • +

        fromCharacter

        +
        public static Direction fromCharacter(char c)
        +
        Returns ASCENDING for '+', DESCENDING for '-', UNSPECIFIED for anything + else.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/OrderedProperty.html b/apidocs/com/amazon/carbonado/info/OrderedProperty.html new file mode 100644 index 0000000..48833a5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/OrderedProperty.html @@ -0,0 +1,444 @@ + + + + + + +OrderedProperty (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.info
+

Class OrderedProperty<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Appender, java.io.Serializable
    +
    +
    +
    +
    public class OrderedProperty<S extends Storable>
+extends java.lang.Object
+implements java.io.Serializable, Appender
    +
    Represents a property paired with a preferred ordering direction.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        parse

        +
        public static <S extends Storable> OrderedProperty<S> parse(StorableInfo<S> info,
+                                            java.lang.String str)
+                                                 throws java.lang.IllegalArgumentException
        +
        Parses an ordering property, which may start with a '+' or '-' to + indicate direction. Prefix of '~' indicates unspecified direction. If + ordering prefix not specified, default direction is ascending.
        +
        Parameters:
        info - Info for Storable type containing property
        str - string to parse
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any required parameter is null or + string format is incorrect
        +
        • +
      + + + +
        +
      • +

        parse

        +
        public static <S extends Storable> OrderedProperty<S> parse(StorableInfo<S> info,
+                                            java.lang.String str,
+                                            Direction defaultDirection)
+                                                 throws java.lang.IllegalArgumentException
        +
        Parses an ordering property, which may start with a '+' or '-' to + indicate direction. Prefix of '~' indicates unspecified direction.
        +
        Parameters:
        info - Info for Storable type containing property
        str - string to parse
        defaultDirection - default direction if not specified in + string. If null, ascending order is defaulted.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any required parameter is null or + string format is incorrect
        +
        • +
      + + + + + + + +
        +
      • +

        getDirection

        +
        public Direction getDirection()
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Returns the chained property in a parseable form.
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        appendTo

        +
        public void appendTo(java.lang.Appendable app)
+              throws java.io.IOException
        +
        Description copied from interface: Appender
        +
        Append the string representation of this object to the given Appendable.
        +
        +
        Specified by:
        +
        appendTo in interface Appender
        +
        Parameters:
        app - Appendable object to receive string representation
        +
        Throws:
        +
        java.io.IOException - if thrown from given Appendable
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/StorableIndex.html b/apidocs/com/amazon/carbonado/info/StorableIndex.html new file mode 100644 index 0000000..863b3bf --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorableIndex.html @@ -0,0 +1,791 @@ + + + + + + +StorableIndex (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.info
+

Class StorableIndex<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Appender
    +
    +
    +
    +
    public class StorableIndex<S extends Storable>
+extends java.lang.Object
+implements Appender
    +
    Represents an index that must be defined for a specific Storable type.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Index
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StorableIndex

        +
        public StorableIndex(StorableProperty<S>[] properties,
+             Direction[] directions)
        +
        Creates a StorableIndex from the given properties and matching + directions. Both arrays must match length.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any argument is null, if lengths + do not match, or if any length is zero.
        +
        • +
      + + + +
        +
      • +

        StorableIndex

        +
        public StorableIndex(StorableProperty<S>[] properties,
+             Direction[] directions,
+             boolean unique)
        +
        Creates a StorableIndex from the given properties and matching + directions. Both arrays must match length. Allows specification of the + uniqueness of the index.
        +
        Parameters:
        properties -
        directions -
        unique -
        +
        • +
      + + + +
        +
      • +

        StorableIndex

        +
        public StorableIndex(StorableProperty<S>[] properties,
+             Direction[] directions,
+             boolean unique,
+             boolean clustered)
        +
        Creates a StorableIndex from the given properties and matching + directions. Both arrays must match length. Allows specification of the + uniqueness of the index as well as clustered option.
        +
        Parameters:
        properties -
        directions -
        unique -
        clustered -
        +
        • +
      + + + +
        +
      • +

        StorableIndex

        +
        public StorableIndex(StorableKey<S> key,
+             Direction direction)
        +
        Creates a StorableIndex from a StorableKey.
        +
        Parameters:
        direction - optional direction to apply to each key property that + has an unspecified direction
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if key is null or it has + no properties
        +
        • +
      + + + +
        +
      • +

        StorableIndex

        +
        public StorableIndex(OrderedProperty<S>[] properties,
+             Direction direction)
        +
        Creates a StorableIndex from OrderedProperties.
        +
        Parameters:
        direction - optional direction to apply to each property that + has an unspecified direction
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if no properties supplied
        +
        • +
      + + + +
        +
      • +

        StorableIndex

        +
        public StorableIndex(java.lang.Class<S> type,
+             IndexInfo indexInfo)
        +
        Creates a StorableIndex from an IndexInfo.
        +
        Parameters:
        type - type of storable index is defined for
        indexInfo - IndexInfo returned from storage object
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any argument is null, if any + properties are invalid, or if index info has no properties
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        parseNameDescriptor

        +
        public static <S extends Storable> StorableIndex<S> parseNameDescriptor(java.lang.String desc,
+                                                        StorableInfo<S> info)
+                                                             throws java.lang.IllegalArgumentException
        +
        Parses an index descriptor and returns an index object.
        +
        Parameters:
        desc - name descriptor, as created by getNameDescriptor()
        info - info on storable type
        +
        Returns:
        index represented by descriptor
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if error in descriptor syntax or if it + refers to unknown properties
        +
        • +
      + + + +
        +
      • +

        getStorableType

        +
        public java.lang.Class<S> getStorableType()
        +
        Returns the type of storable this index applies to.
        +
        • +
      + + + +
        +
      • +

        getPropertyCount

        +
        public int getPropertyCount()
        +
        Returns the count of properties in this index.
        +
        • +
      + + + +
        +
      • +

        getProperty

        +
        public StorableProperty<S> getProperty(int index)
        +
        Returns a specific property in this index.
        +
        • +
      + + + +
        +
      • +

        getProperties

        +
        public StorableProperty<S>[] getProperties()
        +
        Returns a new array with all the properties in it.
        +
        • +
      + + + +
        +
      • +

        getPropertyDirection

        +
        public Direction getPropertyDirection(int index)
        +
        Returns the requested direction of a specific property in this index.
        +
        • +
      + + + +
        +
      • +

        getPropertyDirections

        +
        public Direction[] getPropertyDirections()
        +
        Returns a new array with all the property directions in it.
        +
        • +
      + + + +
        +
      • +

        getOrderedProperty

        +
        public OrderedProperty<S> getOrderedProperty(int index)
        +
        Returns a specific property in this index, with the direction folded in.
        +
        • +
      + + + +
        +
      • +

        getOrderedProperties

        +
        public OrderedProperty<S>[] getOrderedProperties()
        +
        Returns a new array with all the properties in it, with directions + folded in.
        +
        • +
      + + + +
        +
      • +

        isUnique

        +
        public boolean isUnique()
        +
        • +
      + + + +
        +
      • +

        isClustered

        +
        public boolean isClustered()
        +
        Returns true if index is known to be clustered, which means it defines + the physical ordering of storables.
        +
        • +
      + + + +
        +
      • +

        unique

        +
        public StorableIndex<S> unique(boolean unique)
        +
        Returns a StorableIndex instance which is unique or not.
        +
        • +
      + + + +
        +
      • +

        clustered

        +
        public StorableIndex<S> clustered(boolean clustered)
        +
        Returns a StorableIndex instance which is clustered or not.
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public StorableIndex<S> reverse()
        +
        Returns a StorableIndex instance with all the properties reversed.
        +
        • +
      + + + +
        +
      • +

        setDefaultDirection

        +
        public StorableIndex<S> setDefaultDirection(Direction direction)
        +
        Returns a StorableIndex instance with all unspecified directions set to + the given direction. Returns this if all directions are already + specified.
        +
        Parameters:
        direction - direction to replace all unspecified directions
        +
        • +
      + + + +
        +
      • +

        addProperty

        +
        public StorableIndex<S> addProperty(StorableProperty<S> property,
+                           Direction direction)
        +
        Returns a StorableIndex with the given property added. If this index + already contained the given property (regardless of sort direction), + this index is returned.
        +
        Parameters:
        property - property to add unless already in this index
        direction - direction to apply to property, if added
        +
        Returns:
        new index with added property or this if index already contained property
        +
        • +
      + + + +
        +
      • +

        uniquify

        +
        public StorableIndex<S> uniquify(StorableKey<S> key)
        +
        Returns a StorableIndex which is unique, possibly by appending + properties from the given key. If index is already unique, it is + returned as-is.
        +
        • +
      + + + +
        +
      • +

        getNameDescriptor

        +
        public java.lang.String getNameDescriptor()
        +
        Converts this index into a parseable name descriptor string, whose + general format is: + +

        <storable type>~<attr><+|-|~><property><+|-|~><property>... + +

        Attr is "U" for a unique index, "N" for a non-unique index. + +

        Example: my.pkg.UserInfo~N+lastName+firstName-birthDate

        +
        See Also:
        parseNameDescriptor(String, StorableInfo)
        +
        • +
      + + + +
        +
      • +

        getTypeDescriptor

        +
        public java.lang.String getTypeDescriptor()
        +
        Converts this index into a parseable type descriptor string, which + basically consists of Java type descriptors appended together. There is + one slight difference. Types which may be null are prefixed with a 'N' + character.
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        appendTo

        +
        public void appendTo(java.lang.Appendable app)
+              throws java.io.IOException
        +
        Appends the same results as toString, but without the "StorableIndex" + prefix.
        +
        +
        Specified by:
        +
        appendTo in interface Appender
        +
        Parameters:
        app - Appendable object to receive string representation
        +
        Throws:
        +
        java.io.IOException - if thrown from given Appendable
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/StorableInfo.html b/apidocs/com/amazon/carbonado/info/StorableInfo.html new file mode 100644 index 0000000..ac528bb --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorableInfo.html @@ -0,0 +1,522 @@ + + + + + + +StorableInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.info
+

Interface StorableInfo<S extends Storable>

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetAlias(int index) +
      Returns a specific alias for the Storable.
      +
      intgetAliasCount() +
      Returns the count of aliases for the Storable.
      +
      java.lang.String[]getAliases() +
      Returns a new array with all the alias names in it.
      +
      java.util.Map<java.lang.String,? extends StorableProperty<S>>getAllProperties() +
      Returns all the storable properties in an unmodifiable map.
      +
      StorableKey<S>getAlternateKey(int index) +
      Returns a specific alternate key for the Storable.
      +
      intgetAlternateKeyCount() +
      Returns the count of alternate keys for the Storable.
      +
      StorableKey<S>[]getAlternateKeys() +
      Returns a new array with all the alternate keys in it.
      +
      java.util.Map<java.lang.String,? extends StorableProperty<S>>getDataProperties() +
      Returns a subset of the storable properties in an unmodifiable map + that define the basic data properties.
      +
      StorableIndex<S>getIndex(int index) +
      Returns a specific index for the Storable.
      +
      intgetIndexCount() +
      Returns the count of indexes defined for the Storable.
      +
      StorableIndex<S>[]getIndexes() +
      Returns a new array with all the indexes in it.
      +
      java.lang.StringgetName() +
      Returns the name of the Storable described by this StorableInfo, + which is an abbreviated form of the type's class name.
      +
      StorableKey<S>getPartitionKey() +
      Returns the partition key for the Storable, or null if none exists.
      +
      StorableKey<S>getPrimaryKey() +
      Returns the primary key for the Storable, never null.
      +
      java.util.Map<java.lang.String,? extends StorableProperty<S>>getPrimaryKeyProperties() +
      Returns a subset of the storable properties in an unmodifiable map + that define the primary key.
      +
      java.lang.Class<S>getStorableType() +
      Returns the type of Storable described by this StorableInfo.
      +
      StorableProperty<S>getVersionProperty() +
      Returns the designated version property, or null if none.
      +
      booleanisAuthoritative() 
      booleanisIndependent() 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        java.lang.String getName()
        +
        Returns the name of the Storable described by this StorableInfo, + which is an abbreviated form of the type's class name.
        +
        • +
      + + + +
        +
      • +

        getStorableType

        +
        java.lang.Class<S> getStorableType()
        +
        Returns the type of Storable described by this StorableInfo.
        +
        • +
      + + + +
        +
      • +

        getAllProperties

        +
        java.util.Map<java.lang.String,? extends StorableProperty<S>> getAllProperties()
        +
        Returns all the storable properties in an unmodifiable map. Properties + are always ordered, case-sensitive, by name. Primary key properties are + grouped first.
        +
        Returns:
        maps property names to property objects
        +
        • +
      + + + +
        +
      • +

        getPrimaryKeyProperties

        +
        java.util.Map<java.lang.String,? extends StorableProperty<S>> getPrimaryKeyProperties()
        +
        Returns a subset of the storable properties in an unmodifiable map + that define the primary key. Properties are always ordered, + case-sensitive, by name.
        +
        Returns:
        maps property names to property objects
        +
        • +
      + + + +
        +
      • +

        getDataProperties

        +
        java.util.Map<java.lang.String,? extends StorableProperty<S>> getDataProperties()
        +
        Returns a subset of the storable properties in an unmodifiable map + that define the basic data properties. Primary keys and joins are + excluded. Properties are always ordered, case-sensitive, by name.
        +
        Returns:
        maps property names to property objects
        +
        • +
      + + + +
        +
      • +

        getVersionProperty

        +
        StorableProperty<S> getVersionProperty()
        +
        Returns the designated version property, or null if none.
        +
        • +
      + + + +
        +
      • +

        getPrimaryKey

        +
        StorableKey<S> getPrimaryKey()
        +
        Returns the primary key for the Storable, never null.
        +
        • +
      + + + +
        +
      • +

        getAlternateKeyCount

        +
        int getAlternateKeyCount()
        +
        Returns the count of alternate keys for the Storable.
        +
        • +
      + + + +
        +
      • +

        getAlternateKey

        +
        StorableKey<S> getAlternateKey(int index)
        +
        Returns a specific alternate key for the Storable.
        +
        • +
      + + + +
        +
      • +

        getAlternateKeys

        +
        StorableKey<S>[] getAlternateKeys()
        +
        Returns a new array with all the alternate keys in it.
        +
        • +
      + + + +
        +
      • +

        getPartitionKey

        +
        StorableKey<S> getPartitionKey()
        +
        Returns the partition key for the Storable, or null if none exists.
        +
        • +
      + + + +
        +
      • +

        getAliasCount

        +
        int getAliasCount()
        +
        Returns the count of aliases for the Storable.
        +
        • +
      + + + +
        +
      • +

        getAlias

        +
        java.lang.String getAlias(int index)
+                          throws java.lang.IndexOutOfBoundsException
        +
        Returns a specific alias for the Storable.
        +
        Throws:
        +
        java.lang.IndexOutOfBoundsException
        +
        • +
      + + + +
        +
      • +

        getAliases

        +
        java.lang.String[] getAliases()
        +
        Returns a new array with all the alias names in it.
        +
        • +
      + + + +
        +
      • +

        getIndexCount

        +
        int getIndexCount()
        +
        Returns the count of indexes defined for the Storable.
        +
        • +
      + + + +
        +
      • +

        getIndex

        +
        StorableIndex<S> getIndex(int index)
+                                           throws java.lang.IndexOutOfBoundsException
        +
        Returns a specific index for the Storable.
        +
        Throws:
        +
        java.lang.IndexOutOfBoundsException
        +
        • +
      + + + +
        +
      • +

        getIndexes

        +
        StorableIndex<S>[] getIndexes()
        +
        Returns a new array with all the indexes in it.
        +
        • +
      + + + +
        +
      • +

        isIndependent

        +
        boolean isIndependent()
        +
        See Also:
        Independent
        +
        • +
      + + + +
        +
      • +

        isAuthoritative

        +
        boolean isAuthoritative()
        +
        See Also:
        Authoritative
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/StorableIntrospector.html b/apidocs/com/amazon/carbonado/info/StorableIntrospector.html new file mode 100644 index 0000000..61f6695 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorableIntrospector.html @@ -0,0 +1,319 @@ + + + + + + +StorableIntrospector (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.info
+

Class StorableIntrospector

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    JDBCStorableIntrospector
    +
    +
    +
    +
    public class StorableIntrospector
+extends java.lang.Object
    +
    Supports examination of Storable types, returning all metadata + associated with it. As part of the examination, all annotations are gathered + up. All examined data is cached, so repeat examinations are fast, unless the + examination failed.
    +
    Author:
    +
    Brian S O'Neill, Fang Chen, Tobias Holgers, Archit Shivaprakash
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static <S extends Storable> 
      StorableInfo<S>      		examine(java.lang.Class<S> type) +
      Examines the given class and returns a StorableInfo describing it.
      +
      static java.lang.Class<? extends Storable>inferType(java.lang.Class clazz) +
      Examines a class and determines what Storable type it implements.
      +
      static voidmain(java.lang.String[] args) +
      Test program which examines candidate Storable classes.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StorableIntrospector

        +
        public StorableIntrospector()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        main

        +
        public static void main(java.lang.String[] args)
+                 throws java.lang.Exception
        +
        Test program which examines candidate Storable classes. If any fail, an + exception is thrown.
        +
        Parameters:
        args - names of classes to examine
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        examine

        +
        public static <S extends Storable> StorableInfo<S> examine(java.lang.Class<S> type)
        +
        Examines the given class and returns a StorableInfo describing it. A + MalformedTypeException is thrown for a variety of reasons if the given + class is an invalid Storable type.
        +
        Parameters:
        type - Storable type to examine
        +
        Throws:
        +
        MalformedTypeException - if Storable type is invalid
        +
        java.lang.IllegalArgumentException - if type is null
        +
        • +
      + + + +
        +
      • +

        inferType

        +
        public static java.lang.Class<? extends Storable> inferType(java.lang.Class clazz)
        +
        Examines a class and determines what Storable type it implements. If it + cannot be unambiguously inferred, null is returned. A non-null return + value does not imply that the Storable type is valid, however. It must + be examined to check validity.
        +
        Since:
        +
        1.2
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/StorableKey.html b/apidocs/com/amazon/carbonado/info/StorableKey.html new file mode 100644 index 0000000..5dc66cb --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorableKey.html @@ -0,0 +1,245 @@ + + + + + + +StorableKey (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.info
+

Interface StorableKey<S extends Storable>

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.util.Set<? extends OrderedProperty<S>>getProperties() +
      Returns all the properties of the key in a properly ordered, + unmodifiable set.
      +
      booleanisPrimary() +
      Returns true if this key is primary, false otherwise.
      +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isPrimary

        +
        boolean isPrimary()
        +
        Returns true if this key is primary, false otherwise.
        +
        • +
      + + + +
        +
      • +

        getProperties

        +
        java.util.Set<? extends OrderedProperty<S>> getProperties()
        +
        Returns all the properties of the key in a properly ordered, + unmodifiable set.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/StorableProperty.html b/apidocs/com/amazon/carbonado/info/StorableProperty.html new file mode 100644 index 0000000..66cdb58 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorableProperty.html @@ -0,0 +1,929 @@ + + + + + + +StorableProperty (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.info
+

Interface StorableProperty<S extends Storable>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Appender, java.io.Serializable
    +
    +
    +
    All Known Subinterfaces:
    +
    JDBCStorableProperty<S>
    +
    +
    +
    +
    public interface StorableProperty<S extends Storable>
+extends java.io.Serializable, Appender
    +
    Contains all the metadata describing a property of a specific Storable type.
    +
    Author:
    +
    Brian S O'Neill, Tobias Holgers, Archit Shivaprakash
    +
    See Also:
    StorableIntrospector
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      StorablePropertyAdaptergetAdapter() +
      Returns this property's adapter, or null if none.
      +
      java.lang.StringgetAlias(int index) +
      Returns a specific alias for this property.
      +
      intgetAliasCount() +
      Returns the count of aliases for this property.
      +
      java.lang.String[]getAliases() +
      Returns a new array with all the alias names in it.
      +
      java.lang.StringgetBeanName() +
      Returns the bean name of this property, which is derived from the read + and write method names.
      +
      StorablePropertyConstraintgetConstraint(int index) +
      Returns a specific constraint for this property.
      +
      intgetConstraintCount() +
      Returns the count of constraints for this property.
      +
      StorablePropertyConstraint[]getConstraints() +
      Returns a new array with all the constraints in it.
      +
      java.lang.Class<?>[]getCovariantTypes() +
      Returns additional types of this property, all of which are assignable + by the primary type.
      +
      ChainedProperty<S>[]getDerivedFromProperties() +
      Returns a new array with all the derived-from properties, which is empty + if this is not a derived property.
      +
      ChainedProperty<?>[]getDerivedToProperties() +
      Returns a new array with all the properties which are derived from this + one.
      +
      java.lang.Class<S>getEnclosingType() +
      Returns the enclosing type of this property.
      +
      StorableProperty<?>getExternalJoinElement(int index) +
      Returns a specific property in the joined class that participates in the + join.
      +
      StorableProperty<?>[]getExternalJoinElements() +
      Returns a new array with all the external join elements in it.
      +
      StorableProperty<S>getInternalJoinElement(int index) +
      Returns a specific property in this property's class that participates + in the join.
      +
      StorableProperty<S>[]getInternalJoinElements() +
      Returns a new array with all the internal join elements in it.
      +
      java.lang.Class<? extends Storable>getJoinedType() +
      Returns the type of property this is joined to, or null if not joined.
      +
      intgetJoinElementCount() +
      Returns the count of properties that participate in this property's + join.
      +
      java.lang.StringgetName() +
      Returns the name of this property, which is the same as the bean name + unless it has been renamed.
      +
      intgetNumber() +
      Returns the zero-based numerical position of this property within its + enclosing type.
      +
      java.lang.reflect.MethodgetReadMethod() +
      Returns a no-arg method used to read the property value, or null if + reading is not allowed.
      +
      java.lang.StringgetReadMethodName() +
      Returns the name of the read method, even if no read method was actually + declared.
      +
      java.lang.StringgetSequenceName() +
      Returns the property's sequence name, or null if none.
      +
      java.lang.Class<?>getType() +
      Returns the primary type of this property.
      +
      java.lang.reflect.MethodgetWriteMethod() +
      Returns a one argument method used to write the property value, or null + if writing is not allowed.
      +
      java.lang.StringgetWriteMethodName() +
      Returns the name of the write method, even if no write method was + actually declared.
      +
      booleanisAlternateKeyMember() +
      Returns true if this property is a member of an alternate key.
      +
      booleanisAutomatic() +
      Returns true of this property is given an automatic value upon insert.
      +
      booleanisDerived() +
      Returns true if this property is derived.
      +
      booleanisIndependent() +
      Returns true if this property has been designated independent.
      +
      booleanisJoin() +
      Returns true if this property is joined in any way to another Storable.
      +
      booleanisNullable() +
      Returns true if this property can be null.
      +
      booleanisOneToOneJoin() +
      Returns true if this property is one-to-one joined to another Storable.
      +
      booleanisPartitionKeyMember() +
      Returns true if this property is a member of a partition key.
      +
      booleanisPrimaryKeyMember() +
      Returns true if this property is a member of a primary key.
      +
      booleanisQuery() +
      Returns true if this property is a query, which also implies that it is + a join property.
      +
      booleanisVersion() +
      Returns true if this property is the designated version number for the + Storable.
      +
      booleanshouldCopyDerived() +
      Returns true if this derived property should be included when copying a + storable.
      +
      java.lang.StringtoString() 
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        java.lang.String getName()
        +
        Returns the name of this property, which is the same as the bean name + unless it has been renamed.
        +
        • +
      + + + +
        +
      • +

        getBeanName

        +
        java.lang.String getBeanName()
        +
        Returns the bean name of this property, which is derived from the read + and write method names.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getType

        +
        java.lang.Class<?> getType()
        +
        Returns the primary type of this property.
        +
        • +
      + + + +
        +
      • +

        getCovariantTypes

        +
        java.lang.Class<?>[] getCovariantTypes()
        +
        Returns additional types of this property, all of which are assignable + by the primary type.
        +
        Since:
        +
        1.2.1
        +
        • +
      + + + +
        +
      • +

        getNumber

        +
        int getNumber()
        +
        Returns the zero-based numerical position of this property within its + enclosing type.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getEnclosingType

        +
        java.lang.Class<S> getEnclosingType()
        +
        Returns the enclosing type of this property.
        +
        • +
      + + + +
        +
      • +

        getReadMethod

        +
        java.lang.reflect.Method getReadMethod()
        +
        Returns a no-arg method used to read the property value, or null if + reading is not allowed. The return type matches the type of this + property.
        +
        • +
      + + + +
        +
      • +

        getReadMethodName

        +
        java.lang.String getReadMethodName()
        +
        Returns the name of the read method, even if no read method was actually + declared. That is, this method always returns a method name, but + getReadMethod may still return null.
        +
        • +
      + + + +
        +
      • +

        getWriteMethod

        +
        java.lang.reflect.Method getWriteMethod()
        +
        Returns a one argument method used to write the property value, or null + if writing is not allowed. The first argument is the value to set, which + is the type of this property.
        +
        • +
      + + + +
        +
      • +

        getWriteMethodName

        +
        java.lang.String getWriteMethodName()
        +
        Returns the name of the write method, even if no write method was + actually declared. That is, this method always returns a method name, + but getWriteMethod may still return null.
        +
        • +
      + + + +
        +
      • +

        isNullable

        +
        boolean isNullable()
        +
        Returns true if this property can be null.
        +
        See Also:
        Nullable
        +
        • +
      + + + +
        +
      • +

        isPrimaryKeyMember

        +
        boolean isPrimaryKeyMember()
        +
        Returns true if this property is a member of a primary key.
        +
        See Also:
        PrimaryKey
        +
        • +
      + + + +
        +
      • +

        isAlternateKeyMember

        +
        boolean isAlternateKeyMember()
        +
        Returns true if this property is a member of an alternate key.
        +
        See Also:
        AlternateKeys
        +
        • +
      + + + +
        +
      • +

        isPartitionKeyMember

        +
        boolean isPartitionKeyMember()
        +
        Returns true if this property is a member of a partition key.
        +
        See Also:
        PartitionKey
        +
        • +
      + + + +
        +
      • +

        getAliasCount

        +
        int getAliasCount()
        +
        Returns the count of aliases for this property.
        +
        See Also:
        Alias
        +
        • +
      + + + +
        +
      • +

        getAlias

        +
        java.lang.String getAlias(int index)
+                          throws java.lang.IndexOutOfBoundsException
        +
        Returns a specific alias for this property.
        +
        Throws:
        +
        java.lang.IndexOutOfBoundsException
        See Also:
        Alias
        +
        • +
      + + + +
        +
      • +

        getAliases

        +
        java.lang.String[] getAliases()
        +
        Returns a new array with all the alias names in it.
        +
        See Also:
        Alias
        +
        • +
      + + + +
        +
      • +

        isJoin

        +
        boolean isJoin()
        +
        Returns true if this property is joined in any way to another Storable.
        +
        See Also:
        Join
        +
        • +
      + + + +
        +
      • +

        isOneToOneJoin

        +
        boolean isOneToOneJoin()
        +
        Returns true if this property is one-to-one joined to another Storable.
        +
        Since:
        +
        1.2
        +
        See Also:
        Join
        +
        • +
      + + + +
        +
      • +

        getJoinedType

        +
        java.lang.Class<? extends Storable> getJoinedType()
        +
        Returns the type of property this is joined to, or null if not joined.
        +
        • +
      + + + +
        +
      • +

        getJoinElementCount

        +
        int getJoinElementCount()
        +
        Returns the count of properties that participate in this property's + join. If this property is not a join, then zero is returned.
        +
        • +
      + + + +
        +
      • +

        getInternalJoinElement

        +
        StorableProperty<S> getInternalJoinElement(int index)
+                                                            throws java.lang.IndexOutOfBoundsException
        +
        Returns a specific property in this property's class that participates + in the join.
        +
        Throws:
        +
        java.lang.IndexOutOfBoundsException
        +
        • +
      + + + +
        +
      • +

        getInternalJoinElements

        +
        StorableProperty<S>[] getInternalJoinElements()
        +
        Returns a new array with all the internal join elements in it.
        +
        • +
      + + + +
        +
      • +

        getExternalJoinElement

        +
        StorableProperty<?> getExternalJoinElement(int index)
+                                           throws java.lang.IndexOutOfBoundsException
        +
        Returns a specific property in the joined class that participates in the + join.
        +
        Throws:
        +
        java.lang.IndexOutOfBoundsException
        +
        • +
      + + + +
        +
      • +

        getExternalJoinElements

        +
        StorableProperty<?>[] getExternalJoinElements()
        +
        Returns a new array with all the external join elements in it.
        +
        • +
      + + + +
        +
      • +

        isQuery

        +
        boolean isQuery()
        +
        Returns true if this property is a query, which also implies that it is + a join property.
        +
        See Also:
        Query
        +
        • +
      + + + +
        +
      • +

        getConstraintCount

        +
        int getConstraintCount()
        +
        Returns the count of constraints for this property.
        +
        • +
      + + + +
        +
      • +

        getConstraint

        +
        StorablePropertyConstraint getConstraint(int index)
+                                         throws java.lang.IndexOutOfBoundsException
        +
        Returns a specific constraint for this property.
        +
        Throws:
        +
        java.lang.IndexOutOfBoundsException
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getSequenceName

        +
        java.lang.String getSequenceName()
        +
        Returns the property's sequence name, or null if none.
        +
        See Also:
        Sequence
        +
        • +
      + + + +
        +
      • +

        isAutomatic

        +
        boolean isAutomatic()
        +
        Returns true of this property is given an automatic value upon insert.
        +
        Since:
        +
        1.2
        +
        See Also:
        Automatic
        +
        • +
      + + + +
        +
      • +

        isVersion

        +
        boolean isVersion()
        +
        Returns true if this property is the designated version number for the + Storable.
        +
        See Also:
        Version
        +
        • +
      + + + +
        +
      • +

        isIndependent

        +
        boolean isIndependent()
        +
        Returns true if this property has been designated independent.
        +
        See Also:
        Independent
        +
        • +
      + + + +
        +
      • +

        isDerived

        +
        boolean isDerived()
        +
        Returns true if this property is derived.
        +
        Since:
        +
        1.2
        +
        See Also:
        Derived
        +
        • +
      + + + +
        +
      • +

        getDerivedFromProperties

        +
        ChainedProperty<S>[] getDerivedFromProperties()
        +
        Returns a new array with all the derived-from properties, which is empty + if this is not a derived property. Otherwise, the set is the transitive + closure of all dependent properties. This set may include joins and + other derived properties.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getDerivedToProperties

        +
        ChainedProperty<?>[] getDerivedToProperties()
        +
        Returns a new array with all the properties which are derived from this + one. The set is the transitive closure of all derived properties which + depend on this one. + +

        Each property in the set is represented as a chain, where the prime + property is the actual dependent property, and the tail is the path to + reach this property's enclosing type. If a derived property resides in + the same enclosing type as this one, the chain count is zero.

        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        shouldCopyDerived

        +
        boolean shouldCopyDerived()
        +
        Returns true if this derived property should be included when copying a + storable. Copying of a derived property uses the "get" and "set" methods + and requires the "set" method to be defined.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        toString

        +
        java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/StorablePropertyAdapter.html b/apidocs/com/amazon/carbonado/info/StorablePropertyAdapter.html new file mode 100644 index 0000000..fb3e3c2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorablePropertyAdapter.html @@ -0,0 +1,432 @@ + + + + + + +StorablePropertyAdapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.info
+

Class StorablePropertyAdapter

+
+
+ +
+
    +
  • +
    +
    +
    public class StorablePropertyAdapter
+extends java.lang.Object
    +
    Information about an adapter annotation applied to a property.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      StorablePropertyAdapter(java.lang.String propertyName, + java.lang.Class<?> propertyType, + java.lang.Class<? extends java.lang.annotation.Annotation> adapterType) +
      Construct a generic StorablePropertyAdapter instance not attached to a + storable definition.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.reflect.MethodfindAdaptMethod(java.lang.Class from, + java.lang.Class to) +
      Returns an adapt method that supports the given conversion, or null if + none.
      +
      java.lang.reflect.Method[]findAdaptMethodsFrom(java.lang.Class from) +
      Returns all the adapt methods that convert from the given type.
      +
      java.lang.reflect.Method[]findAdaptMethodsTo(java.lang.Class to) +
      Returns all the adapt methods that convert to the given type.
      +
      java.lang.reflect.ConstructorgetAdapterConstructor() +
      Returns the constructor for the adapter class.
      +
      java.lang.ObjectgetAdapterInstance() +
      Returns an instance of the adapter, for which an adapt method is applied to.
      +
      java.lang.reflect.MethodgetAdaptMethod(int index) +
      Returns a specific adapt method.
      +
      intgetAdaptMethodCount() +
      Returns the count of all defined adapt methods.
      +
      java.lang.reflect.Method[]getAdaptMethods() +
      Returns a new array with all the adapt methods in it.
      +
      StorablePropertyAnnotationgetAnnotation() +
      Returns the annotation that applied this adapter, or null if none.
      +
      java.lang.Class[]getStorageTypePreferences() +
      Returns the adapter's storage type preferences.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StorablePropertyAdapter

        +
        public StorablePropertyAdapter(java.lang.String propertyName,
+                       java.lang.Class<?> propertyType,
+                       java.lang.Class<? extends java.lang.annotation.Annotation> adapterType)
        +
        Construct a generic StorablePropertyAdapter instance not attached to a + storable definition. Call StorableProperty.getAdapter() to gain + access to adapter information on actual storable definitions.
        +
        Parameters:
        propertyName - name of property with adapter
        propertyType - declated type of adapted property
        adapterType - adapter type
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if adapterType is not an adapter + definition.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAnnotation

        +
        public StorablePropertyAnnotation getAnnotation()
        +
        Returns the annotation that applied this adapter, or null if none.
        +
        • +
      + + + +
        +
      • +

        getAdapterConstructor

        +
        public java.lang.reflect.Constructor getAdapterConstructor()
        +
        Returns the constructor for the adapter class. It has the signature + (Class type, String propertyName, Annotation), where + Annotation is the fully resolved annotation.
        +
        • +
      + + + +
        +
      • +

        getAdapterInstance

        +
        public java.lang.Object getAdapterInstance()
        +
        Returns an instance of the adapter, for which an adapt method is applied to.
        +
        • +
      + + + + + + + +
        +
      • +

        findAdaptMethod

        +
        public java.lang.reflect.Method findAdaptMethod(java.lang.Class from,
+                                       java.lang.Class to)
        +
        Returns an adapt method that supports the given conversion, or null if + none.
        +
        • +
      + + + +
        +
      • +

        findAdaptMethodsFrom

        +
        public java.lang.reflect.Method[] findAdaptMethodsFrom(java.lang.Class from)
        +
        Returns all the adapt methods that convert from the given type.
        +
        • +
      + + + +
        +
      • +

        findAdaptMethodsTo

        +
        public java.lang.reflect.Method[] findAdaptMethodsTo(java.lang.Class to)
        +
        Returns all the adapt methods that convert to the given type.
        +
        • +
      + + + +
        +
      • +

        getAdaptMethodCount

        +
        public int getAdaptMethodCount()
        +
        Returns the count of all defined adapt methods.
        +
        • +
      + + + +
        +
      • +

        getAdaptMethod

        +
        public java.lang.reflect.Method getAdaptMethod(int index)
+                                        throws java.lang.IndexOutOfBoundsException
        +
        Returns a specific adapt method.
        +
        Throws:
        +
        java.lang.IndexOutOfBoundsException
        +
        • +
      + + + +
        +
      • +

        getAdaptMethods

        +
        public java.lang.reflect.Method[] getAdaptMethods()
        +
        Returns a new array with all the adapt methods in it.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/StorablePropertyAnnotation.html b/apidocs/com/amazon/carbonado/info/StorablePropertyAnnotation.html new file mode 100644 index 0000000..331aad5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorablePropertyAnnotation.html @@ -0,0 +1,324 @@ + + + + + + +StorablePropertyAnnotation (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.info
+

Class StorablePropertyAnnotation

+
+
+ +
+
    +
  • +
    +
    +
    public class StorablePropertyAnnotation
+extends java.lang.Object
    +
    Information about a custom annotation applied to a property.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      StorablePropertyAnnotation(java.lang.annotation.Annotation annotation, + java.lang.reflect.Method method) +
      Use this constructor if an annotation was actually defined.
      +
      StorablePropertyAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType, + java.lang.reflect.Method method) +
      Use this constructor if an annotation was not defined, but instead is + being automatically applied.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.reflect.MethodgetAnnotatedMethod() +
      Returns the method that has the annotation.
      +
      java.lang.annotation.AnnotationgetAnnotation() +
      Returns the actual annotation instance, which may be null if annotation + was automatically applied.
      +
      java.lang.Class<? extends java.lang.annotation.Annotation>getAnnotationType() +
      Returns the type of annotation that was applied to the property method.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StorablePropertyAnnotation

        +
        public StorablePropertyAnnotation(java.lang.annotation.Annotation annotation,
+                          java.lang.reflect.Method method)
        +
        Use this constructor if an annotation was actually defined.
        +
        Parameters:
        annotation - annotation on method
        method - method with annotation
        +
        • +
      + + + +
        +
      • +

        StorablePropertyAnnotation

        +
        public StorablePropertyAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType,
+                          java.lang.reflect.Method method)
        +
        Use this constructor if an annotation was not defined, but instead is + being automatically applied.
        +
        Parameters:
        annotationType - annotation type on method
        method - method with annotation
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAnnotation

        +
        public java.lang.annotation.Annotation getAnnotation()
        +
        Returns the actual annotation instance, which may be null if annotation + was automatically applied.
        +
        • +
      + + + +
        +
      • +

        getAnnotationType

        +
        public java.lang.Class<? extends java.lang.annotation.Annotation> getAnnotationType()
        +
        Returns the type of annotation that was applied to the property method.
        +
        • +
      + + + +
        +
      • +

        getAnnotatedMethod

        +
        public java.lang.reflect.Method getAnnotatedMethod()
        +
        Returns the method that has the annotation.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/StorablePropertyConstraint.html b/apidocs/com/amazon/carbonado/info/StorablePropertyConstraint.html new file mode 100644 index 0000000..5d682cb --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorablePropertyConstraint.html @@ -0,0 +1,264 @@ + + + + + + +StorablePropertyConstraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.info
+

Class StorablePropertyConstraint

+
+
+ +
+
    +
  • +
    +
    +
    public class StorablePropertyConstraint
+extends java.lang.Object
    +
    Information about a constraint annotation applied to a property.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      StorablePropertyAnnotationgetAnnotation() +
      Returns the annotation that applied this constraint.
      +
      java.lang.reflect.MethodgetConstrainMethod() +
      Returns the best matching property checking method in the validator.
      +
      java.lang.reflect.ConstructorgetConstraintConstructor() +
      Returns the constructor for the constraint class.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getConstraintConstructor

        +
        public java.lang.reflect.Constructor getConstraintConstructor()
        +
        Returns the constructor for the constraint class. It has the signature + (Class type, String propertyName, Annotation), where + Annotation is the fully resolved annotation.
        +
        • +
      + + + +
        +
      • +

        getConstrainMethod

        +
        public java.lang.reflect.Method getConstrainMethod()
        +
        Returns the best matching property checking method in the validator.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + 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) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.info.ChainedProperty

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

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

+ + 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) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.info.Direction

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

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

+ + 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) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.info.OrderedProperty

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

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

+ + 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) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.info.StorableIndex

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

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

+ + 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) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.info.StorableInfo

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

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

+ + 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) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.info.StorableIntrospector

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

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

+ + 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) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.info.StorableKey

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

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

+ + 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) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.info.StorableProperty

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

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

+ + 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) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.info.StorablePropertyAdapter

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

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

+ + 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) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.info.StorablePropertyAnnotation

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

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

+ + 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) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.info.StorablePropertyConstraint

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/package-frame.html b/apidocs/com/amazon/carbonado/info/package-frame.html new file mode 100644 index 0000000..56882b7 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/package-frame.html @@ -0,0 +1,36 @@ + + + + + + +com.amazon.carbonado.info (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.info

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/info/package-summary.html b/apidocs/com/amazon/carbonado/info/package-summary.html new file mode 100644 index 0000000..166687d --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/package-summary.html @@ -0,0 +1,230 @@ + + + + + + +com.amazon.carbonado.info (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.info

+
+
Introspection support for Storables.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.info Description

+
Introspection support for Storables.
+
See Also:
StorableIntrospector
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/package-tree.html b/apidocs/com/amazon/carbonado/info/package-tree.html new file mode 100644 index 0000000..e755e36 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/package-tree.html @@ -0,0 +1,163 @@ + + + + + + +com.amazon.carbonado.info Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.info

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/package-use.html b/apidocs/com/amazon/carbonado/info/package-use.html new file mode 100644 index 0000000..5d3c1c5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/package-use.html @@ -0,0 +1,443 @@ + + + + + + +Uses of Package com.amazon.carbonado.info (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.info

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/Layout.html b/apidocs/com/amazon/carbonado/layout/Layout.html new file mode 100644 index 0000000..284f919 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/Layout.html @@ -0,0 +1,580 @@ + + + + + + +Layout (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.layout
+

Class Layout

+
+
+ +
+
    +
  • +
    +
    +
    public class Layout
+extends java.lang.Object
    +
    Describes the layout of a specific generation of a storable.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    LayoutFactory
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanequalLayouts(Layout layout) +
      Returns true if the given layout matches this one.
      +
      booleanequals(java.lang.Object obj) 
      java.util.List<LayoutProperty>getAllProperties() +
      Returns all the properties of this layout, in their proper order.
      +
      org.joda.time.DateTimegetCreationDateTime() +
      Returns the date and time for when this layout generation was created.
      +
      java.lang.StringgetCreationHost() +
      Returns the host machine that created this generation.
      +
      java.lang.StringgetCreationUser() +
      Returns the user that created this layout generation.
      +
      java.util.List<LayoutProperty>getDataProperties() +
      Returns all the non-primary key properties of this layout, in their + proper order.
      +
      intgetGeneration() +
      Returns the generation of this layout, where zero represents the first + generation.
      +
      LayoutgetGeneration(int generation) +
      Returns the layout for a particular generation of this layout's type.
      +
      longgetLayoutID() +
      Returns a unique identifier for this layout.
      +
      LayoutOptionsgetOptions() +
      Returns additional options, or null if none.
      +
      java.lang.StringgetStorableTypeName() +
      Storable type name is a fully qualified Java class name.
      +
      inthashCode() 
      LayoutnextGeneration() +
      Returns the next known generation of the storable's layout, or null + if none.
      +
      LayoutpreviousGeneration() +
      Returns the previous known generation of the storable's layout, or null + if none.
      +
      java.lang.Class<? extends Storable>reconstruct() +
      Reconstructs the storable type defined by this layout by returning an + auto-generated class.
      +
      java.lang.Class<? extends Storable>reconstruct(java.lang.ClassLoader loader) +
      Reconstructs the storable type defined by this layout by returning an + auto-generated class.
      +
      java.lang.StringtoString() 
      voidwriteTo(java.io.OutputStream out) +
      Write a layout to be read by LayoutFactory.readLayoutFrom(java.io.InputStream).
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getLayoutID

        +
        public long getLayoutID()
        +
        Returns a unique identifier for this layout.
        +
        • +
      + + + +
        +
      • +

        getStorableTypeName

        +
        public java.lang.String getStorableTypeName()
        +
        Storable type name is a fully qualified Java class name.
        +
        • +
      + + + +
        +
      • +

        getGeneration

        +
        public int getGeneration()
        +
        Returns the generation of this layout, where zero represents the first + generation.
        +
        • +
      + + + +
        +
      • +

        getDataProperties

        +
        public java.util.List<LayoutProperty> getDataProperties()
+                                                 throws FetchException
        +
        Returns all the non-primary key properties of this layout, in their + proper order.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + + + + + +
        +
      • +

        getCreationDateTime

        +
        public org.joda.time.DateTime getCreationDateTime()
        +
        Returns the date and time for when this layout generation was created.
        +
        • +
      + + + +
        +
      • +

        getCreationUser

        +
        public java.lang.String getCreationUser()
        +
        Returns the user that created this layout generation.
        +
        • +
      + + + +
        +
      • +

        getCreationHost

        +
        public java.lang.String getCreationHost()
        +
        Returns the host machine that created this generation.
        +
        • +
      + + + +
        +
      • +

        getOptions

        +
        public LayoutOptions getOptions()
        +
        Returns additional options, or null if none.
        +
        Returns:
        read-only object or null
        +
        • +
      + + + + + + + +
        +
      • +

        previousGeneration

        +
        public Layout previousGeneration()
+                          throws FetchException
        +
        Returns the previous known generation of the storable's layout, or null + if none.
        +
        Returns:
        a layout with a lower generation, or null if none
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        nextGeneration

        +
        public Layout nextGeneration()
+                      throws FetchException
        +
        Returns the next known generation of the storable's layout, or null + if none.
        +
        Returns:
        a layout with a higher generation, or null if none
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        reconstruct

        +
        public java.lang.Class<? extends Storable> reconstruct()
+                                                throws FetchException,
+                                                       SupportException
        +
        Reconstructs the storable type defined by this layout by returning an + auto-generated class. The reconstructed storable type will not contain + everything in the original, but rather the minimum required to decode + persisted instances.
        +
        Throws:
        +
        FetchException
        +
        SupportException
        +
        • +
      + + + +
        +
      • +

        reconstruct

        +
        public java.lang.Class<? extends Storable> reconstruct(java.lang.ClassLoader loader)
+                                                throws FetchException,
+                                                       SupportException
        +
        Reconstructs the storable type defined by this layout by returning an + auto-generated class. The reconstructed storable type will not contain + everything in the original, but rather the minimum required to decode + persisted instances.
        +
        Parameters:
        loader - optional ClassLoader to load reconstruct class into, if it + has not been loaded yet
        +
        Throws:
        +
        FetchException
        +
        SupportException
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equalLayouts

        +
        public boolean equalLayouts(Layout layout)
+                     throws FetchException
        +
        Returns true if the given layout matches this one. Layout ID, + generation, and creation info is not considered in the comparison.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/LayoutCapability.html b/apidocs/com/amazon/carbonado/layout/LayoutCapability.html new file mode 100644 index 0000000..ba50e1f --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/LayoutCapability.html @@ -0,0 +1,253 @@ + + + + + + +LayoutCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.layout
+

Interface LayoutCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    All Known Implementing Classes:
    +
    LayoutFactory
    +
    +
    +
    +
    public interface LayoutCapability
+extends Capability
    +
    Capability to get layout information on any storable generation.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      LayoutlayoutFor(java.lang.Class<? extends Storable> type) +
      Returns the layout matching the current definition of the given type.
      +
      LayoutlayoutFor(java.lang.Class<? extends Storable> type, + int generation) +
      Returns the layout for a particular generation of the given type.
      +
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/LayoutFactory.html b/apidocs/com/amazon/carbonado/layout/LayoutFactory.html new file mode 100644 index 0000000..ea086bc --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/LayoutFactory.html @@ -0,0 +1,421 @@ + + + + + + +LayoutFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.layout
+

Class LayoutFactory

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Capability, LayoutCapability
    +
    +
    +
    +
    public class LayoutFactory
+extends java.lang.Object
+implements LayoutCapability
    +
    Factory for obtaining references to storable layouts.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static intVERSION 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      LayoutlayoutFor(boolean readOnly, + java.lang.Class<? extends Storable> type, + LayoutOptions options) +
      Returns the layout matching the current definition of the given type.
      +
      LayoutlayoutFor(java.lang.Class<? extends Storable> type) +
      Returns the layout matching the current definition of the given type.
      +
      LayoutlayoutFor(java.lang.Class<? extends Storable> type, + int generation) +
      Returns the layout for a particular generation of the given type.
      +
      LayoutlayoutFor(java.lang.Class<? extends Storable> type, + LayoutOptions options) +
      Returns the layout matching the current definition of the given type.
      +
      LayoutreadLayoutFrom(java.io.InputStream in) +
      Read a layout as written by Layout.writeTo(java.io.OutputStream).
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/LayoutOptions.html b/apidocs/com/amazon/carbonado/layout/LayoutOptions.html new file mode 100644 index 0000000..f6e36c3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/LayoutOptions.html @@ -0,0 +1,307 @@ + + + + + + +LayoutOptions (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.layout
+

Class LayoutOptions

+
+
+ +
+
    +
  • +
    +
    +
    public class LayoutOptions
+extends java.lang.Object
    +
    Extra options encoded with a Storable layout.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      LayoutOptions() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiddecode(byte[] source) 
      byte[]encode() 
      java.lang.StringgetCompressionType() 
      voidsetCompressionType(java.lang.String type) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LayoutOptions

        +
        public LayoutOptions()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getCompressionType

        +
        public java.lang.String getCompressionType()
        +
        Returns:
        null if not compressed
        +
        • +
      + + + +
        +
      • +

        setCompressionType

        +
        public void setCompressionType(java.lang.String type)
        +
        Parameters:
        type - null if not compressed
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public byte[] encode()
        +
        Returns:
        null if empty
        +
        • +
      + + + +
        +
      • +

        decode

        +
        public void decode(byte[] source)
+            throws java.io.IOException
        +
        Parameters:
        source - can be null if empty
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/LayoutProperty.html b/apidocs/com/amazon/carbonado/layout/LayoutProperty.html new file mode 100644 index 0000000..0acb8be --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/LayoutProperty.html @@ -0,0 +1,410 @@ + + + + + + +LayoutProperty (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.layout
+

Class LayoutProperty

+
+
+ +
+
    +
  • +
    +
    +
    public class LayoutProperty
+extends java.lang.Object
    +
    Describes how a property is defined in a specific generation of a storable.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Layout
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object obj) 
      java.lang.StringgetAdapterParams() +
      Parameters for adapter, or null if property has no explicit adapter.
      +
      java.lang.StringgetAdapterTypeName() +
      Adapter type name is a fully qualified Java class name.
      +
      java.lang.StringgetPropertyName() 
      java.lang.ClassgetPropertyType() 
      java.lang.ClassgetPropertyType(java.lang.ClassLoader loader) 
      java.lang.StringgetPropertyTypeDescriptor() +
      Property type descriptor is a Java type descriptor.
      +
      inthashCode() 
      booleanisNullable() +
      Returns true of property can be set to null.
      +
      booleanisPrimaryKeyMember() +
      Returns true if property is a member of the primary key.
      +
      booleanisVersion() +
      Returns true if this property is the designated version number for the + Storable.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPropertyName

        +
        public java.lang.String getPropertyName()
        +
        • +
      + + + +
        +
      • +

        getPropertyTypeDescriptor

        +
        public java.lang.String getPropertyTypeDescriptor()
        +
        Property type descriptor is a Java type descriptor.
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        isNullable

        +
        public boolean isNullable()
        +
        Returns true of property can be set to null.
        +
        • +
      + + + +
        +
      • +

        isPrimaryKeyMember

        +
        public boolean isPrimaryKeyMember()
        +
        Returns true if property is a member of the primary key.
        +
        • +
      + + + +
        +
      • +

        isVersion

        +
        public boolean isVersion()
        +
        Returns true if this property is the designated version number for the + Storable.
        +
        • +
      + + + +
        +
      • +

        getAdapterTypeName

        +
        public java.lang.String getAdapterTypeName()
        +
        Adapter type name is a fully qualified Java class name. If property has + no adapter, then null is returned.
        +
        • +
      + + + +
        +
      • +

        getAdapterParams

        +
        public java.lang.String getAdapterParams()
        +
        Parameters for adapter, or null if property has no explicit adapter.
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/LayoutSync.html b/apidocs/com/amazon/carbonado/layout/LayoutSync.html new file mode 100644 index 0000000..c9b784b --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/LayoutSync.html @@ -0,0 +1,268 @@ + + + + + + +LayoutSync (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.layout
+

Class LayoutSync

+
+
+ +
+
    +
  • +
    +
    +
    public class LayoutSync
+extends java.lang.Object
    +
    Synchronizes layout metadata between two repositories. Both source and + destination might be updated.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanrun() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/StoredLayout.html b/apidocs/com/amazon/carbonado/layout/StoredLayout.html new file mode 100644 index 0000000..6652179 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/StoredLayout.html @@ -0,0 +1,456 @@ + + + + + + +StoredLayout (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.layout
+

Interface StoredLayout

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getLayoutID

        +
        long getLayoutID()
        +
        • +
      + + + +
        +
      • +

        setLayoutID

        +
        void setLayoutID(long typeID)
        +
        • +
      + + + +
        +
      • +

        getStorableTypeName

        +
        java.lang.String getStorableTypeName()
        +
        Storable type name is a fully qualified Java class name.
        +
        • +
      + + + +
        +
      • +

        setStorableTypeName

        +
        void setStorableTypeName(java.lang.String typeName)
        +
        • +
      + + + +
        +
      • +

        getGeneration

        +
        int getGeneration()
        +
        Generation of storable, where 0 represents the first generation.
        +
        • +
      + + + +
        +
      • +

        setGeneration

        +
        void setGeneration(int generation)
        +
        • +
      + + + +
        +
      • +

        getCreationTimestamp

        +
        long getCreationTimestamp()
        +
        Returns the milliseconds from 1970-01-01T00:00:00Z when this record was + created.
        +
        • +
      + + + +
        +
      • +

        setCreationTimestamp

        +
        void setCreationTimestamp(long timestamp)
        +
        • +
      + + + +
        +
      • +

        getCreationUser

        +
        @Nullable
+java.lang.String getCreationUser()
        +
        Returns the user that created this generation.
        +
        • +
      + + + +
        +
      • +

        setCreationUser

        +
        void setCreationUser(java.lang.String user)
        +
        • +
      + + + +
        +
      • +

        getCreationHost

        +
        @Nullable
+java.lang.String getCreationHost()
        +
        Returns the host machine that created this generation.
        +
        • +
      + + + +
        +
      • +

        setCreationHost

        +
        void setCreationHost(java.lang.String host)
        +
        • +
      + + + +
        +
      • +

        getVersionNumber

        +
        @Version
+int getVersionNumber()
        +
        Record version number for this StoredTypeLayout instance. Some encoding + strategies require a version number.
        +
        • +
      + + + +
        +
      • +

        setVersionNumber

        +
        void setVersionNumber(int version)
        +
        • +
      + + + +
        +
      • +

        getExtraData

        +
        @Nullable
+byte[] getExtraData()
        +
        Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records. This record cannot evolve + because an evolution strategy likely depends on this interface remaining + stable, avoiding a cyclic dependency.
        +
        • +
      + + + +
        +
      • +

        setExtraData

        +
        void setExtraData(byte[] data)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/StoredLayoutEquivalence.html b/apidocs/com/amazon/carbonado/layout/StoredLayoutEquivalence.html new file mode 100644 index 0000000..e95aa3d --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/StoredLayoutEquivalence.html @@ -0,0 +1,354 @@ + + + + + + +StoredLayoutEquivalence (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.layout
+

Interface StoredLayoutEquivalence

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStorableTypeName

        +
        java.lang.String getStorableTypeName()
        +
        Storable type name is a fully qualified Java class name.
        +
        • +
      + + + +
        +
      • +

        setStorableTypeName

        +
        void setStorableTypeName(java.lang.String typeName)
        +
        • +
      + + + +
        +
      • +

        getGeneration

        +
        int getGeneration()
        +
        Generation of storable, where 0 represents the first generation.
        +
        • +
      + + + +
        +
      • +

        setGeneration

        +
        void setGeneration(int generation)
        +
        • +
      + + + +
        +
      • +

        getMatchedGeneration

        +
        int getMatchedGeneration()
        +
        Generation of matched layout.
        +
        • +
      + + + +
        +
      • +

        setMatchedGeneration

        +
        void setMatchedGeneration(int generation)
        +
        • +
      + + + +
        +
      • +

        getVersionNumber

        +
        @Version
+int getVersionNumber()
        +
        • +
      + + + +
        +
      • +

        setVersionNumber

        +
        void setVersionNumber(int version)
        +
        • +
      + + + +
        +
      • +

        getExtraData

        +
        @Nullable
+byte[] getExtraData()
        +
        • +
      + + + +
        +
      • +

        setExtraData

        +
        void setExtraData(byte[] data)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/StoredLayoutProperty.html b/apidocs/com/amazon/carbonado/layout/StoredLayoutProperty.html new file mode 100644 index 0000000..404f05a --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/StoredLayoutProperty.html @@ -0,0 +1,543 @@ + + + + + + +StoredLayoutProperty (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.layout
+

Interface StoredLayoutProperty

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getLayoutID

        +
        long getLayoutID()
        +
        • +
      + + + +
        +
      • +

        setLayoutID

        +
        void setLayoutID(long typeID)
        +
        • +
      + + + +
        +
      • +

        getOrdinal

        +
        int getOrdinal()
        +
        Ordinal defines the order in which this property appears in it enclosing + layout.
        +
        • +
      + + + +
        +
      • +

        setOrdinal

        +
        void setOrdinal(int ordinal)
        +
        • +
      + + + +
        +
      • +

        getPropertyName

        +
        java.lang.String getPropertyName()
        +
        • +
      + + + +
        +
      • +

        setPropertyName

        +
        void setPropertyName(java.lang.String name)
        +
        • +
      + + + +
        +
      • +

        getPropertyTypeDescriptor

        +
        java.lang.String getPropertyTypeDescriptor()
        +
        Property type descriptor is a Java type descriptor.
        +
        • +
      + + + +
        +
      • +

        setPropertyTypeDescriptor

        +
        void setPropertyTypeDescriptor(java.lang.String type)
        +
        • +
      + + + +
        +
      • +

        isNullable

        +
        boolean isNullable()
        +
        Returns true of property value can be set to null.
        +
        • +
      + + + +
        +
      • +

        setNullable

        +
        void setNullable(boolean nullable)
        +
        • +
      + + + +
        +
      • +

        isPrimaryKeyMember

        +
        boolean isPrimaryKeyMember()
        +
        Returns true if property is a member of the primary key.
        +
        • +
      + + + +
        +
      • +

        setPrimaryKeyMember

        +
        void setPrimaryKeyMember(boolean pk)
        +
        • +
      + + + +
        +
      • +

        isVersion

        +
        boolean isVersion()
        +
        Returns true if this property is the designated version number for the + Storable.
        +
        • +
      + + + +
        +
      • +

        setVersion

        +
        void setVersion(boolean version)
        +
        • +
      + + + +
        +
      • +

        getAdapterTypeName

        +
        @Nullable
+java.lang.String getAdapterTypeName()
        +
        Adapter type name is a fully qualified Java class name. If property has + no adapter, then null is returned.
        +
        • +
      + + + +
        +
      • +

        setAdapterTypeName

        +
        void setAdapterTypeName(java.lang.String name)
        +
        • +
      + + + +
        +
      • +

        getAdapterParams

        +
        @Nullable
+java.lang.String getAdapterParams()
        +
        Parameters for adapter, or null if property has no explicit adapter.
        +
        • +
      + + + +
        +
      • +

        setAdapterParams

        +
        void setAdapterParams(java.lang.String params)
        +
        • +
      + + + +
        +
      • +

        getVersionNumber

        +
        @Version
+int getVersionNumber()
        +
        Record version number for this StoredPropertyLayout instance. Some + encoding strategies require a version number.
        +
        • +
      + + + +
        +
      • +

        setVersionNumber

        +
        void setVersionNumber(int version)
        +
        • +
      + + + +
        +
      • +

        getExtraData

        +
        @Nullable
+byte[] getExtraData()
        +
        Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records. This record cannot evolve + because an evolution strategy likely depends on this interface remaining + stable, avoiding a cyclic dependency.
        +
        • +
      + + + +
        +
      • +

        setExtraData

        +
        void setExtraData(byte[] data)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/Unevolvable.html b/apidocs/com/amazon/carbonado/layout/Unevolvable.html new file mode 100644 index 0000000..f09728d --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/Unevolvable.html @@ -0,0 +1,171 @@ + + + + + + +Unevolvable (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.layout
+

Interface Unevolvable

+
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + 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) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.layout.Layout

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

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

+ + 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) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.layout.LayoutCapability

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

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

+ + 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) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.layout.LayoutFactory

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

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

+ + 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) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.layout.LayoutOptions

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

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

+ + 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) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.layout.LayoutProperty

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

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

+ + 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) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.layout.LayoutSync

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

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

+ + 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) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.layout.StoredLayout

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

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

+ + 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) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.layout.StoredLayoutEquivalence

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

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

+ + 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) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.layout.StoredLayoutProperty

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

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

+ + 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) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.layout.Unevolvable

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/package-frame.html b/apidocs/com/amazon/carbonado/layout/package-frame.html new file mode 100644 index 0000000..58eea25 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +com.amazon.carbonado.layout (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.layout

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/layout/package-summary.html b/apidocs/com/amazon/carbonado/layout/package-summary.html new file mode 100644 index 0000000..c5bca9a --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/package-summary.html @@ -0,0 +1,230 @@ + + + + + + +com.amazon.carbonado.layout (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.layout

+
+
Support for recording the evolution of a storable's layout, used internally + by some repositories.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.layout Description

+
Support for recording the evolution of a storable's layout, used internally + by some repositories. This allows storable's to evolve. Enough information + is recorded in the layout such + that an older generation can be reconstructed, allowing it to be decoded + from persistent storage. + +

A storable generation is different than a storable version. The version increases with each + update of an instance, whereas the generation increases when the + storable type definition changes. The version number is stored with each + instance, and the generation is stored via the classes in this package. + +

Whenever a property is added or removed from a storable, the storable + layout is assigned a new generation value. If the storable layout reverts to + a previous generation's layout, no new generation value is created. Instead, + the generation value of the current storable will match the previous + generation.

+
See Also:
LayoutFactory
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/package-tree.html b/apidocs/com/amazon/carbonado/layout/package-tree.html new file mode 100644 index 0000000..3255207 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/package-tree.html @@ -0,0 +1,156 @@ + + + + + + +com.amazon.carbonado.layout Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.layout

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/package-use.html b/apidocs/com/amazon/carbonado/layout/package-use.html new file mode 100644 index 0000000..a42c9f0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/package-use.html @@ -0,0 +1,252 @@ + + + + + + +Uses of Package com.amazon.carbonado.layout (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.layout

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/AbstractBlob.html b/apidocs/com/amazon/carbonado/lob/AbstractBlob.html new file mode 100644 index 0000000..0764636 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/AbstractBlob.html @@ -0,0 +1,523 @@ + + + + + + +AbstractBlob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.lob
+

Class AbstractBlob

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Blob, Lob
    +
    +
    +
    Direct Known Subclasses:
    +
    ByteArrayBlob, FileBlob
    +
    +
    +
    +
    public abstract class AbstractBlob
+extends java.lang.Object
+implements Blob
    +
    AbstractBlob implements a small set of common Blob methods.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected AbstractBlob() 
      protected AbstractBlob(Repository repo) +
      Use of this constructor indicates that setValue should operate within a + transaction.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringasString() +
      Convenience method to capture all the Blob data as a single String, + assuming UTF-8 encoding.
      +
      java.lang.StringasString(java.nio.charset.Charset charset) +
      Convenience method to capture all the Blob data as a single String, + decoded against the given charset.
      +
      java.lang.StringasString(java.lang.String charsetName) +
      Convenience method to capture all the Blob data as a single String, + decoded against the given charset.
      +
      booleanequals(java.lang.Object obj) +
      Two Lobs are considered equal if the object instances are the same or if + they point to the same content.
      +
      inthashCode() 
      voidsetValue(java.lang.String value) +
      Convenience method to overwrite all Blob data with the value of a single + String, applying UTF-8 encoding.
      +
      voidsetValue(java.lang.String value, + java.nio.charset.Charset charset) +
      Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding.
      +
      voidsetValue(java.lang.String value, + java.lang.String charsetName) +
      Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      + + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AbstractBlob

        +
        protected AbstractBlob()
        +
        • +
      + + + +
        +
      • +

        AbstractBlob

        +
        protected AbstractBlob(Repository repo)
        +
        Use of this constructor indicates that setValue should operate within a + transaction. A Repository is passed in for entering the transaction.
        +
        Parameters:
        repo - optional repository to use for performing string conversion + within transactions
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        asString

        +
        public java.lang.String asString()
+                          throws FetchException
        +
        Description copied from interface: Blob
        +
        Convenience method to capture all the Blob data as a single String, + assuming UTF-8 encoding. Call within a transaction scope to ensure the + data does not change while the String is being built.
        +
        +
        Specified by:
        +
        asString in interface Blob
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        asString

        +
        public java.lang.String asString(java.lang.String charsetName)
+                          throws FetchException
        +
        Description copied from interface: Blob
        +
        Convenience method to capture all the Blob data as a single String, + decoded against the given charset. Call within a transaction scope to + ensure the data does not change while the String is being built.
        +
        +
        Specified by:
        +
        asString in interface Blob
        +
        Parameters:
        charsetName - name of character set to decode String
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        asString

        +
        public java.lang.String asString(java.nio.charset.Charset charset)
+                          throws FetchException
        +
        Description copied from interface: Blob
        +
        Convenience method to capture all the Blob data as a single String, + decoded against the given charset. Call within a transaction scope to + ensure the data does not change while the String is being built.
        +
        +
        Specified by:
        +
        asString in interface Blob
        +
        Parameters:
        charset - character set to decode String
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        public void setValue(java.lang.String value)
+              throws PersistException
        +
        Description copied from interface: Blob
        +
        Convenience method to overwrite all Blob data with the value of a single + String, applying UTF-8 encoding. The Blob length may grow or shrink, to + match the encoded String value. Call within a transaction scope to + ensure the data and length does not change while the value is set.
        +
        +
        Specified by:
        +
        setValue in interface Blob
        +
        Parameters:
        value - Blob is overwritten with this value
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        public void setValue(java.lang.String value,
+            java.lang.String charsetName)
+              throws PersistException
        +
        Description copied from interface: Blob
        +
        Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding. The Blob length may grow or + shrink, to match the encoded String value. Call within a transaction + scope to ensure the data and length does not change while the value is + set.
        +
        +
        Specified by:
        +
        setValue in interface Blob
        +
        Parameters:
        value - Blob is overwritten with this value
        charsetName - name of character set to encode String
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        public void setValue(java.lang.String value,
+            java.nio.charset.Charset charset)
+              throws PersistException
        +
        Description copied from interface: Blob
        +
        Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding. The Blob length may grow or + shrink, to match the encoded String value. Call within a transaction + scope to ensure the data and length does not change while the value is + set.
        +
        +
        Specified by:
        +
        setValue in interface Blob
        +
        Parameters:
        value - Blob is overwritten with this value
        charset - character set to encode String
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        Description copied from interface: Lob
        +
        Two Lobs are considered equal if the object instances are the same or if + they point to the same content. Lob data is not compared, as that would + be expensive or it may result in a fetch exception.
        +
        +
        Specified by:
        +
        equals in interface Lob
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/AbstractClob.html b/apidocs/com/amazon/carbonado/lob/AbstractClob.html new file mode 100644 index 0000000..75110e3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/AbstractClob.html @@ -0,0 +1,406 @@ + + + + + + +AbstractClob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.lob
+

Class AbstractClob

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Clob, Lob
    +
    +
    +
    Direct Known Subclasses:
    +
    BlobClob, CharArrayClob, StringClob
    +
    +
    +
    +
    public abstract class AbstractClob
+extends java.lang.Object
+implements Clob
    +
    AbstractClob implements a small set of common Clob methods.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected AbstractClob() 
      protected AbstractClob(Repository repo) +
      Use of this constructor indicates that setValue should operate within a + transaction.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringasString() +
      Convenience method to capture all the Clob data as a single String.
      +
      booleanequals(java.lang.Object obj) +
      Two Lobs are considered equal if the object instances are the same or if + they point to the same content.
      +
      inthashCode() 
      voidsetValue(java.lang.String value) +
      Convenience method to overwrite all Clob data with the value of a single + String.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      + + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AbstractClob

        +
        protected AbstractClob()
        +
        • +
      + + + +
        +
      • +

        AbstractClob

        +
        protected AbstractClob(Repository repo)
        +
        Use of this constructor indicates that setValue should operate within a + transaction. A Repository is passed in for entering the transaction.
        +
        Parameters:
        repo - optional repository to use for performing string conversion + within transactions
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        asString

        +
        public java.lang.String asString()
+                          throws FetchException
        +
        Description copied from interface: Clob
        +
        Convenience method to capture all the Clob data as a single String. Call + within a transaction scope to ensure the data does not change while the + String is being built.
        +
        +
        Specified by:
        +
        asString in interface Clob
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        public void setValue(java.lang.String value)
+              throws PersistException
        +
        Description copied from interface: Clob
        +
        Convenience method to overwrite all Clob data with the value of a single + String. The Clob length may grow or shrink, to match the String + value. Call within a transaction scope to ensure the data and length + does not change while the value is set.
        +
        +
        Specified by:
        +
        setValue in interface Clob
        +
        Parameters:
        value - Clob is overwritten with this value
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        Description copied from interface: Lob
        +
        Two Lobs are considered equal if the object instances are the same or if + they point to the same content. Lob data is not compared, as that would + be expensive or it may result in a fetch exception.
        +
        +
        Specified by:
        +
        equals in interface Lob
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/Blob.html b/apidocs/com/amazon/carbonado/lob/Blob.html new file mode 100644 index 0000000..40d1dc6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/Blob.html @@ -0,0 +1,564 @@ + + + + + + +Blob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.lob
+

Interface Blob

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Lob
    +
    +
    +
    All Known Implementing Classes:
    +
    AbstractBlob, ByteArrayBlob, FileBlob
    +
    +
    +
    +
    public interface Blob
+extends Lob
    +
    Provides access to BLOBs, which are Binary Large OBjects. Consider accessing + Blobs within a transaction scope, + to prevent unexpected updates.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Clob
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringasString() +
      Convenience method to capture all the Blob data as a single String, + assuming UTF-8 encoding.
      +
      java.lang.StringasString(java.nio.charset.Charset charset) +
      Convenience method to capture all the Blob data as a single String, + decoded against the given charset.
      +
      java.lang.StringasString(java.lang.String charsetName) +
      Convenience method to capture all the Blob data as a single String, + decoded against the given charset.
      +
      longgetLength() +
      Returns the length of this Blob, in bytes.
      +
      java.io.InputStreamopenInputStream() +
      Returns an InputStream for reading Blob data positioned at the + start.
      +
      java.io.InputStreamopenInputStream(long pos) +
      Returns an InputStream for reading Blob data.
      +
      java.io.InputStreamopenInputStream(long pos, + int bufferSize) +
      Returns an InputStream for reading Blob data.
      +
      java.io.OutputStreamopenOutputStream() +
      Returns an OutputStream for writing Blob data, positioned at the + start.
      +
      java.io.OutputStreamopenOutputStream(long pos) +
      Returns an OutputStream for writing Blob data.
      +
      java.io.OutputStreamopenOutputStream(long pos, + int bufferSize) +
      Returns an OutputStream for writing Blob data.
      +
      voidsetLength(long length) +
      Set the length of this Blob, in bytes.
      +
      voidsetValue(java.lang.String value) +
      Convenience method to overwrite all Blob data with the value of a single + String, applying UTF-8 encoding.
      +
      voidsetValue(java.lang.String value, + java.nio.charset.Charset charset) +
      Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding.
      +
      voidsetValue(java.lang.String value, + java.lang.String charsetName) +
      Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding.
      +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        openInputStream

        +
        java.io.InputStream openInputStream()
+                                    throws FetchException
        +
        Returns an InputStream for reading Blob data positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.
        +
        Returns:
        InputStream for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if position is negative
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        openInputStream

        +
        java.io.InputStream openInputStream(long pos)
+                                    throws FetchException
        +
        Returns an InputStream for reading Blob data. The Blob implementation + selects an appropriate buffer size for the stream.
        +
        Parameters:
        pos - desired zero-based position to read from
        +
        Returns:
        InputStream for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if position is negative
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        openInputStream

        +
        java.io.InputStream openInputStream(long pos,
+                                  int bufferSize)
+                                    throws FetchException
        +
        Returns an InputStream for reading Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob implementation.
        +
        Parameters:
        pos - desired zero-based position to read from
        bufferSize - suggest that the input stream buffer be at least this large (in bytes)
        +
        Returns:
        InputStream for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if position is negative
        +
        FetchException
        +
        • +
      + + + + + + + +
        +
      • +

        asString

        +
        java.lang.String asString()
+                          throws FetchException
        +
        Convenience method to capture all the Blob data as a single String, + assuming UTF-8 encoding. Call within a transaction scope to ensure the + data does not change while the String is being built.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if resulting String length would be + greater than Integer.MAX_VALUE
        +
        java.lang.OutOfMemoryError - if not enough memory to hold Blob as a single String
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        asString

        +
        java.lang.String asString(java.lang.String charsetName)
+                          throws FetchException
        +
        Convenience method to capture all the Blob data as a single String, + decoded against the given charset. Call within a transaction scope to + ensure the data does not change while the String is being built.
        +
        Parameters:
        charsetName - name of character set to decode String
        +
        Throws:
        +
        java.nio.charset.IllegalCharsetNameException - if the given charset name is illegal
        +
        java.lang.IllegalArgumentException - if resulting String length would be + greater than Integer.MAX_VALUE
        +
        java.lang.OutOfMemoryError - if not enough memory to hold Blob as a single String
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        asString

        +
        java.lang.String asString(java.nio.charset.Charset charset)
+                          throws FetchException
        +
        Convenience method to capture all the Blob data as a single String, + decoded against the given charset. Call within a transaction scope to + ensure the data does not change while the String is being built.
        +
        Parameters:
        charset - character set to decode String
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if resulting String length would be + greater than Integer.MAX_VALUE
        +
        java.lang.OutOfMemoryError - if not enough memory to hold Blob as a single String
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        openOutputStream

        +
        java.io.OutputStream openOutputStream()
+                                      throws PersistException
        +
        Returns an OutputStream for writing Blob data, positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.
        +
        Returns:
        OutputStream for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if position is negative
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        openOutputStream

        +
        java.io.OutputStream openOutputStream(long pos)
+                                      throws PersistException
        +
        Returns an OutputStream for writing Blob data. The Blob implementation + selects an appropriate buffer size for the stream.
        +
        Parameters:
        pos - desired zero-based position to write to
        +
        Returns:
        OutputStream for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if position is negative
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        openOutputStream

        +
        java.io.OutputStream openOutputStream(long pos,
+                                    int bufferSize)
+                                      throws PersistException
        +
        Returns an OutputStream for writing Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob implementation.
        +
        Parameters:
        pos - desired zero-based position to write to
        bufferSize - suggest that the output stream buffer be at least this large (in bytes)
        +
        Returns:
        OutputStream for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if position is negative
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        setLength

        +
        void setLength(long length)
+               throws PersistException
        +
        Set the length of this Blob, in bytes. If the new length is shorter, the + Blob is truncated. If the new length is longer, the Blob is padded with + zeros.
        +
        Parameters:
        length - new length to set to
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if length is negative
        +
        PersistDeniedException - if Blob is read-only
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        void setValue(java.lang.String value)
+              throws PersistException
        +
        Convenience method to overwrite all Blob data with the value of a single + String, applying UTF-8 encoding. The Blob length may grow or shrink, to + match the encoded String value. Call within a transaction scope to + ensure the data and length does not change while the value is set.
        +
        Parameters:
        value - Blob is overwritten with this value
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if value is null
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        void setValue(java.lang.String value,
+            java.lang.String charsetName)
+              throws PersistException
        +
        Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding. The Blob length may grow or + shrink, to match the encoded String value. Call within a transaction + scope to ensure the data and length does not change while the value is + set.
        +
        Parameters:
        value - Blob is overwritten with this value
        charsetName - name of character set to encode String
        +
        Throws:
        +
        java.nio.charset.IllegalCharsetNameException - if the given charset name is illegal
        +
        java.lang.IllegalArgumentException - if value is null
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        void setValue(java.lang.String value,
+            java.nio.charset.Charset charset)
+              throws PersistException
        +
        Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding. The Blob length may grow or + shrink, to match the encoded String value. Call within a transaction + scope to ensure the data and length does not change while the value is + set.
        +
        Parameters:
        value - Blob is overwritten with this value
        charset - character set to encode String
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if value is null
        +
        PersistException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/BlobClob.html b/apidocs/com/amazon/carbonado/lob/BlobClob.html new file mode 100644 index 0000000..2b0adc3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/BlobClob.html @@ -0,0 +1,482 @@ + + + + + + +BlobClob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.lob
+

Class BlobClob

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Clob, Lob
    +
    +
    +
    +
    public class BlobClob
+extends AbstractClob
    +
    A Clob implementation which is backed by a Blob. Data is stored in the Blob + using UTF-16BE encoding.
    +
    Author:
    +
    Brian S O'Neill, Bob Loblaw
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      BlobClob(Blob blob) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      longgetLength() +
      Returns the length of this Clob, in characters.
      +
      java.lang.ObjectgetLocator() +
      Returns an object which identifies the Lob data, which may be null if + not supported.
      +
      protected BlobgetWrappedBlob() 
      java.io.ReaderopenReader() +
      Returns a Reader for reading Clob data, positioned at the start.
      +
      java.io.ReaderopenReader(long pos) +
      Returns a Reader for reading Clob data.
      +
      java.io.ReaderopenReader(long pos, + int bufferSize) +
      Returns a Reader for reading Clob data.
      +
      java.io.WriteropenWriter() +
      Returns a Writer for writing Clob data, positioned at the start.
      +
      java.io.WriteropenWriter(long pos) +
      Returns a Writer for writing Clob data.
      +
      java.io.WriteropenWriter(long pos, + int bufferSize) +
      Returns a Writer for writing Clob data.
      +
      voidsetLength(long length) +
      Set the length of this Clob, in characters.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BlobClob

        +
        public BlobClob(Blob blob)
        +
        Parameters:
        blob - blob to wrap
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        openReader

        +
        public java.io.Reader openReader()
+                          throws FetchException
        +
        Description copied from interface: Clob
        +
        Returns a Reader for reading Clob data, positioned at the start. The + Clob implementation selects an appropriate buffer size for the reader.
        +
        Returns:
        Reader for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        openReader

        +
        public java.io.Reader openReader(long pos)
+                          throws FetchException
        +
        Description copied from interface: Clob
        +
        Returns a Reader for reading Clob data. The Clob implementation selects + an appropriate buffer size for the reader.
        +
        Parameters:
        pos - desired zero-based position to read from
        +
        Returns:
        Reader for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        openReader

        +
        public java.io.Reader openReader(long pos,
+                        int bufferSize)
+                          throws FetchException
        +
        Description copied from interface: Clob
        +
        Returns a Reader for reading Clob data. A suggested buffer size must be + provided, but it might be ignored by the Clob implementation.
        +
        Parameters:
        pos - desired zero-based position to read from
        bufferSize - suggest that the reader buffer be at least this large (in characters)
        +
        Returns:
        Reader for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        getLength

        +
        public long getLength()
+               throws FetchException
        +
        Description copied from interface: Clob
        +
        Returns the length of this Clob, in characters.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        openWriter

        +
        public java.io.Writer openWriter()
+                          throws PersistException
        +
        Description copied from interface: Clob
        +
        Returns a Writer for writing Clob data, positioned at the start. The + Clob implementation selects an appropriate buffer size for the writer.
        +
        Returns:
        Writer for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        openWriter

        +
        public java.io.Writer openWriter(long pos)
+                          throws PersistException
        +
        Description copied from interface: Clob
        +
        Returns a Writer for writing Clob data. The Clob implementation selects + an appropriate buffer size for the writer.
        +
        Parameters:
        pos - desired zero-based position to write to
        +
        Returns:
        Writer for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        openWriter

        +
        public java.io.Writer openWriter(long pos,
+                        int bufferSize)
+                          throws PersistException
        +
        Description copied from interface: Clob
        +
        Returns a Writer for writing Clob data. A suggested buffer size must be + provided, but it might be ignored by the Clob implementation.
        +
        Parameters:
        pos - desired zero-based position to write to
        bufferSize - suggest that the writer buffer be at least this large (in characters)
        +
        Returns:
        Writer for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        setLength

        +
        public void setLength(long length)
+               throws PersistException
        +
        Description copied from interface: Clob
        +
        Set the length of this Clob, in characters. If the new length is + shorter, the Clob is truncated. If the new length is longer, the Clob is + padded with '\0' characters.
        +
        Parameters:
        length - new length to set to
        +
        Throws:
        +
        PersistDeniedException - if Clob is read-only
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        getLocator

        +
        public java.lang.Object getLocator()
        +
        Description copied from interface: Lob
        +
        Returns an object which identifies the Lob data, which may be null if + not supported.
        +
        • +
      + + + +
        +
      • +

        getWrappedBlob

        +
        protected Blob getWrappedBlob()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/ByteArrayBlob.html b/apidocs/com/amazon/carbonado/lob/ByteArrayBlob.html new file mode 100644 index 0000000..0a3f8be --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/ByteArrayBlob.html @@ -0,0 +1,487 @@ + + + + + + +ByteArrayBlob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.lob
+

Class ByteArrayBlob

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Blob, Lob
    +
    +
    +
    +
    public class ByteArrayBlob
+extends AbstractBlob
    +
    Implementation of a Blob which is backed by a growable in-memory byte array.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      ByteArrayBlob(byte[] data) +
      Construct a ByteArrayBlob initially backed by the given byte array.
      +
      ByteArrayBlob(byte[] data, + int length) +
      Construct a ByteArrayBlob initially backed by the given byte array.
      +
      ByteArrayBlob(int capacity) +
      Construct a ByteArrayBlob with the given initial capacity.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      longgetLength() +
      Returns the length of this Blob, in bytes.
      +
      java.lang.ObjectgetLocator() +
      Always returns null.
      +
      java.io.InputStreamopenInputStream() +
      Returns an InputStream for reading Blob data positioned at the + start.
      +
      java.io.InputStreamopenInputStream(long pos) +
      Returns an InputStream for reading Blob data.
      +
      java.io.InputStreamopenInputStream(long pos, + int bufferSize) +
      Returns an InputStream for reading Blob data.
      +
      java.io.OutputStreamopenOutputStream() +
      Returns an OutputStream for writing Blob data, positioned at the + start.
      +
      java.io.OutputStreamopenOutputStream(long pos) +
      Returns an OutputStream for writing Blob data.
      +
      java.io.OutputStreamopenOutputStream(long pos, + int bufferSize) +
      Returns an OutputStream for writing Blob data.
      +
      voidsetLength(long length) +
      Set the length of this Blob, in bytes.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ByteArrayBlob

        +
        public ByteArrayBlob(int capacity)
        +
        Construct a ByteArrayBlob with the given initial capacity.
        +
        Parameters:
        capacity - initial capacity of internal byte array
        +
        • +
      + + + +
        +
      • +

        ByteArrayBlob

        +
        public ByteArrayBlob(byte[] data)
        +
        Construct a ByteArrayBlob initially backed by the given byte array. The + byte array is not cloned until this ByteArrayBlob grows or shrinks.
        +
        Parameters:
        data - initial data backing the Blob
        +
        • +
      + + + +
        +
      • +

        ByteArrayBlob

        +
        public ByteArrayBlob(byte[] data,
+             int length)
        +
        Construct a ByteArrayBlob initially backed by the given byte array. The + byte array is not cloned until this ByteArrayBlob grows or shrinks.
        +
        Parameters:
        data - initial data backing the Blob
        length - initial length of data
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        openInputStream

        +
        public java.io.InputStream openInputStream()
        +
        Description copied from interface: Blob
        +
        Returns an InputStream for reading Blob data positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.
        +
        Returns:
        InputStream for this Blob, which is not guaranteed to be thread-safe
        +
        • +
      + + + +
        +
      • +

        openInputStream

        +
        public java.io.InputStream openInputStream(long pos)
        +
        Description copied from interface: Blob
        +
        Returns an InputStream for reading Blob data. The Blob implementation + selects an appropriate buffer size for the stream.
        +
        Parameters:
        pos - desired zero-based position to read from
        +
        Returns:
        InputStream for this Blob, which is not guaranteed to be thread-safe
        +
        • +
      + + + +
        +
      • +

        openInputStream

        +
        public java.io.InputStream openInputStream(long pos,
+                                  int bufferSize)
        +
        Description copied from interface: Blob
        +
        Returns an InputStream for reading Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob implementation.
        +
        Parameters:
        pos - desired zero-based position to read from
        bufferSize - suggest that the input stream buffer be at least this large (in bytes)
        +
        Returns:
        InputStream for this Blob, which is not guaranteed to be thread-safe
        +
        • +
      + + + +
        +
      • +

        getLength

        +
        public long getLength()
        +
        Description copied from interface: Blob
        +
        Returns the length of this Blob, in bytes.
        +
        • +
      + + + +
        +
      • +

        openOutputStream

        +
        public java.io.OutputStream openOutputStream()
        +
        Description copied from interface: Blob
        +
        Returns an OutputStream for writing Blob data, positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.
        +
        Returns:
        OutputStream for this Blob, which is not guaranteed to be thread-safe
        +
        • +
      + + + +
        +
      • +

        openOutputStream

        +
        public java.io.OutputStream openOutputStream(long pos)
        +
        Description copied from interface: Blob
        +
        Returns an OutputStream for writing Blob data. The Blob implementation + selects an appropriate buffer size for the stream.
        +
        Parameters:
        pos - desired zero-based position to write to
        +
        Returns:
        OutputStream for this Blob, which is not guaranteed to be thread-safe
        +
        • +
      + + + +
        +
      • +

        openOutputStream

        +
        public java.io.OutputStream openOutputStream(long pos,
+                                    int bufferSize)
        +
        Description copied from interface: Blob
        +
        Returns an OutputStream for writing Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob implementation.
        +
        Parameters:
        pos - desired zero-based position to write to
        bufferSize - suggest that the output stream buffer be at least this large (in bytes)
        +
        Returns:
        OutputStream for this Blob, which is not guaranteed to be thread-safe
        +
        • +
      + + + +
        +
      • +

        setLength

        +
        public void setLength(long length)
+               throws PersistException
        +
        Description copied from interface: Blob
        +
        Set the length of this Blob, in bytes. If the new length is shorter, the + Blob is truncated. If the new length is longer, the Blob is padded with + zeros.
        +
        Parameters:
        length - new length to set to
        +
        Throws:
        +
        PersistDeniedException - if Blob is read-only
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        getLocator

        +
        public java.lang.Object getLocator()
        +
        Always returns null.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/CharArrayClob.html b/apidocs/com/amazon/carbonado/lob/CharArrayClob.html new file mode 100644 index 0000000..7e24d4a --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/CharArrayClob.html @@ -0,0 +1,509 @@ + + + + + + +CharArrayClob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.lob
+

Class CharArrayClob

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Clob, Lob
    +
    +
    +
    +
    public class CharArrayClob
+extends AbstractClob
    +
    Implementation of a Clob which is backed by a growable in-memory character + array.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      CharArrayClob(char[] data) +
      Construct a CharArrayClob initially backed by the given character array.
      +
      CharArrayClob(char[] data, + int length) +
      Construct a CharArrayClob initially backed by the given character array.
      +
      CharArrayClob(int capacity) +
      Construct a CharArrayClob with the given initial capacity.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringasString() +
      Convenience method to capture all the Clob data as a single String.
      +
      longgetLength() +
      Returns the length of this Clob, in characters.
      +
      java.lang.ObjectgetLocator() +
      Always returns null.
      +
      java.io.ReaderopenReader() +
      Returns a Reader for reading Clob data, positioned at the start.
      +
      java.io.ReaderopenReader(long pos) +
      Returns a Reader for reading Clob data.
      +
      java.io.ReaderopenReader(long pos, + int bufferSize) +
      Returns a Reader for reading Clob data.
      +
      java.io.WriteropenWriter() +
      Returns a Writer for writing Clob data, positioned at the start.
      +
      java.io.WriteropenWriter(long pos) +
      Returns a Writer for writing Clob data.
      +
      java.io.WriteropenWriter(long pos, + int bufferSize) +
      Returns a Writer for writing Clob data.
      +
      voidsetLength(long length) +
      Set the length of this Clob, in characters.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CharArrayClob

        +
        public CharArrayClob(int capacity)
        +
        Construct a CharArrayClob with the given initial capacity.
        +
        Parameters:
        capacity - initial capacity of internal character array
        +
        • +
      + + + +
        +
      • +

        CharArrayClob

        +
        public CharArrayClob(char[] data)
        +
        Construct a CharArrayClob initially backed by the given character array. The + character array is not cloned until this CharArrayClob grows or shrinks.
        +
        Parameters:
        data - initial data backing the Clob
        +
        • +
      + + + +
        +
      • +

        CharArrayClob

        +
        public CharArrayClob(char[] data,
+             int length)
        +
        Construct a CharArrayClob initially backed by the given character array. The + character array is not cloned until this CharArrayClob grows or shrinks.
        +
        Parameters:
        data - initial data backing the Clob
        length - initial length of data
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        openReader

        +
        public java.io.Reader openReader()
        +
        Description copied from interface: Clob
        +
        Returns a Reader for reading Clob data, positioned at the start. The + Clob implementation selects an appropriate buffer size for the reader.
        +
        Returns:
        Reader for this Blob, which is not guaranteed to be thread-safe
        +
        • +
      + + + +
        +
      • +

        openReader

        +
        public java.io.Reader openReader(long pos)
        +
        Description copied from interface: Clob
        +
        Returns a Reader for reading Clob data. The Clob implementation selects + an appropriate buffer size for the reader.
        +
        Parameters:
        pos - desired zero-based position to read from
        +
        Returns:
        Reader for this Blob, which is not guaranteed to be thread-safe
        +
        • +
      + + + +
        +
      • +

        openReader

        +
        public java.io.Reader openReader(long pos,
+                        int bufferSize)
        +
        Description copied from interface: Clob
        +
        Returns a Reader for reading Clob data. A suggested buffer size must be + provided, but it might be ignored by the Clob implementation.
        +
        Parameters:
        pos - desired zero-based position to read from
        bufferSize - suggest that the reader buffer be at least this large (in characters)
        +
        Returns:
        Reader for this Blob, which is not guaranteed to be thread-safe
        +
        • +
      + + + +
        +
      • +

        getLength

        +
        public long getLength()
        +
        Description copied from interface: Clob
        +
        Returns the length of this Clob, in characters.
        +
        • +
      + + + +
        +
      • +

        asString

        +
        public java.lang.String asString()
        +
        Description copied from interface: Clob
        +
        Convenience method to capture all the Clob data as a single String. Call + within a transaction scope to ensure the data does not change while the + String is being built.
        +
        +
        Specified by:
        +
        asString in interface Clob
        +
        Overrides:
        +
        asString in class AbstractClob
        +
        +
        • +
      + + + +
        +
      • +

        openWriter

        +
        public java.io.Writer openWriter()
        +
        Description copied from interface: Clob
        +
        Returns a Writer for writing Clob data, positioned at the start. The + Clob implementation selects an appropriate buffer size for the writer.
        +
        Returns:
        Writer for this Blob, which is not guaranteed to be thread-safe
        +
        • +
      + + + +
        +
      • +

        openWriter

        +
        public java.io.Writer openWriter(long pos)
        +
        Description copied from interface: Clob
        +
        Returns a Writer for writing Clob data. The Clob implementation selects + an appropriate buffer size for the writer.
        +
        Parameters:
        pos - desired zero-based position to write to
        +
        Returns:
        Writer for this Blob, which is not guaranteed to be thread-safe
        +
        • +
      + + + +
        +
      • +

        openWriter

        +
        public java.io.Writer openWriter(long pos,
+                        int bufferSize)
        +
        Description copied from interface: Clob
        +
        Returns a Writer for writing Clob data. A suggested buffer size must be + provided, but it might be ignored by the Clob implementation.
        +
        Parameters:
        pos - desired zero-based position to write to
        bufferSize - suggest that the writer buffer be at least this large (in characters)
        +
        Returns:
        Writer for this Blob, which is not guaranteed to be thread-safe
        +
        • +
      + + + +
        +
      • +

        setLength

        +
        public void setLength(long length)
+               throws PersistException
        +
        Description copied from interface: Clob
        +
        Set the length of this Clob, in characters. If the new length is + shorter, the Clob is truncated. If the new length is longer, the Clob is + padded with '\0' characters.
        +
        Parameters:
        length - new length to set to
        +
        Throws:
        +
        PersistDeniedException - if Clob is read-only
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        getLocator

        +
        public java.lang.Object getLocator()
        +
        Always returns null.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/Clob.html b/apidocs/com/amazon/carbonado/lob/Clob.html new file mode 100644 index 0000000..f2e49a0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/Clob.html @@ -0,0 +1,447 @@ + + + + + + +Clob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.lob
+

Interface Clob

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Lob
    +
    +
    +
    All Known Implementing Classes:
    +
    AbstractClob, BlobClob, CharArrayClob, StringClob
    +
    +
    +
    +
    public interface Clob
+extends Lob
    +
    Provides access to CLOBs, which are Character Large OBjects. Consider + accessing Clobs within a transaction scope, to prevent unexpected updates.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Blob
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringasString() +
      Convenience method to capture all the Clob data as a single String.
      +
      longgetLength() +
      Returns the length of this Clob, in characters.
      +
      java.io.ReaderopenReader() +
      Returns a Reader for reading Clob data, positioned at the start.
      +
      java.io.ReaderopenReader(long pos) +
      Returns a Reader for reading Clob data.
      +
      java.io.ReaderopenReader(long pos, + int bufferSize) +
      Returns a Reader for reading Clob data.
      +
      java.io.WriteropenWriter() +
      Returns a Writer for writing Clob data, positioned at the start.
      +
      java.io.WriteropenWriter(long pos) +
      Returns a Writer for writing Clob data.
      +
      java.io.WriteropenWriter(long pos, + int bufferSize) +
      Returns a Writer for writing Clob data.
      +
      voidsetLength(long length) +
      Set the length of this Clob, in characters.
      +
      voidsetValue(java.lang.String value) +
      Convenience method to overwrite all Clob data with the value of a single + String.
      +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        openReader

        +
        java.io.Reader openReader()
+                          throws FetchException
        +
        Returns a Reader for reading Clob data, positioned at the start. The + Clob implementation selects an appropriate buffer size for the reader.
        +
        Returns:
        Reader for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if position is negative
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        openReader

        +
        java.io.Reader openReader(long pos)
+                          throws FetchException
        +
        Returns a Reader for reading Clob data. The Clob implementation selects + an appropriate buffer size for the reader.
        +
        Parameters:
        pos - desired zero-based position to read from
        +
        Returns:
        Reader for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if position is negative
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        openReader

        +
        java.io.Reader openReader(long pos,
+                        int bufferSize)
+                          throws FetchException
        +
        Returns a Reader for reading Clob data. A suggested buffer size must be + provided, but it might be ignored by the Clob implementation.
        +
        Parameters:
        pos - desired zero-based position to read from
        bufferSize - suggest that the reader buffer be at least this large (in characters)
        +
        Returns:
        Reader for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if position is negative
        +
        FetchException
        +
        • +
      + + + + + + + +
        +
      • +

        asString

        +
        java.lang.String asString()
+                          throws FetchException
        +
        Convenience method to capture all the Clob data as a single String. Call + within a transaction scope to ensure the data does not change while the + String is being built.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if Clob length is greater than Integer.MAX_VALUE
        +
        java.lang.OutOfMemoryError - if not enough memory to hold Clob as a single String
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        openWriter

        +
        java.io.Writer openWriter()
+                          throws PersistException
        +
        Returns a Writer for writing Clob data, positioned at the start. The + Clob implementation selects an appropriate buffer size for the writer.
        +
        Returns:
        Writer for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if position is negative
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        openWriter

        +
        java.io.Writer openWriter(long pos)
+                          throws PersistException
        +
        Returns a Writer for writing Clob data. The Clob implementation selects + an appropriate buffer size for the writer.
        +
        Parameters:
        pos - desired zero-based position to write to
        +
        Returns:
        Writer for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if position is negative
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        openWriter

        +
        java.io.Writer openWriter(long pos,
+                        int bufferSize)
+                          throws PersistException
        +
        Returns a Writer for writing Clob data. A suggested buffer size must be + provided, but it might be ignored by the Clob implementation.
        +
        Parameters:
        pos - desired zero-based position to write to
        bufferSize - suggest that the writer buffer be at least this large (in characters)
        +
        Returns:
        Writer for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if position is negative
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        setLength

        +
        void setLength(long length)
+               throws PersistException
        +
        Set the length of this Clob, in characters. If the new length is + shorter, the Clob is truncated. If the new length is longer, the Clob is + padded with '\0' characters.
        +
        Parameters:
        length - new length to set to
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if length is negative
        +
        PersistDeniedException - if Clob is read-only
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        void setValue(java.lang.String value)
+              throws PersistException
        +
        Convenience method to overwrite all Clob data with the value of a single + String. The Clob length may grow or shrink, to match the String + value. Call within a transaction scope to ensure the data and length + does not change while the value is set.
        +
        Parameters:
        value - Clob is overwritten with this value
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if value is null
        +
        PersistException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/FileBlob.html b/apidocs/com/amazon/carbonado/lob/FileBlob.html new file mode 100644 index 0000000..4f41f03 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/FileBlob.html @@ -0,0 +1,468 @@ + + + + + + +FileBlob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.lob
+

Class FileBlob

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Blob, Lob
    +
    +
    +
    +
    public class FileBlob
+extends AbstractBlob
    +
    Implementation of a Blob which is backed by a File.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      FileBlob(java.io.File file) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      longgetLength() +
      Returns the length of this Blob, in bytes.
      +
      java.lang.ObjectgetLocator() +
      Always returns null.
      +
      java.io.InputStreamopenInputStream() +
      Returns an InputStream for reading Blob data positioned at the + start.
      +
      java.io.InputStreamopenInputStream(long pos) +
      Returns an InputStream for reading Blob data.
      +
      java.io.InputStreamopenInputStream(long pos, + int bufferSize) +
      Returns an InputStream for reading Blob data.
      +
      java.io.OutputStreamopenOutputStream() +
      Returns an OutputStream for writing Blob data, positioned at the + start.
      +
      java.io.OutputStreamopenOutputStream(long pos) +
      Returns an OutputStream for writing Blob data.
      +
      java.io.OutputStreamopenOutputStream(long pos, + int bufferSize) +
      Returns an OutputStream for writing Blob data.
      +
      voidsetLength(long length) +
      Set the length of this Blob, in bytes.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FileBlob

        +
        public FileBlob(java.io.File file)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        openInputStream

        +
        public java.io.InputStream openInputStream()
+                                    throws FetchException
        +
        Description copied from interface: Blob
        +
        Returns an InputStream for reading Blob data positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.
        +
        Returns:
        InputStream for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        openInputStream

        +
        public java.io.InputStream openInputStream(long pos)
+                                    throws FetchException
        +
        Description copied from interface: Blob
        +
        Returns an InputStream for reading Blob data. The Blob implementation + selects an appropriate buffer size for the stream.
        +
        Parameters:
        pos - desired zero-based position to read from
        +
        Returns:
        InputStream for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        openInputStream

        +
        public java.io.InputStream openInputStream(long pos,
+                                  int bufferSize)
+                                    throws FetchException
        +
        Description copied from interface: Blob
        +
        Returns an InputStream for reading Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob implementation.
        +
        Parameters:
        pos - desired zero-based position to read from
        bufferSize - suggest that the input stream buffer be at least this large (in bytes)
        +
        Returns:
        InputStream for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        getLength

        +
        public long getLength()
+               throws FetchException
        +
        Description copied from interface: Blob
        +
        Returns the length of this Blob, in bytes.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        openOutputStream

        +
        public java.io.OutputStream openOutputStream()
+                                      throws PersistException
        +
        Description copied from interface: Blob
        +
        Returns an OutputStream for writing Blob data, positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.
        +
        Returns:
        OutputStream for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        openOutputStream

        +
        public java.io.OutputStream openOutputStream(long pos)
+                                      throws PersistException
        +
        Description copied from interface: Blob
        +
        Returns an OutputStream for writing Blob data. The Blob implementation + selects an appropriate buffer size for the stream.
        +
        Parameters:
        pos - desired zero-based position to write to
        +
        Returns:
        OutputStream for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        openOutputStream

        +
        public java.io.OutputStream openOutputStream(long pos,
+                                    int bufferSize)
+                                      throws PersistException
        +
        Description copied from interface: Blob
        +
        Returns an OutputStream for writing Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob implementation.
        +
        Parameters:
        pos - desired zero-based position to write to
        bufferSize - suggest that the output stream buffer be at least this large (in bytes)
        +
        Returns:
        OutputStream for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        setLength

        +
        public void setLength(long length)
+               throws PersistException
        +
        Description copied from interface: Blob
        +
        Set the length of this Blob, in bytes. If the new length is shorter, the + Blob is truncated. If the new length is longer, the Blob is padded with + zeros.
        +
        Parameters:
        length - new length to set to
        +
        Throws:
        +
        PersistDeniedException - if Blob is read-only
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        getLocator

        +
        public java.lang.Object getLocator()
        +
        Always returns null.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/Lob.html b/apidocs/com/amazon/carbonado/lob/Lob.html new file mode 100644 index 0000000..69e3d8e --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/Lob.html @@ -0,0 +1,249 @@ + + + + + + +Lob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.lob
+

Interface Lob

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object obj) +
      Two Lobs are considered equal if the object instances are the same or if + they point to the same content.
      +
      java.lang.ObjectgetLocator() +
      Returns an object which identifies the Lob data, which may be null if + not supported.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getLocator

        +
        java.lang.Object getLocator()
        +
        Returns an object which identifies the Lob data, which may be null if + not supported.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        equals

        +
        boolean equals(java.lang.Object obj)
        +
        Two Lobs are considered equal if the object instances are the same or if + they point to the same content. Lob data is not compared, as that would + be expensive or it may result in a fetch exception.
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/StringClob.html b/apidocs/com/amazon/carbonado/lob/StringClob.html new file mode 100644 index 0000000..6a2a54e --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/StringClob.html @@ -0,0 +1,516 @@ + + + + + + +StringClob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.lob
+

Class StringClob

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Clob, Lob
    +
    +
    +
    +
    public class StringClob
+extends AbstractClob
    +
    Implementation of a Clob which is backed by a read-only String.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      StringClob(java.lang.String str) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringasString() +
      Convenience method to capture all the Clob data as a single String.
      +
      longgetLength() +
      Returns the length of this Clob, in characters.
      +
      java.lang.ObjectgetLocator() +
      Always returns null.
      +
      java.io.ReaderopenReader() +
      Returns a Reader for reading Clob data, positioned at the start.
      +
      java.io.ReaderopenReader(long pos) +
      Returns a Reader for reading Clob data.
      +
      java.io.ReaderopenReader(long pos, + int bufferSize) +
      Returns a Reader for reading Clob data.
      +
      java.io.WriteropenWriter() +
      Returns a Writer for writing Clob data, positioned at the start.
      +
      java.io.WriteropenWriter(long pos) +
      Returns a Writer for writing Clob data.
      +
      java.io.WriteropenWriter(long pos, + int bufferSize) +
      Returns a Writer for writing Clob data.
      +
      voidsetLength(long length) +
      Set the length of this Clob, in characters.
      +
      voidsetValue(java.lang.String value) +
      Convenience method to overwrite all Clob data with the value of a single + String.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StringClob

        +
        public StringClob(java.lang.String str)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        openReader

        +
        public java.io.Reader openReader()
        +
        Description copied from interface: Clob
        +
        Returns a Reader for reading Clob data, positioned at the start. The + Clob implementation selects an appropriate buffer size for the reader.
        +
        Returns:
        Reader for this Blob, which is not guaranteed to be thread-safe
        +
        • +
      + + + +
        +
      • +

        openReader

        +
        public java.io.Reader openReader(long pos)
+                          throws FetchException
        +
        Description copied from interface: Clob
        +
        Returns a Reader for reading Clob data. The Clob implementation selects + an appropriate buffer size for the reader.
        +
        Parameters:
        pos - desired zero-based position to read from
        +
        Returns:
        Reader for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        openReader

        +
        public java.io.Reader openReader(long pos,
+                        int bufferSize)
+                          throws FetchException
        +
        Description copied from interface: Clob
        +
        Returns a Reader for reading Clob data. A suggested buffer size must be + provided, but it might be ignored by the Clob implementation.
        +
        Parameters:
        pos - desired zero-based position to read from
        bufferSize - suggest that the reader buffer be at least this large (in characters)
        +
        Returns:
        Reader for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        getLength

        +
        public long getLength()
+               throws FetchException
        +
        Description copied from interface: Clob
        +
        Returns the length of this Clob, in characters.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        asString

        +
        public java.lang.String asString()
        +
        Description copied from interface: Clob
        +
        Convenience method to capture all the Clob data as a single String. Call + within a transaction scope to ensure the data does not change while the + String is being built.
        +
        +
        Specified by:
        +
        asString in interface Clob
        +
        Overrides:
        +
        asString in class AbstractClob
        +
        +
        • +
      + + + +
        +
      • +

        openWriter

        +
        public java.io.Writer openWriter()
+                          throws PersistException
        +
        Description copied from interface: Clob
        +
        Returns a Writer for writing Clob data, positioned at the start. The + Clob implementation selects an appropriate buffer size for the writer.
        +
        Returns:
        Writer for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        openWriter

        +
        public java.io.Writer openWriter(long pos)
+                          throws PersistException
        +
        Description copied from interface: Clob
        +
        Returns a Writer for writing Clob data. The Clob implementation selects + an appropriate buffer size for the writer.
        +
        Parameters:
        pos - desired zero-based position to write to
        +
        Returns:
        Writer for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        openWriter

        +
        public java.io.Writer openWriter(long pos,
+                        int bufferSize)
+                          throws PersistException
        +
        Description copied from interface: Clob
        +
        Returns a Writer for writing Clob data. A suggested buffer size must be + provided, but it might be ignored by the Clob implementation.
        +
        Parameters:
        pos - desired zero-based position to write to
        bufferSize - suggest that the writer buffer be at least this large (in characters)
        +
        Returns:
        Writer for this Blob, which is not guaranteed to be thread-safe
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        setLength

        +
        public void setLength(long length)
+               throws PersistException
        +
        Description copied from interface: Clob
        +
        Set the length of this Clob, in characters. If the new length is + shorter, the Clob is truncated. If the new length is longer, the Clob is + padded with '\0' characters.
        +
        Parameters:
        length - new length to set to
        +
        Throws:
        +
        PersistDeniedException - if Clob is read-only
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        public void setValue(java.lang.String value)
+              throws PersistException
        +
        Description copied from interface: Clob
        +
        Convenience method to overwrite all Clob data with the value of a single + String. The Clob length may grow or shrink, to match the String + value. Call within a transaction scope to ensure the data and length + does not change while the value is set.
        +
        +
        Specified by:
        +
        setValue in interface Clob
        +
        Overrides:
        +
        setValue in class AbstractClob
        +
        Parameters:
        value - Clob is overwritten with this value
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        getLocator

        +
        public java.lang.Object getLocator()
        +
        Always returns null.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.lob.AbstractBlob

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/class-use/AbstractClob.html b/apidocs/com/amazon/carbonado/lob/class-use/AbstractClob.html new file mode 100644 index 0000000..9764bbe --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/AbstractClob.html @@ -0,0 +1,174 @@ + + + + + + +Uses of Class com.amazon.carbonado.lob.AbstractClob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.lob.AbstractClob

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/class-use/Blob.html b/apidocs/com/amazon/carbonado/lob/class-use/Blob.html new file mode 100644 index 0000000..9419f63 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/Blob.html @@ -0,0 +1,379 @@ + + + + + + +Uses of Interface com.amazon.carbonado.lob.Blob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.lob.Blob

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

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

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

Uses of Class
com.amazon.carbonado.lob.BlobClob

+
+
No usage of com.amazon.carbonado.lob.BlobClob
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.lob.ByteArrayBlob

+
+
No usage of com.amazon.carbonado.lob.ByteArrayBlob
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.lob.CharArrayClob

+
+
No usage of com.amazon.carbonado.lob.CharArrayClob
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/class-use/Clob.html b/apidocs/com/amazon/carbonado/lob/class-use/Clob.html new file mode 100644 index 0000000..04b5b7f --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/Clob.html @@ -0,0 +1,362 @@ + + + + + + +Uses of Interface com.amazon.carbonado.lob.Clob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.lob.Clob

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

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

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

Uses of Class
com.amazon.carbonado.lob.FileBlob

+
+
No usage of com.amazon.carbonado.lob.FileBlob
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Interface
com.amazon.carbonado.lob.Lob

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

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

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

Uses of Class
com.amazon.carbonado.lob.StringClob

+
+
No usage of com.amazon.carbonado.lob.StringClob
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/package-frame.html b/apidocs/com/amazon/carbonado/lob/package-frame.html new file mode 100644 index 0000000..5cd4200 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +com.amazon.carbonado.lob (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.lob

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/lob/package-summary.html b/apidocs/com/amazon/carbonado/lob/package-summary.html new file mode 100644 index 0000000..93d2196 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/package-summary.html @@ -0,0 +1,234 @@ + + + + + + +com.amazon.carbonado.lob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.lob

+
+
Support for LOB property types, which are Large OBjects.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.lob Description

+
Support for LOB property types, which are Large OBjects. Properties declared + as Blob or Clob are treated differently than regular + properties. In particular: + +
    +
  • Repository typically stores LOB data external from enclosing storable +
  • LOBs are accessed in a manner similar to how files are accessed +
  • LOB data is often read/written in chunks, so consider accessing in a transaction scope +
  • LOBs cannot be annotated with PrimaryKey, Key, Index, Join, + Version, or Sequence +
  • LOBs cannot be used in a query filter +
+ +

Also, setting a LOB property does not dirty that property unless the new + LOB is unequal. Updating a LOB property typically involves operating on the + LOB itself. Setting the LOB property again is useful only when completely + replacing the data, which can be a relatively expensive operation. + +

Some repositories require that large text data be stored as a LOB. If the + text property is intended to fit entirely in memory, consider defining the + property as a String instead of a LOB. This allows the repository to decide + if it is appropriate to store it as a LOB. If explicit control over charset + encoding is required, add a TextAdapter annotation.

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/package-tree.html b/apidocs/com/amazon/carbonado/lob/package-tree.html new file mode 100644 index 0000000..8300746 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/package-tree.html @@ -0,0 +1,151 @@ + + + + + + +com.amazon.carbonado.lob Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.lob

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/lob/package-use.html b/apidocs/com/amazon/carbonado/lob/package-use.html new file mode 100644 index 0000000..20b3ebe --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/package-use.html @@ -0,0 +1,293 @@ + + + + + + +Uses of Package com.amazon.carbonado.lob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.lob

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/package-frame.html b/apidocs/com/amazon/carbonado/package-frame.html new file mode 100644 index 0000000..8056839 --- /dev/null +++ b/apidocs/com/amazon/carbonado/package-frame.html @@ -0,0 +1,86 @@ + + + + + + +com.amazon.carbonado (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +

Exceptions

+ +

Annotation Types

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/package-summary.html b/apidocs/com/amazon/carbonado/package-summary.html new file mode 100644 index 0000000..e220503 --- /dev/null +++ b/apidocs/com/amazon/carbonado/package-summary.html @@ -0,0 +1,545 @@ + + + + + + +com.amazon.carbonado (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado

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

See: Description

+
+
+ + + + +

Package com.amazon.carbonado Description

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/package-tree.html b/apidocs/com/amazon/carbonado/package-tree.html new file mode 100644 index 0000000..f69ce0e --- /dev/null +++ b/apidocs/com/amazon/carbonado/package-tree.html @@ -0,0 +1,248 @@ + + + + + + +com.amazon.carbonado Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Annotation Type Hierarchy

+ +

Enum Hierarchy

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/package-use.html b/apidocs/com/amazon/carbonado/package-use.html new file mode 100644 index 0000000..8eb42e4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/package-use.html @@ -0,0 +1,1352 @@ + + + + + + +Uses of Package com.amazon.carbonado (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/AbstractQuery.html b/apidocs/com/amazon/carbonado/qe/AbstractQuery.html new file mode 100644 index 0000000..a290d49 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/AbstractQuery.html @@ -0,0 +1,767 @@ + + + + + + +AbstractQuery (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class AbstractQuery<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Query<S>, Appender
    +
    +
    +
    Direct Known Subclasses:
    +
    EmptyQuery, StandardQuery
    +
    +
    +
    +
    public abstract class AbstractQuery<S extends Storable>
+extends java.lang.Object
+implements Query<S>, Appender
    +
    AbstractQuery implements a small set of common Query methods. Subclasses + should consider overriding some of these methods, if it provides better + performance.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AbstractQuery

        +
        protected AbstractQuery()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        and

        +
        public Query<S> and(java.lang.String filter)
+                              throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a new query which has another filter logically "and"ed to this, potentially reducing the amount of + results.
        +
        +
        Specified by:
        +
        and in interface Query<S extends Storable>
        +
        Parameters:
        filter - query filter expression
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        or

        +
        public Query<S> or(java.lang.String filter)
+                             throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a new query which has another filter logically "or"ed to this, potentially increasing the amount of + results.
        +
        +
        Specified by:
        +
        or in interface Query<S extends Storable>
        +
        Parameters:
        filter - query filter expression
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + + + +
        +
      • +

        fetchAfter

        +
        public <T extends S> Cursor<S> fetchAfter(T start)
+                                      throws FetchException
        +
        Description copied from interface: Query
        +
        Fetches results for this query after a given starting point, which is + useful for re-opening a cursor. This is only effective when query has + been given an explicit ordering. If not a total + ordering, then cursor may start at an earlier position. + +

        Note: This method can be very expensive to call repeatedly, if the + query needs to perform a sort operation. Ideally, the query ordering + should match the natural ordering of an index or key. + +

        Calling fetchAfter(s) is equivalent to calling after(s).fetch().

        +
        +
        Specified by:
        +
        fetchAfter in interface Query<S extends Storable>
        +
        Parameters:
        start - storable to attempt to start after; if null, fetch all results
        +
        Returns:
        fetch results
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        See Also:
        Repository.enterTransaction(IsolationLevel), +Query.after(T)
        +
        • +
      + + + + + +
        +
      • +

        fetchAfter

        +
        public <T extends S> Cursor<S> fetchAfter(T start,
+                                 Query.Controller controller)
+                                      throws FetchException
        +
        Description copied from interface: Query
        +
        Fetches results for this query after a given starting point, which is + useful for re-opening a cursor. This is only effective when query has + been given an explicit ordering. If not a total + ordering, then cursor may start at an earlier position. + +

        Note: This method can be very expensive to call repeatedly, if the + query needs to perform a sort operation. Ideally, the query ordering + should match the natural ordering of an index or key. + +

        Calling fetchAfter(s) is equivalent to calling after(s).fetch().

        +
        +
        Specified by:
        +
        fetchAfter in interface Query<S extends Storable>
        +
        Parameters:
        start - storable to attempt to start after; if null, fetch all results
        controller - optional controller which can abort query operation
        +
        Returns:
        fetch results
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        See Also:
        Repository.enterTransaction(IsolationLevel), +Query.after(T)
        +
        • +
      + + + +
        +
      • +

        loadOne

        +
        public S loadOne()
+                           throws FetchException
        +
        Description copied from interface: Query
        +
        Attempts to load exactly one matching object. If the number of matching + records is zero or exceeds one, then an exception is thrown instead.
        +
        +
        Specified by:
        +
        loadOne in interface Query<S extends Storable>
        +
        Returns:
        a single fetched object
        +
        Throws:
        +
        FetchNoneException - if no matching record found
        +
        FetchMultipleException - if more than one matching record found
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        loadOne

        +
        public S loadOne(Query.Controller controller)
+                           throws FetchException
        +
        Description copied from interface: Query
        +
        Attempts to load exactly one matching object. If the number of matching + records is zero or exceeds one, then an exception is thrown instead.
        +
        +
        Specified by:
        +
        loadOne in interface Query<S extends Storable>
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        a single fetched object
        +
        Throws:
        +
        FetchNoneException - if no matching record found
        +
        FetchMultipleException - if more than one matching record found
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        tryLoadOne

        +
        public S tryLoadOne()
+                              throws FetchException
        +
        Description copied from interface: Query
        +
        Tries to load one record, but returns null if nothing was found. Throws + exception if record count is more than one.
        +
        +
        Specified by:
        +
        tryLoadOne in interface Query<S extends Storable>
        +
        Returns:
        null or a single fetched object
        +
        Throws:
        +
        FetchMultipleException - if more than one matching record found
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        tryLoadOne

        +
        public S tryLoadOne(Query.Controller controller)
+                              throws FetchException
        +
        Description copied from interface: Query
        +
        Tries to load one record, but returns null if nothing was found. Throws + exception if record count is more than one.
        +
        +
        Specified by:
        +
        tryLoadOne in interface Query<S extends Storable>
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        null or a single fetched object
        +
        Throws:
        +
        FetchMultipleException - if more than one matching record found
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + + + + + +
        +
      • +

        deleteOne

        +
        public void deleteOne(Query.Controller controller)
+               throws PersistException
        +
        Description copied from interface: Query
        +
        Deletes one matching object. If the number of matching records is zero or + exceeds one, then no delete occurs, and an exception is thrown instead.
        +
        +
        Specified by:
        +
        deleteOne in interface Query<S extends Storable>
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Throws:
        +
        PersistNoneException - if no matching record found
        +
        PersistMultipleException - if more than one record matches
        +
        PersistException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        printNative

        +
        public boolean printNative()
        +
        Description copied from interface: Query
        +
        Print the native query to standard out, which is useful for performance + analysis. Not all repositories have a native query format. An example + native format is SQL.
        +
        +
        Specified by:
        +
        printNative in interface Query<S extends Storable>
        +
        Returns:
        false if not implemented
        +
        • +
      + + + +
        +
      • +

        printNative

        +
        public boolean printNative(java.lang.Appendable app)
+                    throws java.io.IOException
        +
        Description copied from interface: Query
        +
        Prints the native query to any appendable, which is useful for + performance analysis. Not all repositories have a native query + format. An example native format is SQL.
        +
        +
        Specified by:
        +
        printNative in interface Query<S extends Storable>
        +
        Parameters:
        app - append results here
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        printPlan

        +
        public boolean printPlan()
        +
        Description copied from interface: Query
        +
        Prints the query excecution plan to standard out, which is useful for + performance analysis. There is no standard format for query plans, nor + is it a requirement that this method be implemented.
        +
        +
        Specified by:
        +
        printPlan in interface Query<S extends Storable>
        +
        Returns:
        false if not implemented
        +
        • +
      + + + +
        +
      • +

        printPlan

        +
        public boolean printPlan(java.lang.Appendable app)
+                  throws java.io.IOException
        +
        Description copied from interface: Query
        +
        Prints the query excecution plan to any appendable, which is useful for + performance analysis. There is no standard format for query plans, nor + is it a requirement that this method be implemented.
        +
        +
        Specified by:
        +
        printPlan in interface Query<S extends Storable>
        +
        Parameters:
        app - append results here
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Implementation calls appendTo.
        +
        +
        Specified by:
        +
        toString in interface Query<S extends Storable>
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public abstract int hashCode()
        +
        +
        Specified by:
        +
        hashCode in interface Query<S extends Storable>
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public abstract boolean equals(java.lang.Object obj)
        +
        +
        Specified by:
        +
        equals in interface Query<S extends Storable>
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        checkSliceArguments

        +
        protected boolean checkSliceArguments(long from,
+                          java.lang.Long to)
        +
        Called by sliced fetch to ensure that arguments are valid.
        +
        Returns:
        false if from is 0 and to is null
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if arguments are invalid
        Since:
        +
        1.2
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/AbstractQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/AbstractQueryExecutor.html new file mode 100644 index 0000000..8da05d4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/AbstractQueryExecutor.html @@ -0,0 +1,479 @@ + + + + + + +AbstractQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class AbstractQueryExecutor<S extends Storable>

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      longcount(FilterValues<S> values) +
      Counts results by opening a cursor and skipping entries.
      +
      longcount(FilterValues<S> values, + Query.Controller controller) +
      Counts results by opening a cursor and skipping entries.
      +
      Cursor<S>fetchSlice(FilterValues<S> values, + long from, + java.lang.Long to) +
      Produces a slice via skip and limit cursors.
      +
      Cursor<S>fetchSlice(FilterValues<S> values, + long from, + java.lang.Long to, + Query.Controller controller) +
      Produces a slice via skip and limit cursors.
      +
      java.lang.Class<S>getStorableType() +
      Returns the storable type that this executor operates on.
      +
      protected intincreaseIndent(int indentLevel) +
      Adds a constant amount to the given indent level.
      +
      protected voidindent(java.lang.Appendable app, + int indentLevel) +
      Appends spaces to the given appendable.
      +
      protected voidnewline(java.lang.Appendable app) +
      Appends a newline character.
      +
      booleanprintNative(java.lang.Appendable app, + int indentLevel, + FilterValues<S> values) +
      Does nothing and returns false.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AbstractQueryExecutor

        +
        public AbstractQueryExecutor()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStorableType

        +
        public java.lang.Class<S> getStorableType()
        +
        Description copied from interface: QueryExecutor
        +
        Returns the storable type that this executor operates on.
        +
        +
        Specified by:
        +
        getStorableType in interface QueryExecutor<S extends Storable>
        +
        +
        • +
      + + + + + + + + + + + + + + + + + + + +
        +
      • +

        printNative

        +
        public boolean printNative(java.lang.Appendable app,
+                  int indentLevel,
+                  FilterValues<S> values)
+                    throws java.io.IOException
        +
        Does nothing and returns false.
        +
        +
        Specified by:
        +
        printNative in interface QueryExecutor<S extends Storable>
        +
        values - optional
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        indent

        +
        protected void indent(java.lang.Appendable app,
+          int indentLevel)
+               throws java.io.IOException
        +
        Appends spaces to the given appendable. Useful for implementing + printNative and printPlan.
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        newline

        +
        protected void newline(java.lang.Appendable app)
+                throws java.io.IOException
        +
        Appends a newline character.
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        increaseIndent

        +
        protected int increaseIndent(int indentLevel)
        +
        Adds a constant amount to the given indent level. Useful for + implementing printNative and printPlan.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/BoundaryType.html b/apidocs/com/amazon/carbonado/qe/BoundaryType.html new file mode 100644 index 0000000..e9fdeb2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/BoundaryType.html @@ -0,0 +1,347 @@ + + + + + + +BoundaryType (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Enum BoundaryType

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<BoundaryType>
    +
    +
    +
    +
    public enum BoundaryType
+extends java.lang.Enum<BoundaryType>
    +
    Describes a value range boundary.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      EXCLUSIVE +
      Range boundary is exclusive
      +
      INCLUSIVE +
      Range boundary is inclusive
      +
      OPEN +
      Range boundary is open
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static BoundaryTypevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static BoundaryType[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        OPEN

        +
        public static final BoundaryType OPEN
        +
        Range boundary is open
        +
        • +
      + + + +
        +
      • +

        INCLUSIVE

        +
        public static final BoundaryType INCLUSIVE
        +
        Range boundary is inclusive
        +
        • +
      + + + +
        +
      • +

        EXCLUSIVE

        +
        public static final BoundaryType EXCLUSIVE
        +
        Range boundary is exclusive
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static BoundaryType[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (BoundaryType c : BoundaryType.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in +the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static BoundaryType valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/CompositeScore.html b/apidocs/com/amazon/carbonado/qe/CompositeScore.html new file mode 100644 index 0000000..55e6ffc --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/CompositeScore.html @@ -0,0 +1,509 @@ + + + + + + +CompositeScore (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class CompositeScore<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public class CompositeScore<S extends Storable>
+extends java.lang.Object
    +
    Evaluates an index for how well it matches a query's desired filtering and + ordering. A composite score is not a single absolute value – instead it + has a relative weight when compared to other scores.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    FilteringScore, +OrderingScore
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        evaluate

        +
        public static <S extends Storable> CompositeScore<S> 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.
        +
        Parameters:
        index - index to evaluate
        filter - optional filter which cannot contain any logical 'or' operations.
        ordering - optional properties which define desired ordering
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if index is null or filter is not supported
        +
        • +
      + + + +
        +
      • +

        evaluate

        +
        public static <S extends Storable> CompositeScore<S> 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.
        +
        Parameters:
        indexProperties - index properties to evaluate
        unique - true if index is unique
        clustered - true if index is clustered
        filter - optional filter which cannot contain any logical 'or' operations.
        ordering - optional properties which define desired ordering
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if index is null or filter is not supported
        +
        • +
      + + + +
        +
      • +

        localForeignComparator

        +
        public static java.util.Comparator<CompositeScore<?>> localForeignComparator()
        +
        Returns a partial comparator suited for comparing local indexes to + foreign indexes. It determines which CompositeScores are better by + examining identity matches, range matches and ordering. It does not + matter if the scores were evaluated for different indexes or storable + types. The comparator returns <0 if first score is better, + 0 if equal, or >0 if second is better.
        +
        • +
      + + + +
        +
      • +

        localForeignComparator

        +
        public static java.util.Comparator<CompositeScore<?>> localForeignComparator(QueryHints hints)
        +
        Returns a partial comparator suited for comparing local indexes to + foreign indexes. It determines which CompositeScores are better by + examining identity matches, range matches and ordering. It does not + matter if the scores were evaluated for different indexes or storable + types. The comparator returns <0 if first score is better, + 0 if equal, or >0 if second is better.
        +
        Parameters:
        hints - optional hints
        +
        • +
      + + + +
        +
      • +

        fullComparator

        +
        public static java.util.Comparator<CompositeScore<?>> fullComparator()
        +
        Returns a comparator which determines which CompositeScores are + better. It compares identity matches, range matches, ordering, open + range matches, property arrangement and index cost estimate. It does not + matter if the scores were evaluated for different indexes or storable + types. The comparator returns <0 if first score is better, + 0 if equal, or >0 if second is better.
        +
        • +
      + + + +
        +
      • +

        fullComparator

        +
        public static java.util.Comparator<CompositeScore<?>> fullComparator(QueryHints hints)
        +
        Returns a comparator which determines which CompositeScores are + better. It compares identity matches, range matches, ordering, open + range matches, property arrangement and index cost estimate. It does not + matter if the scores were evaluated for different indexes or storable + types. The comparator returns <0 if first score is better, + 0 if equal, or >0 if second is better.
        +
        Parameters:
        hints - optional hints
        +
        • +
      + + + +
        +
      • +

        getFilteringScore

        +
        public FilteringScore<S> getFilteringScore()
        +
        Returns the score on how well the evaluated index performs the desired + filtering.
        +
        • +
      + + + +
        +
      • +

        getOrderingScore

        +
        public OrderingScore<S> getOrderingScore()
        +
        Returns the score on how well the evaluated index performs the desired + ordering.
        +
        • +
      + + + +
        +
      • +

        canMergeRemainder

        +
        public boolean canMergeRemainder(CompositeScore<S> other)
        +
        Returns true if the filtering score can merge its remainder filter and + the ordering score can merge its remainder orderings.
        +
        • +
      + + + +
        +
      • +

        mergeRemainderFilter

        +
        public Filter<S> mergeRemainderFilter(CompositeScore<S> other)
        +
        Merges the remainder filter of this score with the one given using an + 'or' operation. Call canMergeRemainder first to verify if the merge + makes any sense.
        +
        • +
      + + + +
        +
      • +

        mergeRemainderOrdering

        +
        public OrderingList<S> mergeRemainderOrdering(CompositeScore<S> other)
        +
        Merges the remainder orderings of this score with the one given. Call + canMergeRemainder first to verify if the merge makes any sense.
        +
        • +
      + + + +
        +
      • +

        withRemainderFilter

        +
        public CompositeScore<S> withRemainderFilter(Filter<S> filter)
        +
        Returns a new CompositeScore with the filtering remainder replaced and + covering matches recalculated. Other matches are not recalculated.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        withRemainderOrdering

        +
        public CompositeScore<S> withRemainderOrdering(OrderingList<S> ordering)
        +
        Returns a new CompositeScore with the ordering remainder + replaced. Handled count is not recalculated.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutor.html new file mode 100644 index 0000000..3805e4b --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutor.html @@ -0,0 +1,557 @@ + + + + + + +DelegatedQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class DelegatedQueryExecutor<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    QueryExecutor<S>
    +
    +
    +
    +
    public class DelegatedQueryExecutor<S extends Storable>
+extends java.lang.Object
+implements QueryExecutor<S>
    +
    QueryExecutor which delegates by executing a Query on a Storage.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html b/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html new file mode 100644 index 0000000..dad3e85 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html @@ -0,0 +1,298 @@ + + + + + + +DelegatedQueryExecutorFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class DelegatedQueryExecutorFactory<S extends Storable>

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      QueryExecutor<S>executor(Filter<S> filter, + OrderingList<S> ordering, + QueryHints hints) +
      Returns an executor that handles the given query specification.
      +
      java.lang.Class<S>getStorableType() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/EmptyQuery.html b/apidocs/com/amazon/carbonado/qe/EmptyQuery.html new file mode 100644 index 0000000..2a8af3d --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/EmptyQuery.html @@ -0,0 +1,1051 @@ + + + + + + +EmptyQuery (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class EmptyQuery<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Query<S>, Appender
    +
    +
    +
    +
    public final class EmptyQuery<S extends Storable>
+extends AbstractQuery<S>
    +
    Special query implementation that fetches nothing.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EmptyQuery

        +
        public EmptyQuery(QueryFactory<S> factory,
+          OrderingList<S> ordering)
        +
        Parameters:
        factory - required query factory, used by 'or' and 'not' methods
        ordering - optional order-by properties
        +
        • +
      + + + +
        +
      • +

        EmptyQuery

        +
        public EmptyQuery(QueryFactory<S> factory,
+          java.lang.String ordering)
        +
        Parameters:
        factory - required query factory, used by 'or' and 'not' methods
        ordering - optional order-by property
        +
        • +
      + + + +
        +
      • +

        EmptyQuery

        +
        public EmptyQuery(QueryFactory<S> factory,
+          java.lang.String... orderings)
        +
        Parameters:
        factory - required query factory, used by 'or' and 'not' methods
        orderings - optional order-by properties
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStorableType

        +
        public java.lang.Class<S> getStorableType()
        +
        Description copied from interface: Query
        +
        Returns the specific type of Storable managed by this object.
        +
        • +
      + + + + + + + +
        +
      • +

        getFilterValues

        +
        public FilterValues<S> getFilterValues()
        +
        Always returns null.
        +
        • +
      + + + +
        +
      • +

        getBlankParameterCount

        +
        public int getBlankParameterCount()
        +
        Always returns zero.
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(int value)
        +
        Always throws an IllegalStateException.
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(long value)
        +
        Always throws an IllegalStateException.
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(float value)
        +
        Always throws an IllegalStateException.
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(double value)
        +
        Always throws an IllegalStateException.
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(boolean value)
        +
        Always throws an IllegalStateException.
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(char value)
        +
        Always throws an IllegalStateException.
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(byte value)
        +
        Always throws an IllegalStateException.
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(short value)
        +
        Always throws an IllegalStateException.
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(java.lang.Object value)
        +
        Always throws an IllegalStateException.
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        withValues

        +
        public Query<S> withValues(java.lang.Object... values)
        +
        Throws an IllegalStateException unless no values passed in.
        +
        Parameters:
        values - parameter values to fill in; if null or empty, this + Query instance is returned
        +
        • +
      + + + +
        +
      • +

        and

        +
        public Query<S> and(Filter<S> filter)
        +
        Always throws an IllegalStateException.
        +
        Parameters:
        filter - query filter
        +
        • +
      + + + +
        +
      • +

        or

        +
        public Query<S> or(Filter<S> filter)
+                             throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a new query which has another filter logically "or"ed to this, potentially increasing the amount of + results.
        +
        Parameters:
        filter - query filter
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        not

        +
        public Query<S> not()
+                              throws FetchException
        +
        Returns a query that fetches everything, possibly in a specified order.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        orderBy

        +
        public Query<S> orderBy(java.lang.String property)
+                                  throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a copy of this query ordered by a specific property value. The + property name may be prefixed with '+' or '-' to indicate ascending or + descending order. If the prefix is omitted, ascending order is assumed. + +

        Note: Specification of ordering properties is not cumulative. Calling + this method will first remove any previous ordering properties.

        +
        Parameters:
        property - name of property to order by
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        orderBy

        +
        public Query<S> orderBy(java.lang.String... properties)
+                                  throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a copy of this query ordered by specific property values. The + property names may be prefixed with '+' or '-' to indicate ascending or + descending order. If the prefix is omitted, ascending order is assumed. + +

        Note: Specification of ordering properties is not cumulative. Calling + this method will first remove any previous ordering properties.

        +
        Parameters:
        properties - names of properties to order by
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + + + +
        +
      • +

        after

        +
        public <T extends S> Query<S> after(T start)
        +
        Description copied from interface: Query
        +
        Returns a query which fetches results for this query after a given + starting point, which is useful for re-opening a cursor. This is only + effective when query has been given an explicit ordering. If not a total ordering, then query may start at an earlier + position. + +

        Note: The returned query can be very expensive to fetch from + repeatedly, if the query needs to perform a sort operation. Ideally, the + query ordering should match the natural ordering of an index or key.

        +
        Parameters:
        start - storable to attempt to start after; if null, this query is + returned
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        fetchSlice

        +
        public Cursor<S> fetchSlice(long from,
+                   java.lang.Long to)
        +
        Always returns an EmptyCursor.
        +
        Parameters:
        from - zero-based from record number, inclusive
        to - optional zero-based to record number, exclusive
        +
        Returns:
        fetch results
        +
        • +
      + + + +
        +
      • +

        fetchSlice

        +
        public Cursor<S> fetchSlice(long from,
+                   java.lang.Long to,
+                   Query.Controller controller)
        +
        Always returns an EmptyCursor.
        +
        Parameters:
        from - zero-based from record number, inclusive
        to - optional zero-based to record number, exclusive
        controller - optional controller which can abort query operation
        +
        Returns:
        fetch results
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        tryDeleteOne

        +
        public boolean tryDeleteOne()
        +
        Always returns false.
        +
        Returns:
        true if record existed and was deleted, or false if no match
        +
        • +
      + + + +
        +
      • +

        tryDeleteOne

        +
        public boolean tryDeleteOne(Query.Controller controller)
        +
        Always returns false.
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        true if record existed and was deleted, or false if no match
        +
        • +
      + + + +
        +
      • +

        deleteAll

        +
        public void deleteAll()
        +
        Does nothing.
        +
        • +
      + + + +
        +
      • +

        deleteAll

        +
        public void deleteAll(Query.Controller controller)
        +
        Does nothing.
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        • +
      + + + +
        +
      • +

        count

        +
        public long count()
        +
        Always returns zero.
        +
        Returns:
        count of matches
        +
        • +
      + + + +
        +
      • +

        count

        +
        public long count(Query.Controller controller)
        +
        Always returns zero.
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        count of matches
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public boolean exists()
        +
        Always returns false.
        +
        Returns:
        true if any matches
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public boolean exists(Query.Controller controller)
        +
        Always returns false.
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        true if any matches
        +
        • +
      + + + +
        +
      • +

        appendTo

        +
        public void appendTo(java.lang.Appendable app)
+              throws java.io.IOException
        +
        Description copied from interface: Appender
        +
        Append the string representation of this object to the given Appendable.
        +
        Parameters:
        app - Appendable object to receive string representation
        +
        Throws:
        +
        java.io.IOException - if thrown from given Appendable
        +
        • +
      + + + +
        +
      • +

        printNative

        +
        public boolean printNative(java.lang.Appendable app,
+                  int indentLevel)
        +
        Always returns false.
        +
        Parameters:
        app - append results here
        indentLevel - amount to indent text, zero for none
        +
        Returns:
        false if not implemented
        +
        • +
      + + + +
        +
      • +

        printPlan

        +
        public boolean printPlan(java.lang.Appendable app,
+                int indentLevel)
        +
        Always returns false.
        +
        Parameters:
        app - append results here
        indentLevel - amount to indent text, zero for none
        +
        Returns:
        false if not implemented
        +
        • +
      + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/FilteredQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/FilteredQueryExecutor.html new file mode 100644 index 0000000..7153d87 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/FilteredQueryExecutor.html @@ -0,0 +1,404 @@ + + + + + + +FilteredQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class FilteredQueryExecutor<S extends Storable>

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FilteredQueryExecutor

        +
        public FilteredQueryExecutor(QueryExecutor<S> executor,
+                     Filter<S> filter)
        +
        Parameters:
        executor - executor to wrap
        filter - filter to apply to cursor
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any argument is null or filter is open or closed
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        getFilter

        +
        public Filter<S> getFilter()
        +
        Returns the combined filter of the wrapped executor and the extra filter.
        +
        Returns:
        query filter, never null
        +
        • +
      + + + +
        +
      • +

        getOrdering

        +
        public OrderingList<S> getOrdering()
        +
        Description copied from interface: QueryExecutor
        +
        Returns the result ordering of this QueryExecutor.
        +
        Returns:
        query ordering in an unmodifiable list
        +
        • +
      + + + +
        +
      • +

        printNative

        +
        public boolean printNative(java.lang.Appendable app,
+                  int indentLevel,
+                  FilterValues<S> values)
+                    throws java.io.IOException
        +
        Prints native query of the wrapped executor.
        +
        +
        Specified by:
        +
        printNative in interface QueryExecutor<S extends Storable>
        +
        Overrides:
        +
        printNative in class AbstractQueryExecutor<S extends Storable>
        +
        values - optional
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        printPlan

        +
        public boolean printPlan(java.lang.Appendable app,
+                int indentLevel,
+                FilterValues<S> values)
+                  throws java.io.IOException
        +
        Description copied from interface: QueryExecutor
        +
        Prints the query plan to any appendable, if applicable.
        +
        values - optional
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/FilteringScore.html b/apidocs/com/amazon/carbonado/qe/FilteringScore.html new file mode 100644 index 0000000..e646914 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/FilteringScore.html @@ -0,0 +1,932 @@ + + + + + + +FilteringScore (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class FilteringScore<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public class FilteringScore<S extends Storable>
+extends java.lang.Object
    +
    Evaluates an index for how well it matches a query's desired filtering. A + filtering score is not a single absolute value – instead it has a + relative weight when compared to other scores. + +

    An index matches a desired filtering if the arrangement of properties and + its relational operator matches. A matching = operator is + an identity match. A range match is determined by a matching operator of + >, >=, <, or <=. Filters with a != operator are + ignored. Although not all index properties need to be used, the first must + be and no gaps are allowed. + +

    A FilteringScore measures the number of filter properties that are + matched and the number that are remaining. If there are remainder + properties, then the user of the evaluated index will need to perform an + additional filtering operation to achieve the desired results. + +

    In general, a FilteringScore is better than another if it has more + matched properties and fewer remainder properties. Matching more identity + properties is given preference over matching range properties. Index + clustering is also considered for score comparison.

    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    OrderingScore, +CompositeScore
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleancanMergeRemainderFilter(FilteringScore<S> other) +
      Returns true if the given score uses an index exactly the same as this + one.
      +
      static <S extends Storable> 
      FilteringScore<S>      		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> 
      FilteringScore<S>      		evaluate(StorableIndex<S> index, + Filter<S> filter) +
      Evaluates the given index for its filtering capabilities against the + given filter.
      +
      static java.util.Comparator<FilteringScore<?>>fullComparator() +
      Returns a comparator which determines which FilteringScores are + better.
      +
      intgetArrangementScore() +
      Returns a value which indicates how well the index property order + matches the property filter specification order.
      +
      intgetCoveringCount() +
      Returns number of covering property filters which are supported by the + evaluated index.
      +
      Filter<S>getCoveringFilter() +
      Returns the composite covering filter supported by the evaluated index, + or null if the covering count is zero.
      +
      java.util.List<? extends Filter<S>>getCoveringFilters() +
      Returns the covering filters which are supported by the evaluated index, + which is a subset of the remainder filters.
      +
      Filter<S>getCoveringRemainderFilter() +
      Returns the composite remainder filter without including the covering + filter.
      +
      java.util.List<PropertyFilter<S>>getExclusiveRangeEndFilters() +
      Returns the range end property filters supported by the evaluated + index whose operator is only RelOp.LT.
      +
      java.util.List<PropertyFilter<S>>getExclusiveRangeStartFilters() +
      Returns the range start property filters supported by the evaluated + index whose operator is only RelOp.GT.
      +
      intgetHandledCount() +
      Returns the count of all handled property filters.
      +
      Filter<S>getHandledFilter() +
      Returns the composite handled filter, or null if no matches at all.
      +
      intgetIdentityCount() +
      Returns number of consecutive left-aligned index properties which match + property filters with an operator of RelOp.EQ.
      +
      Filter<S>getIdentityFilter() +
      Returns the composite identity filter, or null if no identity property + filters.
      +
      java.util.List<PropertyFilter<S>>getIdentityFilters() +
      Returns the identity property filters supported by the evaluated + index.
      +
      java.util.List<PropertyFilter<S>>getInclusiveRangeEndFilters() +
      Returns the range end property filters supported by the evaluated + index whose operator is only RelOp.LE.
      +
      java.util.List<PropertyFilter<S>>getInclusiveRangeStartFilters() +
      Returns the range start property filters supported by the evaluated + index whose operator is only RelOp.GE.
      +
      intgetIndexPropertyCount() +
      Returns the amount of properties in the evaluated index.
      +
      java.lang.ComparablegetPreferenceScore() +
      Returns a value which indicates user index preference, based on the + original ordering of elements in the filter.
      +
      java.util.List<PropertyFilter<S>>getRangeEndFilters() +
      Returns the range end property filters supported by the evaluated + index.
      +
      java.util.List<PropertyFilter<S>>getRangeStartFilters() +
      Returns the range start property filters supported by the evaluated + index.
      +
      intgetRemainderCount() +
      Returns number of property filters not supported by the evaluated index.
      +
      Filter<S>getRemainderFilter() +
      Returns the composite remainder filter not supported by the evaluated + index, or null if no remainder.
      +
      java.util.List<? extends Filter<S>>getRemainderFilters() +
      Returns the filters not supported by the evaluated index.
      +
      booleanhasAnyMatches() +
      Returns true if the identity count is greater than zero or if there is a + range match.
      +
      booleanhasRangeEnd() +
      Returns true if any property filter with an operator of RelOp.LT + or RelOp.LE matches an index property.
      +
      booleanhasRangeMatch() +
      Returns true if there is both a range start and range end.
      +
      booleanhasRangeStart() +
      Returns true if any property filter with an operator of RelOp.GT + or RelOp.GE matches an index property.
      +
      booleanisIndexClustered() +
      Returns true if evaluated index is clustered.
      +
      booleanisIndexUnique() +
      Returns true if evaluated index is unique.
      +
      booleanisKeyMatch() +
      Returns true if evaluated index is unique and each of its properties has + an identity match.
      +
      Filter<S>mergeRemainderFilter(FilteringScore<S> other) +
      Merges the remainder filter of this score with the one given using an + 'or' operation.
      +
      static java.util.Comparator<FilteringScore<?>>rangeComparator() +
      Returns a partial comparator which determines which FilteringScores are + better by examining only identity and range matches.
      +
      booleanshouldReverseRange() +
      Returns true if there is a range start or end match, but natural order + of matching property is descending.
      +
      java.lang.StringtoString() 
      FilteringScore<S>withRemainderFilter(Filter<S> filter) +
      Returns a new FilteringScore with the remainder replaced and covering + matches recalculated.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        evaluate

        +
        public static <S extends Storable> FilteringScore<S> evaluate(StorableIndex<S> index,
+                                              Filter<S> filter)
        +
        Evaluates the given index for its filtering capabilities against the + given filter.
        +
        Parameters:
        index - index to evaluate
        filter - filter which cannot contain any logical 'or' operations.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if index is null or filter is not supported
        +
        • +
      + + + +
        +
      • +

        evaluate

        +
        public static <S extends Storable> FilteringScore<S> evaluate(OrderedProperty<S>[] indexProperties,
+                                              boolean unique,
+                                              boolean clustered,
+                                              Filter<S> filter)
        +
        Evaluates the given index properties for its filtering capabilities + against the given filter.
        +
        Parameters:
        indexProperties - index properties to evaluate
        unique - true if index is unique
        clustered - true if index is clustered
        filter - filter which cannot contain any logical 'or' operations.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if index is null or filter is not supported
        +
        • +
      + + + +
        +
      • +

        rangeComparator

        +
        public static java.util.Comparator<FilteringScore<?>> rangeComparator()
        +
        Returns a partial comparator which determines which FilteringScores are + better by examining only identity and range matches. It does not matter + if the scores were evaluated for different indexes or storable + types. The comparator returns <0 if first score is better, + 0 if equal, or >0 if second is better.
        +
        • +
      + + + +
        +
      • +

        fullComparator

        +
        public static java.util.Comparator<FilteringScore<?>> fullComparator()
        +
        Returns a comparator which determines which FilteringScores are + better. It compares identity matches, range matches, open range matches + and property arrangement. It does not matter if the scores were + evaluated for different indexes or storable types. The comparator + returns <0 if first score is better, 0 if equal, or + >0 if second is better.
        +
        • +
      + + + +
        +
      • +

        isIndexClustered

        +
        public boolean isIndexClustered()
        +
        Returns true if evaluated index is clustered. Scans of clustered indexes + are generally faster.
        +
        • +
      + + + +
        +
      • +

        isIndexUnique

        +
        public boolean isIndexUnique()
        +
        Returns true if evaluated index is unique.
        +
        • +
      + + + +
        +
      • +

        getIndexPropertyCount

        +
        public int getIndexPropertyCount()
        +
        Returns the amount of properties in the evaluated index.
        +
        • +
      + + + +
        +
      • +

        getIdentityCount

        +
        public int getIdentityCount()
        +
        Returns number of consecutive left-aligned index properties which match + property filters with an operator of RelOp.EQ.
        +
        • +
      + + + +
        +
      • +

        getIdentityFilters

        +
        public java.util.List<PropertyFilter<S>> getIdentityFilters()
        +
        Returns the identity property filters supported by the evaluated + index. The order of the list matches the order in which the properties + appear in the index. The operator of each filter is RelOp.EQ.
        +
        • +
      + + + +
        +
      • +

        getIdentityFilter

        +
        public Filter<S> getIdentityFilter()
        +
        Returns the composite identity filter, or null if no identity property + filters.
        +
        • +
      + + + +
        +
      • +

        hasRangeStart

        +
        public boolean hasRangeStart()
        +
        Returns true if any property filter with an operator of RelOp.GT + or RelOp.GE matches an index property. The index property used + for the range is the first one following the identity count.
        +
        • +
      + + + +
        +
      • +

        getRangeStartFilters

        +
        public java.util.List<PropertyFilter<S>> getRangeStartFilters()
        +
        Returns the range start property filters supported by the evaluated + index. The operator of each filter is either RelOp.GT or RelOp.GE. The property of each filter is identical, and the properties + are also identical to any range end filters.
        +
        • +
      + + + +
        +
      • +

        getExclusiveRangeStartFilters

        +
        public java.util.List<PropertyFilter<S>> getExclusiveRangeStartFilters()
        +
        Returns the range start property filters supported by the evaluated + index whose operator is only RelOp.GT. This list is a subset of + those returned by getRangeStartFilters().
        +
        • +
      + + + +
        +
      • +

        getInclusiveRangeStartFilters

        +
        public java.util.List<PropertyFilter<S>> getInclusiveRangeStartFilters()
        +
        Returns the range start property filters supported by the evaluated + index whose operator is only RelOp.GE. This list is a subset of + those returned by getRangeStartFilters().
        +
        • +
      + + + +
        +
      • +

        hasRangeEnd

        +
        public boolean hasRangeEnd()
        +
        Returns true if any property filter with an operator of RelOp.LT + or RelOp.LE matches an index property. The index property used + for the range is the first one following the identity count.
        +
        • +
      + + + +
        +
      • +

        getRangeEndFilters

        +
        public java.util.List<PropertyFilter<S>> getRangeEndFilters()
        +
        Returns the range end property filters supported by the evaluated + index. The operator of each filter is either RelOp.LT or RelOp.LE. The property of each filter is identical, and the properties + are also identical to any range start filters.
        +
        • +
      + + + +
        +
      • +

        getExclusiveRangeEndFilters

        +
        public java.util.List<PropertyFilter<S>> getExclusiveRangeEndFilters()
        +
        Returns the range end property filters supported by the evaluated + index whose operator is only RelOp.LT. This list is a subset of + those returned by getRangeEndFilters().
        +
        • +
      + + + +
        +
      • +

        getInclusiveRangeEndFilters

        +
        public java.util.List<PropertyFilter<S>> getInclusiveRangeEndFilters()
        +
        Returns the range end property filters supported by the evaluated + index whose operator is only RelOp.LE. This list is a subset of + those returned by getRangeEndFilters().
        +
        • +
      + + + +
        +
      • +

        getHandledCount

        +
        public int getHandledCount()
        +
        Returns the count of all handled property filters.
        +
        • +
      + + + +
        +
      • +

        getHandledFilter

        +
        public Filter<S> getHandledFilter()
        +
        Returns the composite handled filter, or null if no matches at all.
        +
        • +
      + + + +
        +
      • +

        hasRangeMatch

        +
        public boolean hasRangeMatch()
        +
        Returns true if there is both a range start and range end.
        +
        • +
      + + + +
        +
      • +

        hasAnyMatches

        +
        public boolean hasAnyMatches()
        +
        Returns true if the identity count is greater than zero or if there is a + range match.
        +
        • +
      + + + +
        +
      • +

        getArrangementScore

        +
        public int getArrangementScore()
        +
        Returns a value which indicates how well the index property order + matches the property filter specification order. A higher value + can indicate that the index is a slightly better match.
        +
        Returns:
        arrangement value, never negative
        +
        • +
      + + + +
        +
      • +

        getPreferenceScore

        +
        public java.lang.Comparable getPreferenceScore()
        +
        Returns a value which indicates user index preference, based on the + original ordering of elements in the filter. A higher value can + indicate that the index is a slightly better match.
        +
        Returns:
        preference value which can be compared to another one
        +
        • +
      + + + +
        +
      • +

        getRemainderCount

        +
        public int getRemainderCount()
        +
        Returns number of property filters not supported by the evaluated index.
        +
        • +
      + + + +
        +
      • +

        getRemainderFilters

        +
        public java.util.List<? extends Filter<S>> getRemainderFilters()
        +
        Returns the filters not supported by the evaluated index.
        +
        • +
      + + + +
        +
      • +

        getRemainderFilter

        +
        public Filter<S> getRemainderFilter()
        +
        Returns the composite remainder filter not supported by the evaluated + index, or null if no remainder.
        +
        • +
      + + + +
        +
      • +

        getCoveringCount

        +
        public int getCoveringCount()
        +
        Returns number of covering property filters which are supported by the + evaluated index. This count is no more than the remainder count. If + hasAnyMatches returns false, then the covering count is zero.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getCoveringFilters

        +
        public java.util.List<? extends Filter<S>> getCoveringFilters()
        +
        Returns the covering filters which are supported by the evaluated index, + which is a subset of the remainder filters.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getCoveringFilter

        +
        public Filter<S> getCoveringFilter()
        +
        Returns the composite covering filter supported by the evaluated index, + or null if the covering count is zero.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getCoveringRemainderFilter

        +
        public Filter<S> getCoveringRemainderFilter()
        +
        Returns the composite remainder filter without including the covering + filter. Returns null if no remainder.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        isKeyMatch

        +
        public boolean isKeyMatch()
        +
        Returns true if evaluated index is unique and each of its properties has + an identity match. When index and filter are used in a query, expect at + most one result.
        +
        • +
      + + + +
        +
      • +

        shouldReverseRange

        +
        public boolean shouldReverseRange()
        +
        Returns true if there is a range start or end match, but natural order + of matching property is descending.
        +
        • +
      + + + +
        +
      • +

        canMergeRemainderFilter

        +
        public boolean canMergeRemainderFilter(FilteringScore<S> other)
        +
        Returns true if the given score uses an index exactly the same as this + one. The only allowed differences are in the remainder filter.
        +
        • +
      + + + +
        +
      • +

        mergeRemainderFilter

        +
        public Filter<S> mergeRemainderFilter(FilteringScore<S> other)
        +
        Merges the remainder filter of this score with the one given using an + 'or' operation. Call canMergeRemainderFilter first to verify if the + merge makes any sense. Returns null if no remainder filter at all.
        +
        • +
      + + + +
        +
      • +

        withRemainderFilter

        +
        public FilteringScore<S> withRemainderFilter(Filter<S> filter)
        +
        Returns a new FilteringScore with the remainder replaced and covering + matches recalculated. Other matches are not recalculated.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html new file mode 100644 index 0000000..2299151 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html @@ -0,0 +1,297 @@ + + + + + + +FullScanQueryExecutor.Support (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Interface FullScanQueryExecutor.Support<S extends Storable>

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStorableType

        +
        java.lang.Class<S> getStorableType()
        +
        • +
      + + + +
        +
      • +

        countAll

        +
        long countAll()
+              throws FetchException
        +
        Counts all Storables. Implementation may return -1 to indicate that + default count algorithm should be used.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        countAll

        +
        long countAll(Query.Controller controller)
+              throws FetchException
        +
        Counts all Storables. Implementation may return -1 to indicate that + default count algorithm should be used.
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.html new file mode 100644 index 0000000..54f2300 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.html @@ -0,0 +1,446 @@ + + + + + + +FullScanQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class FullScanQueryExecutor<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    QueryExecutor<S>
    +
    +
    +
    +
    public class FullScanQueryExecutor<S extends Storable>
+extends AbstractQueryExecutor<S>
    +
    QueryExecutor which fully scans all Storables of a given type.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html b/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html new file mode 100644 index 0000000..300d9a3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html @@ -0,0 +1,518 @@ + + + + + + +IndexedQueryAnalyzer.Result (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class IndexedQueryAnalyzer.Result

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        handlesAnything

        +
        public boolean handlesAnything()
        +
        Returns true if the selected index does anything at all to filter + results or to order them. If not, a filtered and sorted full scan + makes more sense.
        +
        • +
      + + + +
        +
      • +

        getFilter

        +
        public Filter<S> getFilter()
        +
        Returns combined handled and remainder filter for this result.
        +
        • +
      + + + +
        +
      • +

        getOrdering

        +
        public OrderingList<S> getOrdering()
        +
        Returns combined handled and remainder orderings for this result.
        +
        • +
      + + + +
        +
      • +

        getCompositeScore

        +
        public CompositeScore<S> getCompositeScore()
        +
        Returns the score on how well the selected index performs the + desired filtering and ordering.
        +
        • +
      + + + +
        +
      • +

        getRemainderFilter

        +
        public Filter<S> getRemainderFilter()
        +
        Remainder filter which overrides that in composite score.
        +
        • +
      + + + +
        +
      • +

        getRemainderOrdering

        +
        public OrderingList<S> getRemainderOrdering()
        +
        Remainder orderings which override that in composite score.
        +
        • +
      + + + +
        +
      • +

        getLocalIndex

        +
        public StorableIndex<S> getLocalIndex()
        +
        Returns the local index that was selected, or null if a foreign + index was selected.
        +
        • +
      + + + +
        +
      • +

        getForeignIndex

        +
        public StorableIndex<?> getForeignIndex()
        +
        Returns the foreign index that was selected, or null if a local + index was selected. If a foreign index has been selected, then a + JoinedQueryExecutor is needed.
        +
        • +
      + + + +
        +
      • +

        getForeignProperty

        +
        public ChainedProperty<S> getForeignProperty()
        +
        Returns the simple or chained property that maps to the selected + foreign index. Returns null if foreign index was not selected. This + property corresponds to the "targetToSourceProperty" of JoinedQueryExecutor.
        +
        • +
      + + + +
        +
      • +

        isIndexClustered

        +
        public boolean isIndexClustered()
        +
        Returns true if local or foreign index is clustered. Scans of + clustered indexes are generally faster.
        +
        • +
      + + + +
        +
      • +

        canMergeRemainder

        +
        public boolean canMergeRemainder(IndexedQueryAnalyzer.Result other)
        +
        Returns true if the given result uses the same index as this, and in + the same way. The only allowed differences are in the remainder + filter and orderings.
        +
        • +
      + + + +
        +
      • +

        mergeRemainder

        +
        public IndexedQueryAnalyzer.Result mergeRemainder(IndexedQueryAnalyzer.Result other)
        +
        Merges the remainder filter and orderings of this result with the + one given, returning a new result. Call canMergeRemainder first to + verify if the merge makes any sense.
        +
        • +
      + + + +
        +
      • +

        mergeRemainderFilter

        +
        public IndexedQueryAnalyzer.Result mergeRemainderFilter(Filter<S> filter)
        +
        Merges the remainder filter of this result with the given filter, + returning a new result. If handlesAnything return true, then it + doesn't usually make sense to call this method.
        +
        • +
      + + + +
        +
      • +

        withRemainderFilter

        +
        public IndexedQueryAnalyzer.Result withRemainderFilter(Filter<S> remainderFilter)
        +
        Returns a new result with the remainder filter replaced.
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.html b/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.html new file mode 100644 index 0000000..b427293 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.html @@ -0,0 +1,316 @@ + + + + + + +IndexedQueryAnalyzer (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class IndexedQueryAnalyzer<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public class IndexedQueryAnalyzer<S extends Storable>
+extends java.lang.Object
    +
    Analyzes a simple query specification and determines which index is best + suited for its execution. Query filters passed to this analyzer cannot + contain any 'or' operations. + +

    IndexedQueryAnalyzer is sharable and thread-safe. An instance for a + particular Storable type can be cached, avoiding repeated construction + cost. In addition, the analyzer caches learned foreign indexes.

    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    UnionQueryAnalyzer
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        IndexedQueryAnalyzer

        +
        public IndexedQueryAnalyzer(java.lang.Class<S> type,
+                    RepositoryAccess access)
        +
        Parameters:
        type - type of storable being queried
        access - repository access for examing available indexes
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if type or indexProvider is null
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html new file mode 100644 index 0000000..e841803 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html @@ -0,0 +1,375 @@ + + + + + + +IndexedQueryExecutor.Support (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Interface IndexedQueryExecutor.Support<S extends Storable>

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        indexEntryQuery

        +
        Query<?> indexEntryQuery(StorableIndex<S> index)
+                         throws FetchException
        +
        Returns an open query if the given index supports query access. If + not supported, return null. An index entry query might be used to + perform filtering and sorting of index entries prior to being + resolved into referenced Storables. + +

        If an index entry query is returned, the fetchSubset method is + never called by IndexedQueryExecutor.

        +
        Returns:
        index entry query or null if not supported
        +
        Throws:
        +
        FetchException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        fetchFromIndexEntryQuery

        +
        Cursor<S> fetchFromIndexEntryQuery(StorableIndex<S> index,
+                                 Query<?> indexEntryQuery)
+                                                    throws FetchException
        +
        Fetch Storables referenced by the given index entry query. This + method is only called if index supports query access.
        +
        Parameters:
        index - index to open
        indexEntryQuery - query with no blank parameters, derived from + the query returned by indexEntryQuery
        +
        Throws:
        +
        FetchException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        fetchFromIndexEntryQuery

        +
        Cursor<S> fetchFromIndexEntryQuery(StorableIndex<S> index,
+                                 Query<?> indexEntryQuery,
+                                 Query.Controller controller)
+                                                    throws FetchException
        +
        Fetch Storables referenced by the given index entry query. This + method is only called if index supports query access.
        +
        Parameters:
        index - index to open
        indexEntryQuery - query with no blank parameters, derived from + the query returned by indexEntryQuery
        controller - optional controller which can abort query operation
        +
        Throws:
        +
        FetchException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        fetchSubset

        +
        Cursor<S> fetchSubset(StorableIndex<S> index,
+                    java.lang.Object[] identityValues,
+                    BoundaryType rangeStartBoundary,
+                    java.lang.Object rangeStartValue,
+                    BoundaryType rangeEndBoundary,
+                    java.lang.Object rangeEndValue,
+                    boolean reverseRange,
+                    boolean reverseOrder)
+                                       throws FetchException
        +
        Perform an index scan of a subset of Storables referenced by an + index. The identity values are aligned with the index properties at + property 0. An optional range start or range end aligns with the index + property following the last of the identity values. + +

        This method is only called if no index entry query was provided + for the given index.

        +
        Parameters:
        index - index to open, which may be a primary key index
        identityValues - optional list of exactly matching values to apply to index
        rangeStartBoundary - start boundary type
        rangeStartValue - value to start at if boundary is not open
        rangeEndBoundary - end boundary type
        rangeEndValue - value to end at if boundary is not open
        reverseRange - indicates that range operates on a property whose + natural order is descending. Only the code that opens the physical + cursor should examine this parameter. If true, then the range start and + end parameter pairs need to be swapped.
        reverseOrder - when true, iteration should be reversed from its + natural order
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        fetchSubset

        +
        Cursor<S> 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)
+                                       throws FetchException
        +
        Perform an index scan of a subset of Storables referenced by an + index. The identity values are aligned with the index properties at + property 0. An optional range start or range end aligns with the index + property following the last of the identity values. + +

        This method is only called if no index entry query was provided + for the given index.

        +
        Parameters:
        index - index to open, which may be a primary key index
        identityValues - optional list of exactly matching values to apply to index
        rangeStartBoundary - start boundary type
        rangeStartValue - value to start at if boundary is not open
        rangeEndBoundary - end boundary type
        rangeEndValue - value to end at if boundary is not open
        reverseRange - indicates that range operates on a property whose + natural order is descending. Only the code that opens the physical + cursor should examine this parameter. If true, then the range start and + end parameter pairs need to be swapped.
        reverseOrder - when true, iteration should be reversed from its + natural order
        controller - optional controller which can abort query operation
        +
        Throws:
        +
        FetchException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.html new file mode 100644 index 0000000..89c23a3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.html @@ -0,0 +1,436 @@ + + + + + + +IndexedQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class IndexedQueryExecutor<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    QueryExecutor<S>
    +
    +
    +
    +
    public class IndexedQueryExecutor<S extends Storable>
+extends AbstractQueryExecutor<S>
    +
    QueryExecutor which utilizes an index.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + + + + + +
        +
      • +

        getCoveringFilter

        +
        public Filter<S> getCoveringFilter()
        +
        Returns:
        null if executor doesn't support or use a covering index
        +
        • +
      + + + +
        +
      • +

        getFilter

        +
        public Filter<S> getFilter()
        +
        Description copied from interface: QueryExecutor
        +
        Returns the filter used by this QueryExecutor.
        +
        Returns:
        query filter, never null
        +
        • +
      + + + +
        +
      • +

        getOrdering

        +
        public OrderingList<S> getOrdering()
        +
        Description copied from interface: QueryExecutor
        +
        Returns the result ordering of this QueryExecutor.
        +
        Returns:
        query ordering in an unmodifiable list
        +
        • +
      + + + +
        +
      • +

        printPlan

        +
        public boolean printPlan(java.lang.Appendable app,
+                int indentLevel,
+                FilterValues<S> values)
+                  throws java.io.IOException
        +
        Description copied from interface: QueryExecutor
        +
        Prints the query plan to any appendable, if applicable.
        +
        values - optional
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/IterableQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/IterableQueryExecutor.html new file mode 100644 index 0000000..42310dd --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/IterableQueryExecutor.html @@ -0,0 +1,386 @@ + + + + + + +IterableQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class IterableQueryExecutor<S extends Storable>

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        IterableQueryExecutor

        +
        public IterableQueryExecutor(java.lang.Class<S> type,
+                     java.lang.Iterable<S> iterable)
        +
        Parameters:
        type - type of Storable
        iterable - collection to iterate over, or null for empty cursor
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if type is null
        +
        • +
      + + + +
        +
      • +

        IterableQueryExecutor

        +
        public IterableQueryExecutor(java.lang.Class<S> type,
+                     java.lang.Iterable<S> iterable,
+                     java.util.concurrent.locks.Lock lock)
        +
        Parameters:
        type - type of Storable
        iterable - collection to iterate over, or null for empty cursor
        lock - optional lock to hold while cursor is open
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if type is null
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFilter

        +
        public Filter<S> getFilter()
        +
        Returns an open filter.
        +
        Returns:
        query filter, never null
        +
        • +
      + + + +
        +
      • +

        fetch

        +
        public Cursor<S> fetch(FilterValues<S> values)
        +
        Description copied from interface: QueryExecutor
        +
        Returns a new cursor using the given filter values.
        +
        • +
      + + + +
        +
      • +

        fetch

        +
        public Cursor<S> fetch(FilterValues<S> values,
+              Query.Controller controller)
        +
        Description copied from interface: QueryExecutor
        +
        Returns a new cursor using the given filter values.
        +
        controller - optional controller which can abort query operation
        +
        • +
      + + + +
        +
      • +

        getOrdering

        +
        public OrderingList<S> getOrdering()
        +
        Returns an empty list.
        +
        Returns:
        query ordering in an unmodifiable list
        +
        • +
      + + + +
        +
      • +

        printPlan

        +
        public boolean printPlan(java.lang.Appendable app,
+                int indentLevel,
+                FilterValues<S> values)
+                  throws java.io.IOException
        +
        Description copied from interface: QueryExecutor
        +
        Prints the query plan to any appendable, if applicable.
        +
        values - optional
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/JoinedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/JoinedQueryExecutor.html new file mode 100644 index 0000000..e8fd436 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/JoinedQueryExecutor.html @@ -0,0 +1,374 @@ + + + + + + +JoinedQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class JoinedQueryExecutor<S extends Storable,T extends Storable>

+
+
+ +
+
    +
  • +
    Type Parameters:
    S - source type
    T - target type
    +
    +
    All Implemented Interfaces:
    +
    QueryExecutor<T>
    +
    +
    +
    +
    public class JoinedQueryExecutor<S extends Storable,T extends Storable>
+extends AbstractQueryExecutor<T>
    +
    QueryExecutor which joins a source and target executor, + producing results of target type. The source executor is called once per + fetch (outer loop), but the target executor is called once per source result + (inner loop).
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        build

        +
        public static <T extends Storable> QueryExecutor<T> build(RepositoryAccess repoAccess,
+                                          ChainedProperty<T> targetToSourceProperty,
+                                          Filter<T> targetFilter,
+                                          OrderingList<T> targetOrdering,
+                                          QueryHints hints)
+                                               throws RepositoryException
        +
        Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins. Filtering and ordering may also be supplied, + in order to better distribute work throughout the join.
        +
        Parameters:
        repoAccess - used to create query executors for outer and inner loops
        targetToSourceProperty - join property of target type which maps + to instances of source type
        targetFilter - optional filter for fetching target instances
        targetOrdering - optional ordering to apply to target executor + & @param hints optional hints
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any parameter is null or if join + property is not a Storable type
        +
        RepositoryException - from RepositoryAccess
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getFilter

        +
        public Filter<T> getFilter()
        +
        Description copied from interface: QueryExecutor
        +
        Returns the filter used by this QueryExecutor.
        +
        Returns:
        query filter, never null
        +
        • +
      + + + +
        +
      • +

        getOrdering

        +
        public OrderingList<T> getOrdering()
        +
        Description copied from interface: QueryExecutor
        +
        Returns the result ordering of this QueryExecutor.
        +
        Returns:
        query ordering in an unmodifiable list
        +
        • +
      + + + +
        +
      • +

        printPlan

        +
        public boolean printPlan(java.lang.Appendable app,
+                int indentLevel,
+                FilterValues<T> values)
+                  throws java.io.IOException
        +
        Description copied from interface: QueryExecutor
        +
        Prints the query plan to any appendable, if applicable.
        +
        values - optional
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.Support.html new file mode 100644 index 0000000..ec60bce --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.Support.html @@ -0,0 +1,254 @@ + + + + + + +KeyQueryExecutor.Support (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Interface KeyQueryExecutor.Support<S extends Storable>

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      Cursor<S>fetchOne(StorableIndex<S> index, + java.lang.Object[] identityValues) +
      Select at most one Storable referenced by an index.
      +
      Cursor<S>fetchOne(StorableIndex<S> index, + java.lang.Object[] identityValues, + Query.Controller controller) +
      Select at most one Storable referenced by an index.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        fetchOne

        +
        Cursor<S> fetchOne(StorableIndex<S> index,
+                 java.lang.Object[] identityValues)
+                                    throws FetchException
        +
        Select at most one Storable referenced by an index. The identity + values fully specify all elements of the index, and the index is + unique.
        +
        Parameters:
        index - index to open, which may be a primary key index
        identityValues - of exactly matching values to apply to index
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        fetchOne

        +
        Cursor<S> fetchOne(StorableIndex<S> index,
+                 java.lang.Object[] identityValues,
+                 Query.Controller controller)
+                                    throws FetchException
        +
        Select at most one Storable referenced by an index. The identity + values fully specify all elements of the index, and the index is + unique.
        +
        Parameters:
        controller - optional controller which can abort query operation
        index - index to open, which may be a primary key index
        identityValues - of exactly matching values to apply to index
        +
        Throws:
        +
        FetchException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.html new file mode 100644 index 0000000..4a39b5a --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.html @@ -0,0 +1,421 @@ + + + + + + +KeyQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class KeyQueryExecutor<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    QueryExecutor<S>
    +
    +
    +
    +
    public class KeyQueryExecutor<S extends Storable>
+extends AbstractQueryExecutor<S>
    +
    QueryExecutor which has a fully specified key, and so cursors produce at + most one result.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        KeyQueryExecutor

        +
        public KeyQueryExecutor(KeyQueryExecutor.Support<S> support,
+                StorableIndex<S> index,
+                FilteringScore<S> score)
        +
        Parameters:
        index - index to use, which may be a primary key index
        score - score determines how best to utilize the index
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any parameter is null or if index is + not unique or if score is not a key match
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/OrderingList.html b/apidocs/com/amazon/carbonado/qe/OrderingList.html new file mode 100644 index 0000000..f33cfe9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/OrderingList.html @@ -0,0 +1,559 @@ + + + + + + +OrderingList (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class OrderingList<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Iterable<OrderedProperty<S>>, java.util.Collection<OrderedProperty<S>>, java.util.List<OrderedProperty<S>>
    +
    +
    +
    +
    public class OrderingList<S extends Storable>
+extends java.util.AbstractList<OrderedProperty<S>>
+implements java.io.Serializable
    +
    Produces unmodifiable lists of orderings. Instances + are immutable, canonical and cached. Calls to "equals" and "hashCode" are + fast.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class java.util.AbstractList

        +modCount
        • +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      OrderingList<S>concat(java.lang.Class<S> type, + java.lang.String property) +
      Returns a list which concatenates this one with the given property.
      +
      OrderingList<S>concat(OrderedProperty<S> property) +
      Returns a list which concatenates this one with the given property.
      +
      OrderingList<S>concat(OrderingList<S> other) +
      Returns a list which concatenates this one with the other one.
      +
      static <S extends Storable> 
      OrderingList<S>      		emptyList() +
      Returns a canonical empty instance.
      +
      booleanequals(java.lang.Object other) 
      static <S extends Storable> 
      OrderingList<S>      		get(java.lang.Class<S> type, + java.lang.String... orderings) +
      Returns a canonical instance composed of the given orderings.
      +
      static <S extends Storable> 
      OrderingList<S>      		get(java.lang.Class<S> type, + java.lang.String property) +
      Returns a canonical instance composed of the given ordering.
      +
      OrderedProperty<S>get(int index) 
      static <S extends Storable> 
      OrderingList<S>      		get(java.util.List<OrderedProperty<S>> orderings) +
      Returns a canonical instance composed of the given orderings.
      +
      static <S extends Storable> 
      OrderingList<S>      		get(OrderedProperty<S>... orderings) +
      Returns a canonical instance composed of the given orderings.
      +
      inthashCode() 
      OrderingList<S>reduce() +
      Eliminates redundant ordering properties.
      +
      OrderingList<S>replace(int index, + OrderedProperty<S> property) +
      Returns a list with the given element replaced.
      +
      OrderingList<S>reverseDirections() +
      Returns this list with all orderings in reverse.
      +
      intsize() 
      OrderingList<S>subList(int fromIndex, + int toIndex) 
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractList

        +add, add, addAll, clear, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set
        • +
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractCollection

        +addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.List

        +addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        emptyList

        +
        public static <S extends Storable> OrderingList<S> emptyList()
        +
        Returns a canonical empty instance.
        +
        • +
      + + + +
        +
      • +

        get

        +
        public static <S extends Storable> OrderingList<S> get(java.lang.Class<S> type,
+                                       java.lang.String property)
        +
        Returns a canonical instance composed of the given ordering.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if ordering property is not in S
        +
        • +
      + + + +
        +
      • +

        get

        +
        public static <S extends Storable> OrderingList<S> get(java.lang.Class<S> type,
+                                       java.lang.String... orderings)
        +
        Returns a canonical instance composed of the given orderings.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any ordering property is not in S
        +
        • +
      + + + + + + + +
        +
      • +

        get

        +
        public static <S extends Storable> OrderingList<S> get(java.util.List<OrderedProperty<S>> orderings)
        +
        Returns a canonical instance composed of the given orderings.
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        concat

        +
        public OrderingList<S> concat(java.lang.Class<S> type,
+                     java.lang.String property)
        +
        Returns a list which concatenates this one with the given property.
        +
        • +
      + + + +
        +
      • +

        concat

        +
        public OrderingList<S> concat(OrderedProperty<S> property)
        +
        Returns a list which concatenates this one with the given property.
        +
        • +
      + + + +
        +
      • +

        concat

        +
        public OrderingList<S> concat(OrderingList<S> other)
        +
        Returns a list which concatenates this one with the other one.
        +
        • +
      + + + +
        +
      • +

        reduce

        +
        public OrderingList<S> reduce()
        +
        Eliminates redundant ordering properties.
        +
        • +
      + + + +
        +
      • +

        reverseDirections

        +
        public OrderingList<S> reverseDirections()
        +
        Returns this list with all orderings in reverse.
        +
        • +
      + + + + + + + + + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/OrderingScore.html b/apidocs/com/amazon/carbonado/qe/OrderingScore.html new file mode 100644 index 0000000..6b327ce --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/OrderingScore.html @@ -0,0 +1,547 @@ + + + + + + +OrderingScore (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class OrderingScore<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public class OrderingScore<S extends Storable>
+extends java.lang.Object
    +
    Evaluates an index for how well it matches a query's desired ordering. An + ordering score is not a single absolute value – instead it has a relative + weight when compared to other scores. + +

    An index matches a desired ordering if the arrangement of properties + matches. Not all properties of the index need to be used, however. Also, + gaps in the arrangement are allowed if a property identity filter + matches. A property identity filter is of the form "a = ?". + +

    An OrderingScore measures the number of ordering properties that are + matched and the number that are remaining. If there are remainder + properties, then the user of the evaluated index will need to perform a + post-sort operation to achieve the desired results. + +

    In general, an OrderingScore is better than another if it has more + matched properties and fewer remainder properties. Index clustering, + property count, and natural order is also considered.

    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    FilteringScore, +CompositeScore
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        evaluate

        +
        public static <S extends Storable> OrderingScore<S> 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.
        +
        Parameters:
        index - index to evaluate
        filter - optional filter which cannot contain any logical 'or' operations.
        ordering - optional properties which define desired ordering
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if index is null or filter is not supported
        +
        • +
      + + + +
        +
      • +

        evaluate

        +
        public static <S extends Storable> OrderingScore<S> 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.
        +
        Parameters:
        indexProperties - index properties to evaluate
        unique - true if index is unique
        clustered - true if index is clustered
        filter - optional filter which cannot contain any logical 'or' operations.
        ordering - optional properties which define desired ordering
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if index is null or filter is not supported
        +
        • +
      + + + +
        +
      • +

        fullComparator

        +
        public static java.util.Comparator<OrderingScore<?>> fullComparator()
        +
        Returns a comparator which determines which OrderingScores are + better. It does not matter if the scores were evaluated for different + indexes or storable types. The comparator returns <0 if first + score is better, 0 if equal, or >0 if second is better.
        +
        • +
      + + + +
        +
      • +

        isIndexClustered

        +
        public boolean isIndexClustered()
        +
        Returns true if evaluated index is clustered. Scans of clustered indexes + are generally faster.
        +
        • +
      + + + +
        +
      • +

        getIndexPropertyCount

        +
        public int getIndexPropertyCount()
        +
        Returns the amount of properties in the evaluated index.
        +
        • +
      + + + +
        +
      • +

        getHandledCount

        +
        public int getHandledCount()
        +
        Returns the number of desired orderings the evaluated index + supports. The number of orderings is reduced to eliminate redundancies.
        +
        • +
      + + + +
        +
      • +

        getHandledOrdering

        +
        public OrderingList<S> getHandledOrdering()
        +
        Returns the ordering properties that the evaluated index supports. The + list of orderings is reduced to eliminate redundancies. If any handled + ordering properties originally had an unspecified direction, the correct + direction is specified in this list.
        +
        Returns:
        handled orderings, never null
        +
        • +
      + + + +
        +
      • +

        getRemainderCount

        +
        public int getRemainderCount()
        +
        Returns the number of desired orderings the evaluated index does not + support. The number of orderings is reduced to eliminate redundancies. + When the remainder count is non-zero, a query plan which uses the + evaluated index must perform a sort.
        +
        • +
      + + + +
        +
      • +

        getRemainderOrdering

        +
        public OrderingList<S> getRemainderOrdering()
        +
        Returns the ordering properties that the evaluated index does not + support. The list of orderings is reduced to eliminate redundancies.
        +
        Returns:
        remainder orderings, never null
        +
        • +
      + + + +
        +
      • +

        shouldReverseOrder

        +
        public boolean shouldReverseOrder()
        +
        Returns true if evaluated index must be iterated in reverse to achieve + the desired ordering.
        +
        • +
      + + + +
        +
      • +

        getFreeOrdering

        +
        public OrderingList<S> getFreeOrdering()
        +
        Returns potential ordering properties that the evaluated index can + handle, if arranged to immediately follow the handled orderings. The + direction of any free orderings may be UNSPECIFIED, which indicates that + specific order is not relevant.
        +
        Returns:
        free orderings, never null
        +
        • +
      + + + +
        +
      • +

        getUnusedOrdering

        +
        public OrderingList<S> getUnusedOrdering()
        +
        Returns unused ordering properties of the evaluated index because they + were filtered out. The direction of each unused ordering is UNSPECIFIED + because specific order is not relevant.
        +
        Returns:
        unused orderings, never null
        +
        • +
      + + + +
        +
      • +

        canMergeRemainderOrdering

        +
        public boolean canMergeRemainderOrdering(OrderingScore<S> other)
        +
        Returns true if the given score uses an index exactly the same as this + one. The only allowed differences are in the count of remainder + orderings.
        +
        • +
      + + + +
        +
      • +

        mergeRemainderOrdering

        +
        public OrderingList<S> mergeRemainderOrdering(OrderingScore<S> other)
        +
        Merges the remainder orderings of this score with the one given. Call + canMergeRemainderOrdering first to verify if the merge makes any sense.
        +
        • +
      + + + +
        +
      • +

        withRemainderOrdering

        +
        public OrderingScore<S> withRemainderOrdering(OrderingList<S> ordering)
        +
        Returns a new OrderingScore with the remainder replaced. Handled count + is not recalculated.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/QueryEngine.html b/apidocs/com/amazon/carbonado/qe/QueryEngine.html new file mode 100644 index 0000000..fdcbeb3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryEngine.html @@ -0,0 +1,329 @@ + + + + + + +QueryEngine (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class QueryEngine<S extends Storable>

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/QueryExecutor.html b/apidocs/com/amazon/carbonado/qe/QueryExecutor.html new file mode 100644 index 0000000..b3f7950 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryExecutor.html @@ -0,0 +1,437 @@ + + + + + + +QueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Interface QueryExecutor<S extends Storable>

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStorableType

        +
        java.lang.Class<S> getStorableType()
        +
        Returns the storable type that this executor operates on.
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        fetchSlice

        +
        Cursor<S> fetchSlice(FilterValues<S> values,
+                   long from,
+                   java.lang.Long to,
+                   Query.Controller controller)
+                                      throws FetchException
        +
        Returns a new cursor using the given filter values and slice.
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Throws:
        +
        FetchException
        Since:
        +
        1.2
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getFilter

        +
        Filter<S> getFilter()
        +
        Returns the filter used by this QueryExecutor.
        +
        Returns:
        query filter, never null
        +
        • +
      + + + +
        +
      • +

        getOrdering

        +
        OrderingList<S> getOrdering()
        +
        Returns the result ordering of this QueryExecutor.
        +
        Returns:
        query ordering in an unmodifiable list
        +
        • +
      + + + +
        +
      • +

        printNative

        +
        boolean printNative(java.lang.Appendable app,
+                  int indentLevel,
+                  FilterValues<S> values)
+                    throws java.io.IOException
        +
        Prints the native query to any appendable, if applicable.
        +
        Parameters:
        values - optional
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        printPlan

        +
        boolean printPlan(java.lang.Appendable app,
+                int indentLevel,
+                FilterValues<S> values)
+                  throws java.io.IOException
        +
        Prints the query plan to any appendable, if applicable.
        +
        Parameters:
        values - optional
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/QueryExecutorCache.html b/apidocs/com/amazon/carbonado/qe/QueryExecutorCache.html new file mode 100644 index 0000000..9d73f5a --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryExecutorCache.html @@ -0,0 +1,300 @@ + + + + + + +QueryExecutorCache (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class QueryExecutorCache<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    QueryExecutorFactory<S>
    +
    +
    +
    +
    public class QueryExecutorCache<S extends Storable>
+extends java.lang.Object
+implements QueryExecutorFactory<S>
    +
    QueryExecutors should be cached since expensive analysis is often required to build + them. By default, a minimum of 100 query executors can be cached per Storable type. + The minimum can be changed with the + "com.amazon.carbonado.qe.QueryExecutorCache.minCapacity" system property.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/QueryExecutorFactory.html b/apidocs/com/amazon/carbonado/qe/QueryExecutorFactory.html new file mode 100644 index 0000000..f8d3b30 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryExecutorFactory.html @@ -0,0 +1,239 @@ + + + + + + +QueryExecutorFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Interface QueryExecutorFactory<S extends Storable>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/QueryFactory.html b/apidocs/com/amazon/carbonado/qe/QueryFactory.html new file mode 100644 index 0000000..4cad899 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryFactory.html @@ -0,0 +1,241 @@ + + + + + + +QueryFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Interface QueryFactory<S extends Storable>

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStorableType

        +
        java.lang.Class<S> getStorableType()
        +
        • +
      + + + +
        +
      • +

        query

        +
        Query<S> query(Filter<S> filter,
+             FilterValues<S> values,
+             OrderingList<S> ordering,
+             QueryHints hints)
+                                throws FetchException
        +
        Returns a query that handles the given query specification.
        +
        Parameters:
        filter - optional filter object, defaults to open filter if null
        values - optional values object, defaults to filter initial values
        ordering - optional order-by properties
        hints - optional hints
        +
        Throws:
        +
        FetchException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/QueryHint.html b/apidocs/com/amazon/carbonado/qe/QueryHint.html new file mode 100644 index 0000000..41f32ac --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryHint.html @@ -0,0 +1,320 @@ + + + + + + +QueryHint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Enum QueryHint

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<QueryHint>
    +
    +
    +
    +
    public enum QueryHint
+extends java.lang.Enum<QueryHint>
    +
    Defines a hint key.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    QueryHints
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      CONSUME_SLICE +
      Intention to consume a slice of matched records
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static QueryHintvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static QueryHint[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        CONSUME_SLICE

        +
        public static final QueryHint CONSUME_SLICE
        +
        Intention to consume a slice of matched records
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static QueryHint[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (QueryHint c : QueryHint.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in +the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static QueryHint valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/QueryHints.html b/apidocs/com/amazon/carbonado/qe/QueryHints.html new file mode 100644 index 0000000..6e631c7 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryHints.html @@ -0,0 +1,387 @@ + + + + + + +QueryHints (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class QueryHints

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class QueryHints
+extends java.lang.Object
+implements java.io.Serializable
    +
    An immutable map of query hints.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    QueryHint, +Serialized Form
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleancontains(QueryHint hint) +
      Returns false if hint is not provided.
      +
      static QueryHintsemptyHints() 
      booleanequals(java.lang.Object obj) 
      java.lang.Objectget(QueryHint hint) +
      Returns null if hint is not provided.
      +
      inthashCode() 
      booleanisEmpty() 
      java.lang.StringtoString() 
      QueryHintswith(QueryHint hint) +
      Returns a new QueryHints object with the given hint.
      +
      QueryHintswith(QueryHint hint, + java.lang.Object value) +
      Returns a new QueryHints object with the given hint and value.
      +
      QueryHintswithout(QueryHint hint) +
      Returns a new QueryHints object without the given hint.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        emptyHints

        +
        public static QueryHints emptyHints()
        +
        • +
      + + + +
        +
      • +

        with

        +
        public QueryHints with(QueryHint hint)
        +
        Returns a new QueryHints object with the given hint. The associated + value is the hint object itself.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if hint is null
        +
        • +
      + + + +
        +
      • +

        with

        +
        public QueryHints with(QueryHint hint,
+              java.lang.Object value)
        +
        Returns a new QueryHints object with the given hint and value.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if hint or value is null
        +
        • +
      + + + +
        +
      • +

        without

        +
        public QueryHints without(QueryHint hint)
        +
        Returns a new QueryHints object without the given hint.
        +
        • +
      + + + +
        +
      • +

        contains

        +
        public boolean contains(QueryHint hint)
        +
        Returns false if hint is not provided.
        +
        • +
      + + + +
        +
      • +

        get

        +
        public java.lang.Object get(QueryHint hint)
        +
        Returns null if hint is not provided.
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/RepositoryAccess.html b/apidocs/com/amazon/carbonado/qe/RepositoryAccess.html new file mode 100644 index 0000000..761a4ee --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/RepositoryAccess.html @@ -0,0 +1,238 @@ + + + + + + +RepositoryAccess (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Interface RepositoryAccess

+
+
+
+
    +
  • +
    +
    +
    public interface RepositoryAccess
    +
    Provides internal access to a Repository, necessary for query + execution.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html new file mode 100644 index 0000000..628115a --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html @@ -0,0 +1,296 @@ + + + + + + +SortedQueryExecutor.ArraySortSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class SortedQueryExecutor.ArraySortSupport<S extends Storable>

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html new file mode 100644 index 0000000..c5b2888 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html @@ -0,0 +1,296 @@ + + + + + + +SortedQueryExecutor.MergeSortSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class SortedQueryExecutor.MergeSortSupport<S extends Storable>

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.Support.html new file mode 100644 index 0000000..714d83d --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.Support.html @@ -0,0 +1,241 @@ + + + + + + +SortedQueryExecutor.Support (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Interface SortedQueryExecutor.Support<S extends Storable>

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        createSortBuffer

        +
        SortBuffer<S> createSortBuffer()
        +
        Implementation must return an empty buffer for sorting.
        +
        • +
      + + + +
        +
      • +

        createSortBuffer

        +
        SortBuffer<S> createSortBuffer(Query.Controller controller)
        +
        Implementation must return an empty buffer for sorting.
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.html new file mode 100644 index 0000000..9f616f8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.html @@ -0,0 +1,494 @@ + + + + + + +SortedQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class SortedQueryExecutor<S extends Storable>

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/StandardQuery.html b/apidocs/com/amazon/carbonado/qe/StandardQuery.html new file mode 100644 index 0000000..51544d0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/StandardQuery.html @@ -0,0 +1,1368 @@ + + + + + + +StandardQuery (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class StandardQuery<S extends Storable>

+
+
+ +
+ +
+
+
    +
  • + + + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      <T extends S> 
      Query<S>      		after(T start) +
      Returns a query which fetches results for this query after a given + starting point, which is useful for re-opening a cursor.
      +
      Query<S>and(Filter<S> filter) +
      Returns a new query which has another filter logically "and"ed to this, potentially reducing the amount of + results.
      +
      voidappendTo(java.lang.Appendable app) +
      Append the string representation of this object to the given Appendable.
      +
      protected voidclearExecutor() +
      Clears any cached reference to a query executor.
      +
      longcount() +
      Returns a count of all results matched by this query.
      +
      longcount(Query.Controller controller) +
      Returns a count of all results matched by this query.
      +
      voiddeleteAll() +
      Deletes zero or more matching objects.
      +
      voiddeleteAll(Query.Controller controller) +
      Deletes zero or more matching objects.
      +
      protected abstract TransactionenterTransaction(IsolationLevel level) +
      Enter a transaction as needed by the standard delete operation, or null + if transactions are not supported.
      +
      booleanequals(java.lang.Object obj) 
      protected QueryExecutor<S>executor() +
      Returns the executor in use by this query.
      +
      protected abstract QueryExecutorFactory<S>executorFactory() +
      Return a QueryExecutorFactory which is used to get an executor.
      +
      booleanexists() +
      Returns true if any results are matched by this query.
      +
      booleanexists(Query.Controller controller) +
      Returns true if any results are matched by this query.
      +
      Cursor<S>fetch() +
      Fetches results for this query.
      +
      Cursor<S>fetch(Query.Controller controller) +
      Fetches results for this query.
      +
      Cursor<S>fetchSlice(long from, + java.lang.Long to) +
      Fetches a slice of results for this query, as defined by a numerical + range.
      +
      Cursor<S>fetchSlice(long from, + java.lang.Long to, + Query.Controller controller) +
      Fetches a slice of results for this query, as defined by a numerical + range.
      +
      intgetBlankParameterCount() +
      Returns the amount of blank parameters that need to be filled in.
      +
      Filter<S>getFilter() +
      Returns the query's filter.
      +
      FilterValues<S>getFilterValues() +
      Returns the query's filter values, which is null if filter has no + parameters.
      +
      protected OrderingList<S>getOrdering() 
      java.lang.Class<S>getStorableType() +
      Returns the specific type of Storable managed by this object.
      +
      inthashCode() 
      protected abstract StandardQuery<S>newInstance(FilterValues<S> values, + OrderingList<S> ordering, + QueryHints hints) +
      Return a new or cached instance of StandardQuery implementation, using + new filter values.
      +
      Query<S>not() +
      Returns a new query which produces all the results not supplied in this + query.
      +
      Query<S>or(Filter<S> filter) +
      Returns a new query which has another filter logically "or"ed to this, potentially increasing the amount of + results.
      +
      Query<S>orderBy(java.lang.String... properties) +
      Returns a copy of this query ordered by specific property values.
      +
      Query<S>orderBy(java.lang.String property) +
      Returns a copy of this query ordered by a specific property value.
      +
      booleanprintNative(java.lang.Appendable app, + int indentLevel) +
      Prints the native query to any appendable, which is useful for + performance analysis.
      +
      booleanprintPlan(java.lang.Appendable app, + int indentLevel) +
      Prints the query excecution plan to any appendable, which is useful for + performance analysis.
      +
      protected abstract QueryFactory<S>queryFactory() +
      Return a QueryFactory which is used to form new queries from this one.
      +
      protected voidresetExecutor() +
      Resets any cached reference to a query executor.
      +
      protected voidsetExecutor() +
      Ensures that a cached query executor reference is available.
      +
      booleantryDeleteOne() +
      Deletes zero or one matching objects.
      +
      booleantryDeleteOne(Query.Controller controller) +
      Deletes zero or one matching objects.
      +
      Query<S>with(boolean value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(byte value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(char value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(double value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(float value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(int value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(long value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(java.lang.Object value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(short value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>withValues(java.lang.Object... values) +
      Returns a copy of this Query with the next blank parameters filled in.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StandardQuery

        +
        protected StandardQuery(Filter<S> filter,
+             FilterValues<S> values,
+             OrderingList<S> ordering,
+             QueryHints hints)
        +
        Parameters:
        filter - optional filter object, defaults to open filter if null
        values - optional values object, defaults to filter initial values
        ordering - optional order-by properties
        hints - optional query hints
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStorableType

        +
        public java.lang.Class<S> getStorableType()
        +
        Description copied from interface: Query
        +
        Returns the specific type of Storable managed by this object.
        +
        +
        Specified by:
        +
        getStorableType in interface Query<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        getFilter

        +
        public Filter<S> getFilter()
        +
        Description copied from interface: Query
        +
        Returns the query's filter.
        +
        +
        Specified by:
        +
        getFilter in interface Query<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        getFilterValues

        +
        public FilterValues<S> getFilterValues()
        +
        Description copied from interface: Query
        +
        Returns the query's filter values, which is null if filter has no + parameters.
        +
        +
        Specified by:
        +
        getFilterValues in interface Query<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        getBlankParameterCount

        +
        public int getBlankParameterCount()
        +
        Description copied from interface: Query
        +
        Returns the amount of blank parameters that need to be filled in. If + zero, then this query is ready to be used.
        +
        +
        Specified by:
        +
        getBlankParameterCount in interface Query<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(int value)
        +
        Description copied from interface: Query
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        +
        Specified by:
        +
        with in interface Query<S extends Storable>
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(long value)
        +
        Description copied from interface: Query
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        +
        Specified by:
        +
        with in interface Query<S extends Storable>
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(float value)
        +
        Description copied from interface: Query
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        +
        Specified by:
        +
        with in interface Query<S extends Storable>
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(double value)
        +
        Description copied from interface: Query
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        +
        Specified by:
        +
        with in interface Query<S extends Storable>
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(boolean value)
        +
        Description copied from interface: Query
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        +
        Specified by:
        +
        with in interface Query<S extends Storable>
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(char value)
        +
        Description copied from interface: Query
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        +
        Specified by:
        +
        with in interface Query<S extends Storable>
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(byte value)
        +
        Description copied from interface: Query
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        +
        Specified by:
        +
        with in interface Query<S extends Storable>
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(short value)
        +
        Description copied from interface: Query
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        +
        Specified by:
        +
        with in interface Query<S extends Storable>
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(java.lang.Object value)
        +
        Description copied from interface: Query
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        +
        Specified by:
        +
        with in interface Query<S extends Storable>
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        withValues

        +
        public Query<S> withValues(java.lang.Object... values)
        +
        Description copied from interface: Query
        +
        Returns a copy of this Query with the next blank parameters filled in.
        +
        +
        Specified by:
        +
        withValues in interface Query<S extends Storable>
        +
        Parameters:
        values - parameter values to fill in; if null or empty, this + Query instance is returned
        +
        • +
      + + + +
        +
      • +

        and

        +
        public Query<S> and(Filter<S> filter)
+                              throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a new query which has another filter logically "and"ed to this, potentially reducing the amount of + results.
        +
        +
        Specified by:
        +
        and in interface Query<S extends Storable>
        +
        Parameters:
        filter - query filter
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        or

        +
        public Query<S> or(Filter<S> filter)
+                             throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a new query which has another filter logically "or"ed to this, potentially increasing the amount of + results.
        +
        +
        Specified by:
        +
        or in interface Query<S extends Storable>
        +
        Parameters:
        filter - query filter
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        not

        +
        public Query<S> not()
+                              throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a new query which produces all the results not supplied in this + query. Any filled in parameters in this query are copied into the new + one.
        +
        +
        Specified by:
        +
        not in interface Query<S extends Storable>
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        orderBy

        +
        public Query<S> orderBy(java.lang.String property)
+                                  throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a copy of this query ordered by a specific property value. The + property name may be prefixed with '+' or '-' to indicate ascending or + descending order. If the prefix is omitted, ascending order is assumed. + +

        Note: Specification of ordering properties is not cumulative. Calling + this method will first remove any previous ordering properties.

        +
        +
        Specified by:
        +
        orderBy in interface Query<S extends Storable>
        +
        Parameters:
        property - name of property to order by
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        orderBy

        +
        public Query<S> orderBy(java.lang.String... properties)
+                                  throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a copy of this query ordered by specific property values. The + property names may be prefixed with '+' or '-' to indicate ascending or + descending order. If the prefix is omitted, ascending order is assumed. + +

        Note: Specification of ordering properties is not cumulative. Calling + this method will first remove any previous ordering properties.

        +
        +
        Specified by:
        +
        orderBy in interface Query<S extends Storable>
        +
        Parameters:
        properties - names of properties to order by
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + + + +
        +
      • +

        after

        +
        public <T extends S> Query<S> after(T start)
+                                throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a query which fetches results for this query after a given + starting point, which is useful for re-opening a cursor. This is only + effective when query has been given an explicit ordering. If not a total ordering, then query may start at an earlier + position. + +

        Note: The returned query can be very expensive to fetch from + repeatedly, if the query needs to perform a sort operation. Ideally, the + query ordering should match the natural ordering of an index or key.

        +
        +
        Specified by:
        +
        after in interface Query<S extends Storable>
        +
        Parameters:
        start - storable to attempt to start after; if null, this query is + returned
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        fetch

        +
        public Cursor<S> fetch()
+                                 throws FetchException
        +
        Description copied from interface: Query
        +
        Fetches results for this query. If any updates or deletes might be + performed on the results, consider enclosing the fetch in a + transaction. This allows the isolation level and "for update" mode to be + adjusted. Some repositories might otherwise deadlock.
        +
        +
        Specified by:
        +
        fetch in interface Query<S extends Storable>
        +
        Returns:
        fetch results
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        See Also:
        Repository.enterTransaction(IsolationLevel)
        +
        • +
      + + + +
        +
      • +

        fetch

        +
        public Cursor<S> fetch(Query.Controller controller)
+                                 throws FetchException
        +
        Description copied from interface: Query
        +
        Fetches results for this query. If any updates or deletes might be + performed on the results, consider enclosing the fetch in a + transaction. This allows the isolation level and "for update" mode to be + adjusted. Some repositories might otherwise deadlock.
        +
        +
        Specified by:
        +
        fetch in interface Query<S extends Storable>
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        fetch results
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        See Also:
        Repository.enterTransaction(IsolationLevel)
        +
        • +
      + + + +
        +
      • +

        fetchSlice

        +
        public Cursor<S> fetchSlice(long from,
+                   java.lang.Long to)
+                                      throws FetchException
        +
        Description copied from interface: Query
        +
        Fetches a slice of results for this query, as defined by a numerical + range. A slice can be used to limit the number of results from a + query. It is strongly recommended that the query be given a total ordering in order for the slice results to be deterministic.
        +
        +
        Specified by:
        +
        fetchSlice in interface Query<S extends Storable>
        +
        Parameters:
        from - zero-based from record number, inclusive
        to - optional zero-based to record number, exclusive
        +
        Returns:
        fetch results
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        fetchSlice

        +
        public Cursor<S> fetchSlice(long from,
+                   java.lang.Long to,
+                   Query.Controller controller)
+                                      throws FetchException
        +
        Description copied from interface: Query
        +
        Fetches a slice of results for this query, as defined by a numerical + range. A slice can be used to limit the number of results from a + query. It is strongly recommended that the query be given a total ordering in order for the slice results to be deterministic.
        +
        +
        Specified by:
        +
        fetchSlice in interface Query<S extends Storable>
        +
        Parameters:
        from - zero-based from record number, inclusive
        to - optional zero-based to record number, exclusive
        controller - optional controller which can abort query operation
        +
        Returns:
        fetch results
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        tryDeleteOne

        +
        public boolean tryDeleteOne()
+                     throws PersistException
        +
        Description copied from interface: Query
        +
        Deletes zero or one matching objects. If the number of matching records + exceeds one, then no delete occurs, and an exception is thrown instead.
        +
        +
        Specified by:
        +
        tryDeleteOne in interface Query<S extends Storable>
        +
        Returns:
        true if record existed and was deleted, or false if no match
        +
        Throws:
        +
        PersistMultipleException - if more than one record matches
        +
        PersistException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        tryDeleteOne

        +
        public boolean tryDeleteOne(Query.Controller controller)
+                     throws PersistException
        +
        Description copied from interface: Query
        +
        Deletes zero or one matching objects. If the number of matching records + exceeds one, then no delete occurs, and an exception is thrown instead.
        +
        +
        Specified by:
        +
        tryDeleteOne in interface Query<S extends Storable>
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        true if record existed and was deleted, or false if no match
        +
        Throws:
        +
        PersistMultipleException - if more than one record matches
        +
        PersistException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        deleteAll

        +
        public void deleteAll()
+               throws PersistException
        +
        Description copied from interface: Query
        +
        Deletes zero or more matching objects. There is no guarantee that + deleteAll is an atomic operation. If atomic behavior is desired, wrap + the call in a transaction scope.
        +
        +
        Specified by:
        +
        deleteAll in interface Query<S extends Storable>
        +
        Throws:
        +
        PersistException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        deleteAll

        +
        public void deleteAll(Query.Controller controller)
+               throws PersistException
        +
        Description copied from interface: Query
        +
        Deletes zero or more matching objects. There is no guarantee that + deleteAll is an atomic operation. If atomic behavior is desired, wrap + the call in a transaction scope.
        +
        +
        Specified by:
        +
        deleteAll in interface Query<S extends Storable>
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Throws:
        +
        PersistException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        count

        +
        public long count()
+           throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a count of all results matched by this query. Even though no + results are explicitly fetched, this method may still be expensive to + call. The actual performance will vary by repository and available indexes.
        +
        +
        Specified by:
        +
        count in interface Query<S extends Storable>
        +
        Returns:
        count of matches
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        count

        +
        public long count(Query.Controller controller)
+           throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a count of all results matched by this query. Even though no + results are explicitly fetched, this method may still be expensive to + call. The actual performance will vary by repository and available indexes.
        +
        +
        Specified by:
        +
        count in interface Query<S extends Storable>
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        count of matches
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public boolean exists()
+               throws FetchException
        +
        Description copied from interface: Query
        +
        Returns true if any results are matched by this query.
        +
        +
        Specified by:
        +
        exists in interface Query<S extends Storable>
        +
        Returns:
        true if any matches
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public boolean exists(Query.Controller controller)
+               throws FetchException
        +
        Description copied from interface: Query
        +
        Returns true if any results are matched by this query.
        +
        +
        Specified by:
        +
        exists in interface Query<S extends Storable>
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        true if any matches
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        printNative

        +
        public boolean printNative(java.lang.Appendable app,
+                  int indentLevel)
+                    throws java.io.IOException
        +
        Description copied from interface: Query
        +
        Prints the native query to any appendable, which is useful for + performance analysis. Not all repositories have a native query + format. An example native format is SQL.
        +
        +
        Specified by:
        +
        printNative in interface Query<S extends Storable>
        +
        Parameters:
        app - append results here
        indentLevel - amount to indent text, zero for none
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        printPlan

        +
        public boolean printPlan(java.lang.Appendable app,
+                int indentLevel)
+                  throws java.io.IOException
        +
        Description copied from interface: Query
        +
        Prints the query excecution plan to any appendable, which is useful for + performance analysis. There is no standard format for query plans, nor + is it a requirement that this method be implemented.
        +
        +
        Specified by:
        +
        printPlan in interface Query<S extends Storable>
        +
        Parameters:
        app - append results here
        indentLevel - amount to indent text, zero for none
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        appendTo

        +
        public void appendTo(java.lang.Appendable app)
+              throws java.io.IOException
        +
        Description copied from interface: Appender
        +
        Append the string representation of this object to the given Appendable.
        +
        +
        Specified by:
        +
        appendTo in interface Appender
        +
        Parameters:
        app - Appendable object to receive string representation
        +
        Throws:
        +
        java.io.IOException - if thrown from given Appendable
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        setExecutor

        +
        protected void setExecutor()
+                    throws RepositoryException
        +
        Ensures that a cached query executor reference is available. If not, the + query executor factory is called and the executor is cached.
        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        resetExecutor

        +
        protected void resetExecutor()
+                      throws RepositoryException
        +
        Resets any cached reference to a query executor. If a reference is + available, it is replaced, but a clear reference is not set.
        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        clearExecutor

        +
        protected void clearExecutor()
        +
        Clears any cached reference to a query executor. The next time this + Query is used, it will get an executor from the query executor factory + and cache a reference to it.
        +
        • +
      + + + +
        +
      • +

        enterTransaction

        +
        protected abstract Transaction enterTransaction(IsolationLevel level)
        +
        Enter a transaction as needed by the standard delete operation, or null + if transactions are not supported.
        +
        Parameters:
        level - minimum desired isolation level
        +
        • +
      + + + +
        +
      • +

        queryFactory

        +
        protected abstract QueryFactory<S> queryFactory()
        +
        Return a QueryFactory which is used to form new queries from this one.
        +
        • +
      + + + +
        +
      • +

        executorFactory

        +
        protected abstract QueryExecutorFactory<S> executorFactory()
        +
        Return a QueryExecutorFactory which is used to get an executor.
        +
        • +
      + + + +
        +
      • +

        newInstance

        +
        protected abstract StandardQuery<S> newInstance(FilterValues<S> values,
+                           OrderingList<S> ordering,
+                           QueryHints hints)
        +
        Return a new or cached instance of StandardQuery implementation, using + new filter values. The Filter in the FilterValues is the same as was + passed in the constructor.
        +
        Parameters:
        values - non-null values object
        ordering - order-by properties, never null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/StandardQueryFactory.html b/apidocs/com/amazon/carbonado/qe/StandardQueryFactory.html new file mode 100644 index 0000000..d26bbc1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/StandardQueryFactory.html @@ -0,0 +1,535 @@ + + + + + + +StandardQueryFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class StandardQueryFactory<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    QueryFactory<S>
    +
    +
    +
    Direct Known Subclasses:
    +
    QueryEngine
    +
    +
    +
    +
    public abstract class StandardQueryFactory<S extends Storable>
+extends java.lang.Object
+implements QueryFactory<S>
    +
    Builds and caches StandardQuery instances.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StandardQueryFactory

        +
        protected StandardQueryFactory(java.lang.Class<S> type)
        +
        • +
      + + + +
        +
      • +

        StandardQueryFactory

        +
        protected StandardQueryFactory(java.lang.Class<S> type,
+                    boolean lazySetExecutor)
        +
        Parameters:
        lazySetExecutor - by default, query executors are built and set + eagerly. Pass true to build and set executor on first query use.
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/StorableIndexSet.html b/apidocs/com/amazon/carbonado/qe/StorableIndexSet.html new file mode 100644 index 0000000..cfec807 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/StorableIndexSet.html @@ -0,0 +1,565 @@ + + + + + + +StorableIndexSet (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class StorableIndexSet<S extends Storable>

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidaddAlternateKeys(StorableInfo<S> info) +
      Adds all of the alternate keys of the given storable as indexes by + calling addKey.
      +
      voidaddIndexes(StorableInfo<S> info) +
      Adds all the indexes of the given storable.
      +
      voidaddIndexes(StorableInfo<S> info, + Direction defaultDirection) +
      Adds all the indexes of the given storable.
      +
      voidaddKey(StorableKey<S> key) +
      Adds the key as a unique index, preserving the property arrangement.
      +
      voidaddPrimaryKey(StorableInfo<S> info) +
      Adds the primary key of the given storable as indexes by calling addKey.
      +
      StorableIndex<S>findKeyIndex(StorableKey<S> key) +
      Finds the best index to represent the given key.
      +
      StorableIndex<S>findPrimaryKeyIndex(StorableInfo<S> info) +
      Finds the best index to represent the primary key.
      +
      voidmarkClustered(boolean clustered) +
      Marks all indexes as clustered or non-clustered.
      +
      voidreduce() +
      Reduces the size of the set by removing redundant indexes, and merges + others together.
      +
      voidreduce(Direction defaultDirection) +
      Reduces the size of the set by removing redundant indexes, and merges + others together.
      +
      voidsetDefaultDirection(Direction defaultDirection) +
      Set the default direction for all index properties.
      +
      voiduniquify(StorableInfo<S> info) +
      Augment non-unique indexes with primary key properties, thus making them + unique.
      +
      voiduniquify(StorableKey<S> key) +
      Augment non-unique indexes with key properties, thus making them unique.
      +
      +
        +
      • + + +

        Methods inherited from class java.util.TreeSet

        +add, addAll, ceiling, clear, clone, comparator, contains, descendingIterator, descendingSet, first, floor, headSet, headSet, higher, isEmpty, iterator, last, lower, pollFirst, pollLast, remove, size, subSet, subSet, tailSet, tailSet
        • +
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractSet

        +equals, hashCode, removeAll
        • +
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractCollection

        +containsAll, retainAll, toArray, toArray, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.Set

        +containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StorableIndexSet

        +
        public StorableIndexSet()
        +
        • +
      + + + +
        +
      • +

        StorableIndexSet

        +
        public StorableIndexSet(StorableIndexSet<S> set)
        +
        Copy constructor.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addIndexes

        +
        public void addIndexes(StorableInfo<S> info)
        +
        Adds all the indexes of the given storable.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if info is null
        +
        • +
      + + + +
        +
      • +

        addIndexes

        +
        public void addIndexes(StorableInfo<S> info,
+              Direction defaultDirection)
        +
        Adds all the indexes of the given storable.
        +
        Parameters:
        defaultDirection - default ordering direction to apply to each + index property
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any argument is null
        +
        • +
      + + + +
        +
      • +

        addAlternateKeys

        +
        public void addAlternateKeys(StorableInfo<S> info)
        +
        Adds all of the alternate keys of the given storable as indexes by + calling addKey.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if info is null
        +
        • +
      + + + +
        +
      • +

        addPrimaryKey

        +
        public void addPrimaryKey(StorableInfo<S> info)
        +
        Adds the primary key of the given storable as indexes by calling addKey. This method should not be called if the primary key + cannot be altered because persistent data is already stored against + it. Instead, the primary key index should be added as a normal index. + +

        After adding the primary key via this method and after reducing the + set, call findPrimaryKeyIndex to get the + best index to represent the primary key.

        +
        Throws:
        +
        java.lang.IllegalArgumentException - if info is null
        +
        • +
      + + + +
        +
      • +

        addKey

        +
        public void addKey(StorableKey<S> key)
        +
        Adds the key as a unique index, preserving the property arrangement.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if key is null
        +
        • +
      + + + +
        +
      • +

        reduce

        +
        public void reduce()
        +
        Reduces the size of the set by removing redundant indexes, and merges + others together.
        +
        • +
      + + + +
        +
      • +

        reduce

        +
        public void reduce(Direction defaultDirection)
        +
        Reduces the size of the set by removing redundant indexes, and merges + others together.
        +
        Parameters:
        defaultDirection - replace unspecified property directions with this
        +
        • +
      + + + +
        +
      • +

        setDefaultDirection

        +
        public void setDefaultDirection(Direction defaultDirection)
        +
        Set the default direction for all index properties.
        +
        Parameters:
        defaultDirection - replace unspecified property directions with this
        +
        • +
      + + + +
        +
      • +

        markClustered

        +
        public void markClustered(boolean clustered)
        +
        Marks all indexes as clustered or non-clustered.
        +
        Parameters:
        clustered - true to mark clustered; false to mark non-clustered
        Since:
        +
        1.2
        +
        See Also:
        StorableIndex.isClustered()
        +
        • +
      + + + +
        +
      • +

        uniquify

        +
        public void uniquify(StorableInfo<S> info)
        +
        Augment non-unique indexes with primary key properties, thus making them + unique.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if info is null
        +
        • +
      + + + +
        +
      • +

        uniquify

        +
        public void uniquify(StorableKey<S> key)
        +
        Augment non-unique indexes with key properties, thus making them unique.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if key is null
        +
        • +
      + + + +
        +
      • +

        findPrimaryKeyIndex

        +
        public StorableIndex<S> findPrimaryKeyIndex(StorableInfo<S> info)
        +
        Finds the best index to represent the primary key. Should be called + after calling reduce. As long as the primary key was added via addPrimaryKey, this method should never return null.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if info is null
        +
        • +
      + + + +
        +
      • +

        findKeyIndex

        +
        public StorableIndex<S> findKeyIndex(StorableKey<S> key)
        +
        Finds the best index to represent the given key. Should be called after + calling reduce. As long as the key was added via addKey, + this method should never return null.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if key is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/StorageAccess.html b/apidocs/com/amazon/carbonado/qe/StorageAccess.html new file mode 100644 index 0000000..affde1f --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/StorageAccess.html @@ -0,0 +1,305 @@ + + + + + + +StorageAccess (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Interface StorageAccess<S extends Storable>

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getQueryExecutorFactory

        +
        QueryExecutorFactory<S> getQueryExecutorFactory()
        +
        Returns a QueryExecutorFactory instance for storage.
        +
        • +
      + + + +
        +
      • +

        getAllIndexes

        +
        java.util.Collection<StorableIndex<S>> getAllIndexes()
        +
        Returns all the available indexes.
        +
        • +
      + + + +
        +
      • +

        storageDelegate

        +
        Storage<S> storageDelegate(StorableIndex<S> index)
        +
        If the given index is not directly supported by storage, queries should + be delegated. Return the storage to delegate to or null if index should + not be delegated.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if index is unknown
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html b/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html new file mode 100644 index 0000000..faf0d05 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html @@ -0,0 +1,271 @@ + + + + + + +UnionQueryAnalyzer.Result (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class UnionQueryAnalyzer.Result

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    UnionQueryAnalyzer<S extends Storable>
    +
    +
    +
    +
    public class UnionQueryAnalyzer.Result
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      QueryExecutor<S>createExecutor() +
      Creates a QueryExecutor based on this result.
      +
      java.util.List<IndexedQueryAnalyzer.Result>getSubResults() +
      Returns results for each sub-query to be executed in the union.
      +
      OrderingList<S>getTotalOrdering() +
      Returns a total ordering, if one was imposed.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.html b/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.html new file mode 100644 index 0000000..e797763 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.html @@ -0,0 +1,350 @@ + + + + + + +UnionQueryAnalyzer (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class UnionQueryAnalyzer<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    QueryExecutorFactory<S>
    +
    +
    +
    +
    public class UnionQueryAnalyzer<S extends Storable>
+extends java.lang.Object
+implements QueryExecutorFactory<S>
    +
    Analyzes a query specification and determines how it can be executed as a + union of smaller queries. If necessary, the UnionQueryAnalyzer will alter + the query slightly, imposing a total ordering. Internally, an IndexedQueryAnalyzer is used for selecting the best indexes. + +

    UnionQueryAnalyzer is sharable and thread-safe. An instance for a + particular Storable type can be cached, avoiding repeated construction + cost. In addition, the analyzer caches learned foreign indexes.

    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/UnionQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/UnionQueryExecutor.html new file mode 100644 index 0000000..222a230 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/UnionQueryExecutor.html @@ -0,0 +1,434 @@ + + + + + + +UnionQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class UnionQueryExecutor<S extends Storable>

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        UnionQueryExecutor

        +
        public UnionQueryExecutor(QueryExecutor<S>... executors)
        +
        Parameters:
        executors - executors to wrap, each must have the exact same total ordering
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any parameter is null or if ordering doesn't match
        +
        • +
      + + + +
        +
      • +

        UnionQueryExecutor

        +
        public UnionQueryExecutor(java.util.List<QueryExecutor<S>> executors)
        +
        Parameters:
        executors - executors to wrap, each must have the exact same total ordering
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any executors is null or if ordering doesn't match
        +
        • +
      + + + +
        +
      • +

        UnionQueryExecutor

        +
        public UnionQueryExecutor(java.util.List<QueryExecutor<S>> executors,
+                  OrderingList<S> totalOrdering)
        +
        Parameters:
        executors - executors to wrap, each must have the exact same total ordering
        totalOrdering - effective total ordering of executors
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if executors is null
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        getFilter

        +
        public Filter<S> getFilter()
        +
        Returns the combined filter of the wrapped executors.
        +
        Returns:
        query filter, never null
        +
        • +
      + + + +
        +
      • +

        getOrdering

        +
        public OrderingList<S> getOrdering()
        +
        Description copied from interface: QueryExecutor
        +
        Returns the result ordering of this QueryExecutor.
        +
        Returns:
        query ordering in an unmodifiable list
        +
        • +
      + + + +
        +
      • +

        printNative

        +
        public boolean printNative(java.lang.Appendable app,
+                  int indentLevel,
+                  FilterValues<S> values)
+                    throws java.io.IOException
        +
        Prints native queries of the wrapped executors.
        +
        +
        Specified by:
        +
        printNative in interface QueryExecutor<S extends Storable>
        +
        Overrides:
        +
        printNative in class AbstractQueryExecutor<S extends Storable>
        +
        values - optional
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        printPlan

        +
        public boolean printPlan(java.lang.Appendable app,
+                int indentLevel,
+                FilterValues<S> values)
+                  throws java.io.IOException
        +
        Description copied from interface: QueryExecutor
        +
        Prints the query plan to any appendable, if applicable.
        +
        values - optional
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.qe.AbstractQuery

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

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

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

Uses of Class
com.amazon.carbonado.qe.AbstractQueryExecutor

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

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

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

Uses of Class
com.amazon.carbonado.qe.BoundaryType

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/CompositeScore.html b/apidocs/com/amazon/carbonado/qe/class-use/CompositeScore.html new file mode 100644 index 0000000..02be73d --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/CompositeScore.html @@ -0,0 +1,275 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.CompositeScore (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.CompositeScore

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

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

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

Uses of Class
com.amazon.carbonado.qe.DelegatedQueryExecutor

+
+
No usage of com.amazon.carbonado.qe.DelegatedQueryExecutor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.qe.DelegatedQueryExecutorFactory

+
+
No usage of com.amazon.carbonado.qe.DelegatedQueryExecutorFactory
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.qe.EmptyQuery

+
+
No usage of com.amazon.carbonado.qe.EmptyQuery
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.qe.FilteredQueryExecutor

+
+
No usage of com.amazon.carbonado.qe.FilteredQueryExecutor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.qe.FilteringScore

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.Support.html new file mode 100644 index 0000000..68b5038 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.Support.html @@ -0,0 +1,173 @@ + + + + + + +Uses of Interface com.amazon.carbonado.qe.FullScanQueryExecutor.Support (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.qe.FullScanQueryExecutor.Support

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

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

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

Uses of Class
com.amazon.carbonado.qe.FullScanQueryExecutor

+
+
No usage of com.amazon.carbonado.qe.FullScanQueryExecutor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.Result.html b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.Result.html new file mode 100644 index 0000000..ec724a1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.Result.html @@ -0,0 +1,225 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result

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

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

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

Uses of Class
com.amazon.carbonado.qe.IndexedQueryAnalyzer

+
+
No usage of com.amazon.carbonado.qe.IndexedQueryAnalyzer
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.Support.html new file mode 100644 index 0000000..da34597 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.Support.html @@ -0,0 +1,175 @@ + + + + + + +Uses of Interface com.amazon.carbonado.qe.IndexedQueryExecutor.Support (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.qe.IndexedQueryExecutor.Support

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

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

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

Uses of Class
com.amazon.carbonado.qe.IndexedQueryExecutor

+
+
No usage of com.amazon.carbonado.qe.IndexedQueryExecutor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.qe.IterableQueryExecutor

+
+
No usage of com.amazon.carbonado.qe.IterableQueryExecutor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.qe.JoinedQueryExecutor

+
+
No usage of com.amazon.carbonado.qe.JoinedQueryExecutor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.Support.html new file mode 100644 index 0000000..4007aa1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.Support.html @@ -0,0 +1,175 @@ + + + + + + +Uses of Interface com.amazon.carbonado.qe.KeyQueryExecutor.Support (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.qe.KeyQueryExecutor.Support

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

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

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

Uses of Class
com.amazon.carbonado.qe.KeyQueryExecutor

+
+
No usage of com.amazon.carbonado.qe.KeyQueryExecutor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/OrderingList.html b/apidocs/com/amazon/carbonado/qe/class-use/OrderingList.html new file mode 100644 index 0000000..87365a3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/OrderingList.html @@ -0,0 +1,577 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.OrderingList (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.OrderingList

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/OrderingScore.html b/apidocs/com/amazon/carbonado/qe/class-use/OrderingScore.html new file mode 100644 index 0000000..6d59339 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/OrderingScore.html @@ -0,0 +1,226 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.OrderingScore (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.OrderingScore

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

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

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

Uses of Class
com.amazon.carbonado.qe.QueryEngine

+
+
No usage of com.amazon.carbonado.qe.QueryEngine
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutor.html new file mode 100644 index 0000000..2a62831 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutor.html @@ -0,0 +1,331 @@ + + + + + + +Uses of Interface com.amazon.carbonado.qe.QueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.qe.QueryExecutor

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

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

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

Uses of Class
com.amazon.carbonado.qe.QueryExecutorCache

+
+
No usage of com.amazon.carbonado.qe.QueryExecutorCache
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Interface
com.amazon.carbonado.qe.QueryExecutorFactory

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryFactory.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryFactory.html new file mode 100644 index 0000000..398b758 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryFactory.html @@ -0,0 +1,202 @@ + + + + + + +Uses of Interface com.amazon.carbonado.qe.QueryFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.qe.QueryFactory

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryHint.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryHint.html new file mode 100644 index 0000000..6e78e09 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryHint.html @@ -0,0 +1,208 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.QueryHint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.QueryHint

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

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

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

Uses of Class
com.amazon.carbonado.qe.QueryHints

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

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

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

Uses of Interface
com.amazon.carbonado.qe.RepositoryAccess

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

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

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

Uses of Class
com.amazon.carbonado.qe.SortedQueryExecutor.ArraySortSupport

+
+
No usage of com.amazon.carbonado.qe.SortedQueryExecutor.ArraySortSupport
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.qe.SortedQueryExecutor.MergeSortSupport

+
+
No usage of com.amazon.carbonado.qe.SortedQueryExecutor.MergeSortSupport
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.Support.html new file mode 100644 index 0000000..5551e27 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.Support.html @@ -0,0 +1,193 @@ + + + + + + +Uses of Interface com.amazon.carbonado.qe.SortedQueryExecutor.Support (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.qe.SortedQueryExecutor.Support

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

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

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

Uses of Class
com.amazon.carbonado.qe.SortedQueryExecutor

+
+
No usage of com.amazon.carbonado.qe.SortedQueryExecutor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/StandardQuery.html b/apidocs/com/amazon/carbonado/qe/class-use/StandardQuery.html new file mode 100644 index 0000000..2daf639 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/StandardQuery.html @@ -0,0 +1,180 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.StandardQuery (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.StandardQuery

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

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

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

Uses of Class
com.amazon.carbonado.qe.StandardQueryFactory

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/StorableIndexSet.html b/apidocs/com/amazon/carbonado/qe/class-use/StorableIndexSet.html new file mode 100644 index 0000000..5de3c10 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/StorableIndexSet.html @@ -0,0 +1,159 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.StorableIndexSet (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.StorableIndexSet

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

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

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

Uses of Interface
com.amazon.carbonado.qe.StorageAccess

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

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

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

Uses of Class
com.amazon.carbonado.qe.UnionQueryAnalyzer.Result

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

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

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

Uses of Class
com.amazon.carbonado.qe.UnionQueryAnalyzer

+
+
No usage of com.amazon.carbonado.qe.UnionQueryAnalyzer
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.qe.UnionQueryExecutor

+
+
No usage of com.amazon.carbonado.qe.UnionQueryExecutor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/package-frame.html b/apidocs/com/amazon/carbonado/qe/package-frame.html new file mode 100644 index 0000000..e951eaa --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/package-frame.html @@ -0,0 +1,63 @@ + + + + + + +com.amazon.carbonado.qe (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.qe

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/qe/package-summary.html b/apidocs/com/amazon/carbonado/qe/package-summary.html new file mode 100644 index 0000000..94c9d2e --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/package-summary.html @@ -0,0 +1,398 @@ + + + + + + +com.amazon.carbonado.qe (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.qe

+
+
Support for implementing a Query Engine.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.qe Description

+
Support for implementing a Query Engine. Repositories are free to use this + package to aid in their implementation, but user-level applications have no + need to use this package.
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/package-tree.html b/apidocs/com/amazon/carbonado/qe/package-tree.html new file mode 100644 index 0000000..a256965 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/package-tree.html @@ -0,0 +1,223 @@ + + + + + + +com.amazon.carbonado.qe Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.qe

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/package-use.html b/apidocs/com/amazon/carbonado/qe/package-use.html new file mode 100644 index 0000000..d198fbe --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/package-use.html @@ -0,0 +1,265 @@ + + + + + + +Uses of Package com.amazon.carbonado.qe (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.qe

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/CompressedEncodingStrategy.html b/apidocs/com/amazon/carbonado/raw/CompressedEncodingStrategy.html new file mode 100644 index 0000000..93dedfd --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/CompressedEncodingStrategy.html @@ -0,0 +1,352 @@ + + + + + + +CompressedEncodingStrategy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class CompressedEncodingStrategy<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public class CompressedEncodingStrategy<S extends Storable>
+extends GenericEncodingStrategy<S>
    +
    Extension of GenericEncodingStrategy that allows for compression.
    +
    Author:
    +
    Olga Kuznetsova, Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CompressedEncodingStrategy

        +
        public CompressedEncodingStrategy(java.lang.Class<S> type,
+                          StorableIndex<S> pkIndex,
+                          CompressionType compressionType)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        extraDataEncoding

        +
        protected void extraDataEncoding(org.cojen.classfile.CodeAssembler a,
+                     org.cojen.classfile.LocalVariable dataVar,
+                     int prefix,
+                     int suffix)
        +
        Description copied from class: GenericEncodingStrategy
        +
        Second phase encoding, which does nothing by default.
        +
        +
        Overrides:
        +
        extraDataEncoding in class GenericEncodingStrategy<S extends Storable>
        +
        dataVar - local variable referencing a byte array with data
        prefix - prefix of byte array to preserve
        suffix - suffix of byte array to preserve
        +
        • +
      + + + +
        +
      • +

        extraDataDecoding

        +
        protected void extraDataDecoding(org.cojen.classfile.CodeAssembler a,
+                     org.cojen.classfile.LocalVariable dataVar,
+                     int prefix,
+                     int suffix)
        +
        Description copied from class: GenericEncodingStrategy
        +
        Second phase decoding, which does nothing by default.
        +
        +
        Overrides:
        +
        extraDataDecoding in class GenericEncodingStrategy<S extends Storable>
        +
        dataVar - local variable referencing a byte array with data
        +
        • +
      + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/CompressedStorableCodecFactory.html b/apidocs/com/amazon/carbonado/raw/CompressedStorableCodecFactory.html new file mode 100644 index 0000000..f456422 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/CompressedStorableCodecFactory.html @@ -0,0 +1,329 @@ + + + + + + +CompressedStorableCodecFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class CompressedStorableCodecFactory

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    StorableCodecFactory
    +
    +
    +
    +
    public class CompressedStorableCodecFactory
+extends GenericStorableCodecFactory
    +
    Extension of GenericStorableCodecFactory that allows for compression.
    +
    Author:
    +
    Olga Kuznetsova, Brian S O'Neill
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/CompressionType.html b/apidocs/com/amazon/carbonado/raw/CompressionType.html new file mode 100644 index 0000000..2c5c5f3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/CompressionType.html @@ -0,0 +1,332 @@ + + + + + + +CompressionType (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Enum CompressionType

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<CompressionType>
    +
    +
    +
    +
    public enum CompressionType
+extends java.lang.Enum<CompressionType>
    +
    Available compression types for any particular storable.
    +
    Author:
    +
    Olga Kuznetsova
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      GZIP +
      Gzip compression.
      +
      NONE +
      No compression.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static CompressionTypevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static CompressionType[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static CompressionType[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (CompressionType c : CompressionType.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in +the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static CompressionType valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html b/apidocs/com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html new file mode 100644 index 0000000..14fe739 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html @@ -0,0 +1,236 @@ + + + + + + +CustomStorableCodec.InstanceFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Interface CustomStorableCodec.InstanceFactory

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/CustomStorableCodec.html b/apidocs/com/amazon/carbonado/raw/CustomStorableCodec.html new file mode 100644 index 0000000..ee55d20 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/CustomStorableCodec.html @@ -0,0 +1,603 @@ + + + + + + +CustomStorableCodec (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class CustomStorableCodec<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    StorableCodec<S>
    +
    +
    +
    +
    public abstract class CustomStorableCodec<S extends Storable>
+extends java.lang.Object
+implements StorableCodec<S>
    +
    Allows codecs to be defined for storables that have a custom encoding.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    CustomStorableCodecFactory
    +
    • +
+
+
+
    +
  • + + + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      StorableIndex<S>buildPkIndex(java.lang.String... propertyNames) +
      Convenient way to define the clustered primary key index + descriptor.
      +
      abstract voiddecodeData(S storable, + byte[] bytes) +
      Decode the data into properties of the storable.
      +
      abstract voiddecodePrimaryKey(S storable, + byte[] bytes) +
      Decode the primary key into properties of the storable.
      +
      abstract byte[]encodeData(S storable) +
      Encode all properties of the storable excluding the primary key.
      +
      byte[]encodePrimaryKey(java.lang.Object[] values) +
      Encode a key by extracting all the primary key properties from the given + storable.
      +
      byte[]encodePrimaryKey(S storable) +
      Encode a key by extracting all the primary key properties from the given + storable.
      +
      java.util.Map<java.lang.String,? extends StorableProperty<S>>getAllProperties() +
      Convenient access to all the storable properties.
      +
      java.lang.Class<S>getStorableType() +
      Returns the type of Storable produced by this codec.
      +
      RawSupport<S>getSupport() +
      Returns the default RawSupport object that is supplied to + Storable instances produced by this codec.
      +
      Sinstantiate() +
      Instantiate a Storable with no key or value defined yet.
      +
      Sinstantiate(byte[] key, + byte[] value) +
      Instantiate a Storable with a specific key and value.
      +
      Sinstantiate(RawSupport<S> support) +
      Instantiate a Storable with no key or value defined yet.
      +
      Sinstantiate(RawSupport<S> support, + byte[] key, + byte[] value) +
      Instantiate a Storable with a specific key and value.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CustomStorableCodec

        +
        public CustomStorableCodec(java.lang.Class<S> type,
+                   boolean isMaster)
+                    throws SupportException
        +
        Parameters:
        isMaster - when true, version properties and sequences are managed
        +
        Throws:
        +
        SupportException - if Storable is not supported
        +
        • +
      + + + +
        +
      • +

        CustomStorableCodec

        +
        public CustomStorableCodec(java.lang.Class<S> type,
+                   boolean isMaster,
+                   RawSupport<S> support)
+                    throws SupportException
        +
        Parameters:
        isMaster - when true, version properties and sequences are managed
        +
        Throws:
        +
        SupportException - if Storable is not supported
        Since:
        +
        1.2
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStorableType

        +
        public java.lang.Class<S> getStorableType()
        +
        Description copied from interface: StorableCodec
        +
        Returns the type of Storable produced by this codec.
        +
        +
        Specified by:
        +
        getStorableType in interface StorableCodec<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        instantiate

        +
        public S instantiate()
        +
        Description copied from interface: StorableCodec
        +
        Instantiate a Storable with no key or value defined yet. The default + RawSupport is supplied to the instance.
        +
        +
        Specified by:
        +
        instantiate in interface StorableCodec<S extends Storable>
        +
        Since:
        +
        1.2
        +
        • +
      + + + + + + + +
        +
      • +

        instantiate

        +
        public S instantiate(RawSupport<S> support)
        +
        Description copied from interface: StorableCodec
        +
        Instantiate a Storable with no key or value defined yet. Any + RawSupport can be supplied to the instance.
        +
        +
        Specified by:
        +
        instantiate in interface StorableCodec<S extends Storable>
        +
        Parameters:
        support - binds generated storable with a storage layer
        +
        • +
      + + + + + + + + + +
        +
      • +

        encodePrimaryKey

        +
        public byte[] encodePrimaryKey(S storable)
        +
        Description copied from interface: StorableCodec
        +
        Encode a key by extracting all the primary key properties from the given + storable.
        +
        +
        Specified by:
        +
        encodePrimaryKey in interface StorableCodec<S extends Storable>
        +
        Parameters:
        storable - extract primary key properties from this instance
        +
        Returns:
        raw search key
        +
        • +
      + + + +
        +
      • +

        encodePrimaryKey

        +
        public byte[] encodePrimaryKey(java.lang.Object[] values)
        +
        Description copied from interface: StorableCodec
        +
        Encode a key by extracting all the primary key properties from the given + storable.
        +
        +
        Specified by:
        +
        encodePrimaryKey in interface StorableCodec<S extends Storable>
        +
        Parameters:
        values - values to build into a key. It must be long enough to + accommodate all primary key properties.
        +
        Returns:
        raw search key
        +
        • +
      + + + + + + + +
        +
      • +

        getAllProperties

        +
        public java.util.Map<java.lang.String,? extends StorableProperty<S>> getAllProperties()
        +
        Convenient access to all the storable properties.
        +
        • +
      + + + +
        +
      • +

        buildPkIndex

        +
        public StorableIndex<S> buildPkIndex(java.lang.String... propertyNames)
        +
        Convenient way to define the clustered primary key index + descriptor. Direction can be specified by prefixing the property name + with a '+' or '-'. If unspecified, direction is assumed to be ascending.
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        encodeData

        +
        public abstract byte[] encodeData(S storable)
        +
        Encode all properties of the storable excluding the primary key.
        +
        • +
      + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/CustomStorableCodecFactory.html b/apidocs/com/amazon/carbonado/raw/CustomStorableCodecFactory.html new file mode 100644 index 0000000..a5a6d9b --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/CustomStorableCodecFactory.html @@ -0,0 +1,386 @@ + + + + + + +CustomStorableCodecFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class CustomStorableCodecFactory

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    StorableCodecFactory
    +
    +
    +
    +
    public abstract class CustomStorableCodecFactory
+extends java.lang.Object
+implements StorableCodecFactory
    +
    Factory for custom storable codecs.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CustomStorableCodecFactory

        +
        public CustomStorableCodecFactory()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        createCodec

        +
        public <S extends Storable> CustomStorableCodec<S> createCodec(java.lang.Class<S> type,
+                                                      StorableIndex pkIndex,
+                                                      boolean isMaster,
+                                                      Layout layout)
+                                                    throws SupportException
        +
        +
        Specified by:
        +
        createCodec in interface StorableCodecFactory
        +
        Parameters:
        type - type of storable to create codec for
        pkIndex - ignored
        isMaster - when true, version properties and sequences are managed
        layout - when non-null, attempt to encode a storable layout + generation value in each storable
        +
        Throws:
        +
        SupportException - if type is not supported
        +
        • +
      + + + +
        +
      • +

        createCodec

        +
        public <S extends Storable> CustomStorableCodec<S> createCodec(java.lang.Class<S> type,
+                                                      StorableIndex pkIndex,
+                                                      boolean isMaster,
+                                                      Layout layout,
+                                                      RawSupport support)
+                                                    throws SupportException
        +
        +
        Specified by:
        +
        createCodec in interface StorableCodecFactory
        +
        Parameters:
        type - type of storable to create codec for
        pkIndex - ignored
        isMaster - when true, version properties and sequences are managed
        layout - when non-null, attempt to encode a storable layout + generation value in each storable
        support - binds generated storable with a storage layer
        +
        Throws:
        +
        SupportException - if type is not supported
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        createCodec

        +
        protected abstract <S extends Storable> CustomStorableCodec<S> createCodec(java.lang.Class<S> type,
+                                                      boolean isMaster,
+                                                      Layout layout)
+                                                                throws SupportException
        +
        Parameters:
        type - type of storable to create codec for
        isMaster - when true, version properties and sequences are managed
        layout - when non-null, attempt to encode a storable layout + generation value in each storable
        +
        Throws:
        +
        SupportException - if type is not supported
        +
        • +
      + + + +
        +
      • +

        createCodec

        +
        protected <S extends Storable> CustomStorableCodec<S> createCodec(java.lang.Class<S> type,
+                                                      boolean isMaster,
+                                                      Layout layout,
+                                                      RawSupport support)
+                                                       throws SupportException
        +
        Parameters:
        type - type of storable to create codec for
        isMaster - when true, version properties and sequences are managed
        layout - when non-null, attempt to encode a storable layout + generation value in each storable
        support - binds generated storable with a storage layer
        +
        Throws:
        +
        SupportException - if type is not supported
        Since:
        +
        1.2
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/DataDecoder.html b/apidocs/com/amazon/carbonado/raw/DataDecoder.html new file mode 100644 index 0000000..d9c7e29 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/DataDecoder.html @@ -0,0 +1,879 @@ + + + + + + +DataDecoder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class DataDecoder

+
+
+ +
+
    +
  • +
    +
    +
    public class DataDecoder
+extends java.lang.Object
    +
    A very low-level class that decodes key components encoded by methods of + DataEncoder.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    KeyDecoder
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      DataDecoder() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static intdecode(byte[] src, + int srcOffset, + java.math.BigDecimal[] valueRef) +
      Decodes a BigDecimal.
      +
      static intdecode(byte[] src, + int srcOffset, + java.math.BigInteger[] valueRef) +
      Decodes a BigInteger.
      +
      static intdecode(byte[] src, + int srcOffset, + byte[][] valueRef) +
      Decodes the given byte array.
      +
      static booleandecodeBoolean(byte[] src, + int srcOffset) +
      Decodes a boolean from exactly 1 byte.
      +
      static java.lang.BooleandecodeBooleanObj(byte[] src, + int srcOffset) +
      Decodes a Boolean object from exactly 1 byte.
      +
      static bytedecodeByte(byte[] src, + int srcOffset) +
      Decodes a signed byte from exactly 1 byte.
      +
      static java.lang.BytedecodeByteObj(byte[] src, + int srcOffset) +
      Decodes a signed Byte object from exactly 1 or 2 bytes.
      +
      static chardecodeChar(byte[] src, + int srcOffset) +
      Decodes a char from exactly 2 bytes.
      +
      static java.lang.CharacterdecodeCharacterObj(byte[] src, + int srcOffset) +
      Decodes a Character object from exactly 1 or 3 bytes.
      +
      static doubledecodeDouble(byte[] src, + int srcOffset) +
      Decodes a double from exactly 8 bytes.
      +
      protected static longdecodeDoubleBits(byte[] src, + int srcOffset) 
      static java.lang.DoubledecodeDoubleObj(byte[] src, + int srcOffset) +
      Decodes a Double object from exactly 8 bytes.
      +
      static floatdecodeFloat(byte[] src, + int srcOffset) +
      Decodes a float from exactly 4 bytes.
      +
      protected static intdecodeFloatBits(byte[] src, + int srcOffset) 
      static java.lang.FloatdecodeFloatObj(byte[] src, + int srcOffset) +
      Decodes a Float object from exactly 4 bytes.
      +
      static intdecodeInt(byte[] src, + int srcOffset) +
      Decodes a signed integer from exactly 4 bytes.
      +
      static java.lang.IntegerdecodeIntegerObj(byte[] src, + int srcOffset) +
      Decodes a signed Integer object from exactly 1 or 5 bytes.
      +
      static longdecodeLong(byte[] src, + int srcOffset) +
      Decodes a signed long from exactly 8 bytes.
      +
      static java.lang.LongdecodeLongObj(byte[] src, + int srcOffset) +
      Decodes a signed Long object from exactly 1 or 9 bytes.
      +
      static shortdecodeShort(byte[] src, + int srcOffset) +
      Decodes a signed short from exactly 2 bytes.
      +
      static java.lang.ShortdecodeShortObj(byte[] src, + int srcOffset) +
      Decodes a signed Short object from exactly 1 or 3 bytes.
      +
      static byte[]decodeSingle(byte[] src, + int prefixPadding, + int suffixPadding) +
      Decodes the given byte array which was encoded by DataEncoder.encodeSingle(byte[], int, int).
      +
      static byte[]decodeSingleNullable(byte[] src) +
      Decodes the given byte array which was encoded by DataEncoder.encodeSingleNullable(byte[]).
      +
      static byte[]decodeSingleNullable(byte[] src, + int prefixPadding, + int suffixPadding) +
      Decodes the given byte array which was encoded by DataEncoder.encodeSingleNullable(byte[]).
      +
      static intdecodeString(byte[] src, + int srcOffset, + java.lang.String[] valueRef) +
      Decodes an encoded string from the given byte array.
      +
      static voidreadFully(java.io.InputStream in, + byte[] b) +
      Reads as many bytes from the stream as is necessary to fill the given + byte array.
      +
      static intreadLength(java.io.InputStream in) +
      Decodes a length value which was encoded by DataEncoder.writeLength(int, java.io.OutputStream).
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DataDecoder

        +
        public DataDecoder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        decodeInt

        +
        public static int decodeInt(byte[] src,
+            int srcOffset)
+                     throws CorruptEncodingException
        +
        Decodes a signed integer from exactly 4 bytes.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed integer value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeIntegerObj

        +
        public static java.lang.Integer decodeIntegerObj(byte[] src,
+                                 int srcOffset)
+                                          throws CorruptEncodingException
        +
        Decodes a signed Integer object from exactly 1 or 5 bytes. If null is + returned, then 1 byte was read.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed Integer object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeLong

        +
        public static long decodeLong(byte[] src,
+              int srcOffset)
+                       throws CorruptEncodingException
        +
        Decodes a signed long from exactly 8 bytes.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed long value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeLongObj

        +
        public static java.lang.Long decodeLongObj(byte[] src,
+                           int srcOffset)
+                                    throws CorruptEncodingException
        +
        Decodes a signed Long object from exactly 1 or 9 bytes. If null is + returned, then 1 byte was read.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed Long object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeByte

        +
        public static byte decodeByte(byte[] src,
+              int srcOffset)
+                       throws CorruptEncodingException
        +
        Decodes a signed byte from exactly 1 byte.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed byte value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeByteObj

        +
        public static java.lang.Byte decodeByteObj(byte[] src,
+                           int srcOffset)
+                                    throws CorruptEncodingException
        +
        Decodes a signed Byte object from exactly 1 or 2 bytes. If null is + returned, then 1 byte was read.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed Byte object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeShort

        +
        public static short decodeShort(byte[] src,
+                int srcOffset)
+                         throws CorruptEncodingException
        +
        Decodes a signed short from exactly 2 bytes.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed short value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeShortObj

        +
        public static java.lang.Short decodeShortObj(byte[] src,
+                             int srcOffset)
+                                      throws CorruptEncodingException
        +
        Decodes a signed Short object from exactly 1 or 3 bytes. If null is + returned, then 1 byte was read.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed Short object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeChar

        +
        public static char decodeChar(byte[] src,
+              int srcOffset)
+                       throws CorruptEncodingException
        +
        Decodes a char from exactly 2 bytes.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        char value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeCharacterObj

        +
        public static java.lang.Character decodeCharacterObj(byte[] src,
+                                     int srcOffset)
+                                              throws CorruptEncodingException
        +
        Decodes a Character object from exactly 1 or 3 bytes. If null is + returned, then 1 byte was read.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        Character object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeBoolean

        +
        public static boolean decodeBoolean(byte[] src,
+                    int srcOffset)
+                             throws CorruptEncodingException
        +
        Decodes a boolean from exactly 1 byte.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        boolean value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeBooleanObj

        +
        public static java.lang.Boolean decodeBooleanObj(byte[] src,
+                                 int srcOffset)
+                                          throws CorruptEncodingException
        +
        Decodes a Boolean object from exactly 1 byte.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        Boolean object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeFloat

        +
        public static float decodeFloat(byte[] src,
+                int srcOffset)
+                         throws CorruptEncodingException
        +
        Decodes a float from exactly 4 bytes.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        float value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeFloatObj

        +
        public static java.lang.Float decodeFloatObj(byte[] src,
+                             int srcOffset)
+                                      throws CorruptEncodingException
        +
        Decodes a Float object from exactly 4 bytes.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        Float object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + + + + + +
        +
      • +

        decodeDouble

        +
        public static double decodeDouble(byte[] src,
+                  int srcOffset)
+                           throws CorruptEncodingException
        +
        Decodes a double from exactly 8 bytes.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        double value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeDoubleObj

        +
        public static java.lang.Double decodeDoubleObj(byte[] src,
+                               int srcOffset)
+                                        throws CorruptEncodingException
        +
        Decodes a Double object from exactly 8 bytes.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        Double object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + + + + + +
        +
      • +

        decode

        +
        public static int decode(byte[] src,
+         int srcOffset,
+         java.math.BigInteger[] valueRef)
+                  throws CorruptEncodingException
        +
        Decodes a BigInteger.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded BigInteger is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        decode

        +
        public static int decode(byte[] src,
+         int srcOffset,
+         java.math.BigDecimal[] valueRef)
+                  throws CorruptEncodingException
        +
        Decodes a BigDecimal.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded BigDecimal is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        decode

        +
        public static int decode(byte[] src,
+         int srcOffset,
+         byte[][] valueRef)
+                  throws CorruptEncodingException
        +
        Decodes the given byte array.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded byte array is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        +
        • +
      + + + +
        +
      • +

        decodeString

        +
        public static int decodeString(byte[] src,
+               int srcOffset,
+               java.lang.String[] valueRef)
+                        throws CorruptEncodingException
        +
        Decodes an encoded string from the given byte array.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded string is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        +
        • +
      + + + +
        +
      • +

        readLength

        +
        public static int readLength(java.io.InputStream in)
+                      throws java.io.IOException,
+                             java.io.EOFException
        +
        Decodes a length value which was encoded by DataEncoder.writeLength(int, java.io.OutputStream).
        +
        Returns:
        length value
        +
        Throws:
        +
        java.io.IOException
        +
        java.io.EOFException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        readFully

        +
        public static void readFully(java.io.InputStream in,
+             byte[] b)
+                      throws java.io.IOException,
+                             java.io.EOFException
        +
        Reads as many bytes from the stream as is necessary to fill the given + byte array. An EOFException is thrown if the stream end is encountered.
        +
        Throws:
        +
        java.io.IOException
        +
        java.io.EOFException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        decodeSingle

        +
        public static byte[] decodeSingle(byte[] src,
+                  int prefixPadding,
+                  int suffixPadding)
+                           throws CorruptEncodingException
        +
        Decodes the given byte array which was encoded by DataEncoder.encodeSingle(byte[], int, int). Always returns a new byte array instance.
        +
        Parameters:
        prefixPadding - amount of extra bytes to skip from start of encoded byte array
        suffixPadding - amount of extra bytes to skip at end of encoded byte array
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + + + + + +
        +
      • +

        decodeSingleNullable

        +
        public static byte[] decodeSingleNullable(byte[] src,
+                          int prefixPadding,
+                          int suffixPadding)
+                                   throws CorruptEncodingException
        +
        Decodes the given byte array which was encoded by DataEncoder.encodeSingleNullable(byte[]). Always returns a new byte array + instance.
        +
        Parameters:
        prefixPadding - amount of extra bytes to skip from start of encoded byte array
        suffixPadding - amount of extra bytes to skip at end of encoded byte array
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/DataEncoder.html b/apidocs/com/amazon/carbonado/raw/DataEncoder.html new file mode 100644 index 0000000..553433e --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/DataEncoder.html @@ -0,0 +1,920 @@ + + + + + + +DataEncoder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class DataEncoder

+
+
+ +
+
    +
  • +
    +
    +
    public class DataEncoder
+extends java.lang.Object
    +
    A very low-level class that supports encoding of primitive data. For + encoding data into keys, see KeyEncoder.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    DataDecoder
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      DataEncoder() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static intcalculateEncodedLength(java.math.BigDecimal value) +
      Returns the amount of bytes required to encode the given BigDecimal.
      +
      static intcalculateEncodedLength(java.math.BigInteger value) +
      Returns the amount of bytes required to encode the given BigInteger.
      +
      static intcalculateEncodedLength(byte[] value) +
      Returns the amount of bytes required to encode the given byte array.
      +
      static intcalculateEncodedLength(byte[] value, + int valueOffset, + int valueLength) +
      Returns the amount of bytes required to encode the given byte array.
      +
      static intcalculateEncodedStringLength(java.lang.String value) +
      Returns the amount of bytes required to encode the given String.
      +
      static intencode(java.math.BigDecimal value, + byte[] dst, + int dstOffset) +
      Encodes the given optional BigDecimal into a variable amount of + bytes.
      +
      static intencode(java.math.BigInteger value, + byte[] dst, + int dstOffset) +
      Encodes the given optional BigInteger into a variable amount of + bytes.
      +
      static voidencode(boolean value, + byte[] dst, + int dstOffset) +
      Encodes the given boolean into exactly 1 byte.
      +
      static voidencode(java.lang.Boolean value, + byte[] dst, + int dstOffset) +
      Encodes the given Boolean object into exactly 1 byte.
      +
      static intencode(byte[] value, + byte[] dst, + int dstOffset) +
      Encodes the given optional byte array into a variable amount of + bytes.
      +
      static intencode(byte[] value, + int valueOffset, + int valueLength, + byte[] dst, + int dstOffset) +
      Encodes the given optional byte array into a variable amount of + bytes.
      +
      static voidencode(byte value, + byte[] dst, + int dstOffset) +
      Encodes the given signed byte into exactly 1 byte.
      +
      static intencode(java.lang.Byte value, + byte[] dst, + int dstOffset) +
      Encodes the given signed Byte object into exactly 1 or 2 bytes.
      +
      static intencode(java.lang.Character value, + byte[] dst, + int dstOffset) +
      Encodes the given Character object into exactly 1 or 3 bytes.
      +
      static voidencode(char value, + byte[] dst, + int dstOffset) +
      Encodes the given character into exactly 2 bytes.
      +
      static voidencode(double value, + byte[] dst, + int dstOffset) +
      Encodes the given double into exactly 8 bytes.
      +
      static voidencode(java.lang.Double value, + byte[] dst, + int dstOffset) +
      Encodes the given Double object into exactly 8 bytes.
      +
      static voidencode(float value, + byte[] dst, + int dstOffset) +
      Encodes the given float into exactly 4 bytes.
      +
      static voidencode(java.lang.Float value, + byte[] dst, + int dstOffset) +
      Encodes the given Float object into exactly 4 bytes.
      +
      static voidencode(int value, + byte[] dst, + int dstOffset) +
      Encodes the given signed integer into exactly 4 bytes.
      +
      static intencode(java.lang.Integer value, + byte[] dst, + int dstOffset) +
      Encodes the given signed Integer object into exactly 1 or 5 bytes.
      +
      static voidencode(long value, + byte[] dst, + int dstOffset) +
      Encodes the given signed long into exactly 8 bytes.
      +
      static intencode(java.lang.Long value, + byte[] dst, + int dstOffset) +
      Encodes the given signed Long object into exactly 1 or 9 bytes.
      +
      static voidencode(short value, + byte[] dst, + int dstOffset) +
      Encodes the given signed short into exactly 2 bytes.
      +
      static intencode(java.lang.Short value, + byte[] dst, + int dstOffset) +
      Encodes the given signed Short object into exactly 1 or 3 bytes.
      +
      static intencode(java.lang.String value, + byte[] dst, + int dstOffset) +
      Encodes the given optional String into a variable amount of bytes.
      +
      static byte[]encodeSingle(byte[] value, + int prefixPadding, + int suffixPadding) +
      Encodes the given byte array for use when there is only a single + property, whose type is a byte array.
      +
      static byte[]encodeSingleNullable(byte[] value) +
      Encodes the given byte array for use when there is only a single + nullable property, whose type is a byte array.
      +
      static byte[]encodeSingleNullable(byte[] value, + int prefixPadding, + int suffixPadding) +
      Encodes the given byte array for use when there is only a single + nullable property, whose type is a byte array.
      +
      static intwriteLength(int valueLength, + java.io.OutputStream out) +
      Writes a positive length value in up to five bytes.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DataEncoder

        +
        public DataEncoder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        encode

        +
        public static void encode(int value,
+          byte[] dst,
+          int dstOffset)
        +
        Encodes the given signed integer into exactly 4 bytes.
        +
        Parameters:
        value - signed integer value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(java.lang.Integer value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given signed Integer object into exactly 1 or 5 bytes. If + the Integer object is never expected to be null, consider encoding as an + int primitive.
        +
        Parameters:
        value - optional signed Integer value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static void encode(long value,
+          byte[] dst,
+          int dstOffset)
        +
        Encodes the given signed long into exactly 8 bytes.
        +
        Parameters:
        value - signed long value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(java.lang.Long value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given signed Long object into exactly 1 or 9 bytes. If the + Long object is never expected to be null, consider encoding as a long + primitive.
        +
        Parameters:
        value - optional signed Long value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static void encode(byte value,
+          byte[] dst,
+          int dstOffset)
        +
        Encodes the given signed byte into exactly 1 byte.
        +
        Parameters:
        value - signed byte value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(java.lang.Byte value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given signed Byte object into exactly 1 or 2 bytes. If the + Byte object is never expected to be null, consider encoding as a byte + primitive.
        +
        Parameters:
        value - optional signed Byte value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static void encode(short value,
+          byte[] dst,
+          int dstOffset)
        +
        Encodes the given signed short into exactly 2 bytes.
        +
        Parameters:
        value - signed short value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(java.lang.Short value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given signed Short object into exactly 1 or 3 bytes. If the + Short object is never expected to be null, consider encoding as a short + primitive.
        +
        Parameters:
        value - optional signed Short value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static void encode(char value,
+          byte[] dst,
+          int dstOffset)
        +
        Encodes the given character into exactly 2 bytes.
        +
        Parameters:
        value - character value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(java.lang.Character value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given Character object into exactly 1 or 3 bytes. If the + Character object is never expected to be null, consider encoding as a + char primitive.
        +
        Parameters:
        value - optional Character value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static void encode(boolean value,
+          byte[] dst,
+          int dstOffset)
        +
        Encodes the given boolean into exactly 1 byte.
        +
        Parameters:
        value - boolean value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static void encode(java.lang.Boolean value,
+          byte[] dst,
+          int dstOffset)
        +
        Encodes the given Boolean object into exactly 1 byte.
        +
        Parameters:
        value - optional Boolean value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static void encode(float value,
+          byte[] dst,
+          int dstOffset)
        +
        Encodes the given float into exactly 4 bytes.
        +
        Parameters:
        value - float value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static void encode(java.lang.Float value,
+          byte[] dst,
+          int dstOffset)
        +
        Encodes the given Float object into exactly 4 bytes. A non-canonical NaN + value is used to represent null.
        +
        Parameters:
        value - optional Float value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static void encode(double value,
+          byte[] dst,
+          int dstOffset)
        +
        Encodes the given double into exactly 8 bytes.
        +
        Parameters:
        value - double value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static void encode(java.lang.Double value,
+          byte[] dst,
+          int dstOffset)
        +
        Encodes the given Double object into exactly 8 bytes. A non-canonical + NaN value is used to represent null.
        +
        Parameters:
        value - optional Double value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(java.math.BigInteger value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given optional BigInteger into a variable amount of + bytes. If the BigInteger is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.
        +
        Parameters:
        value - BigInteger value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        calculateEncodedLength

        +
        public static int calculateEncodedLength(java.math.BigInteger value)
        +
        Returns the amount of bytes required to encode the given BigInteger.
        +
        Parameters:
        value - BigInteger value to encode, may be null
        +
        Returns:
        amount of bytes needed to encode
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(java.math.BigDecimal value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given optional BigDecimal into a variable amount of + bytes. If the BigDecimal is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.
        +
        Parameters:
        value - BigDecimal value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        calculateEncodedLength

        +
        public static int calculateEncodedLength(java.math.BigDecimal value)
        +
        Returns the amount of bytes required to encode the given BigDecimal.
        +
        Parameters:
        value - BigDecimal value to encode, may be null
        +
        Returns:
        amount of bytes needed to encode
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(byte[] value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given optional byte array into a variable amount of + bytes. If the byte array is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.
        +
        Parameters:
        value - byte array value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(byte[] value,
+         int valueOffset,
+         int valueLength,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given optional byte array into a variable amount of + bytes. If the byte array is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.
        +
        Parameters:
        value - byte array value to encode, may be null
        valueOffset - offset into byte array
        valueLength - length of data in byte array
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        calculateEncodedLength

        +
        public static int calculateEncodedLength(byte[] value)
        +
        Returns the amount of bytes required to encode the given byte array.
        +
        Parameters:
        value - byte array value to encode, may be null
        +
        Returns:
        amount of bytes needed to encode
        +
        • +
      + + + +
        +
      • +

        calculateEncodedLength

        +
        public static int calculateEncodedLength(byte[] value,
+                         int valueOffset,
+                         int valueLength)
        +
        Returns the amount of bytes required to encode the given byte array.
        +
        Parameters:
        value - byte array value to encode, may be null
        valueOffset - offset into byte array
        valueLength - length of data in byte array
        +
        Returns:
        amount of bytes needed to encode
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(java.lang.String value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given optional String into a variable amount of bytes. The + amount written can be determined by calling + calculateEncodedStringLength. +

        + Strings are encoded in a fashion similar to UTF-8, in that ASCII + characters are written in one byte. This encoding is more efficient than + UTF-8, but it isn't compatible with UTF-8.

        +
        Parameters:
        value - String value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        calculateEncodedStringLength

        +
        public static int calculateEncodedStringLength(java.lang.String value)
        +
        Returns the amount of bytes required to encode the given String.
        +
        Parameters:
        value - String to encode, may be null
        +
        • +
      + + + +
        +
      • +

        writeLength

        +
        public static int writeLength(int valueLength,
+              java.io.OutputStream out)
+                       throws java.io.IOException
        +
        Writes a positive length value in up to five bytes.
        +
        Returns:
        number of bytes written
        +
        Throws:
        +
        java.io.IOException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        encodeSingle

        +
        public static byte[] encodeSingle(byte[] value,
+                  int prefixPadding,
+                  int suffixPadding)
        +
        Encodes the given byte array for use when there is only a single + property, whose type is a byte array. The original byte array is + returned if the padding lengths are zero.
        +
        Parameters:
        prefixPadding - amount of extra bytes to allocate at start of encoded byte array
        suffixPadding - amount of extra bytes to allocate at end of encoded byte array
        +
        • +
      + + + +
        +
      • +

        encodeSingleNullable

        +
        public static byte[] encodeSingleNullable(byte[] value)
        +
        Encodes the given byte array for use when there is only a single + nullable property, whose type is a byte array.
        +
        • +
      + + + +
        +
      • +

        encodeSingleNullable

        +
        public static byte[] encodeSingleNullable(byte[] value,
+                          int prefixPadding,
+                          int suffixPadding)
        +
        Encodes the given byte array for use when there is only a single + nullable property, whose type is a byte array.
        +
        Parameters:
        prefixPadding - amount of extra bytes to allocate at start of encoded byte array
        suffixPadding - amount of extra bytes to allocate at end of encoded byte array
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/GenericEncodingStrategy.html b/apidocs/com/amazon/carbonado/raw/GenericEncodingStrategy.html new file mode 100644 index 0000000..9e13630 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GenericEncodingStrategy.html @@ -0,0 +1,1000 @@ + + + + + + +GenericEncodingStrategy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class GenericEncodingStrategy<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    CompressedEncodingStrategy
    +
    +
    +
    +
    public class GenericEncodingStrategy<S extends Storable>
+extends java.lang.Object
    +
    Generates bytecode instructions for encoding/decoding Storable properties + to/from raw bytes. + +

    Note: subclasses must override and specialize the hashCode and equals + methods. Failure to do so interferes with StorableCodecFactory's + generated code cache.

    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidbuildDataDecoding(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.LocalVariablebuildDataEncoding(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.
      +
      voidbuildKeyDecoding(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.LocalVariablebuildKeyEncoding(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.
      +
      voidbuildSerialDecoding(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.LocalVariablebuildSerialEncoding(org.cojen.classfile.CodeAssembler assembler, + StorableProperty<S>[] properties) +
      Generates bytecode instructions to encode properties and their + states.
      +
      protected StorablePropertyInfocheckSupport(StorableProperty<S> property) 
      protected StorablePropertyInfo[]checkSupport(StorableProperty<S>[] properties) 
      booleanequals(java.lang.Object obj) 
      protected voidextraDataDecoding(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.LocalVariable dataVar, + int prefix, + int suffix) +
      Second phase decoding, which does nothing by default.
      +
      protected voidextraDataEncoding(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.LocalVariable dataVar, + int prefix, + int suffix) +
      Second phase encoding, which does nothing by default.
      +
      protected StorableProperty<S>[]gatherAllDataProperties() +
      Returns all non-derived data properties for storable.
      +
      protected OrderedProperty<S>[]gatherAllKeyProperties() +
      Returns all key properties as ordered properties, possibly with + unspecified directions.
      +
      protected StorableProperty<S>[]gatherAllProperties() +
      Returns all non-join, non-derived properties for storable.
      +
      intgetConstantKeyPrefixLength() +
      Returns amount of prefix key bytes that encoding strategy instance + produces which are always the same.
      +
      intgetDataPrefixPadding() 
      intgetDataSuffixPadding() 
      intgetKeyPrefixPadding() 
      intgetKeySuffixPadding() 
      protected StorableIndex<S>getPrimaryKeyIndex() +
      Returns all key properties in the form of an index.
      +
      java.lang.Class<S>getType() +
      Returns the type of Storable that code is generated for.
      +
      inthashCode() 
      booleanisSupported(java.lang.Class<?> propertyType) +
      Returns true if the type of the given property type is supported.
      +
      booleanisSupported(org.cojen.classfile.TypeDesc propertyType) +
      Returns true if the type of the given property type is supported.
      +
      protected booleanloadPropertyValue(org.cojen.classfile.CodeAssembler a, + StorablePropertyInfo info, + int ordinal, + boolean useReadMethod, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + org.cojen.classfile.LocalVariable partialStartVar) +
      Generates code to load a property value onto the operand stack.
      +
      protected booleanloadPropertyValue(org.cojen.classfile.LocalVariable[] stashedProperties, + java.lang.Boolean[] stashedFromInstances, + org.cojen.classfile.CodeAssembler a, + StorablePropertyInfo info, + int ordinal, + boolean useReadMethod, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + org.cojen.classfile.LocalVariable partialStartVar) +
      Generates code to load a property value onto the operand stack.
      +
      protected voidpushDecodingInstanceVar(org.cojen.classfile.CodeAssembler a, + int ordinal, + org.cojen.classfile.LocalVariable instanceVar) +
      Push decoding instanceVar to stack in preparation to calling + storePropertyValue.
      +
      protected voidpushRawSupport(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.LocalVariable instanceVar) +
      Generates code to push RawSupport instance to the stack.
      +
      protected voidstorePropertyValue(org.cojen.classfile.CodeAssembler a, + StorablePropertyInfo info, + boolean useWriteMethod, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass) +
      Generates code to store a property value into an instance which is + already on the operand stack.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GenericEncodingStrategy

        +
        public GenericEncodingStrategy(java.lang.Class<S> type,
+                       StorableIndex<S> pkIndex)
        +
        Parameters:
        type - type of Storable to generate code for
        pkIndex - specifies sequence and ordering of key properties (optional)
        +
        • +
      + + + +
        +
      • +

        GenericEncodingStrategy

        +
        public GenericEncodingStrategy(java.lang.Class<S> type,
+                       StorableIndex<S> pkIndex,
+                       int keyPrefixPadding,
+                       int keySuffixPadding,
+                       int dataPrefixPadding,
+                       int dataSuffixPadding)
        +
        Parameters:
        type - type of Storable to generate code for
        pkIndex - specifies sequence and ordering of key properties (optional)
        keyPrefixPadding - amount of padding bytes at start of keys
        keySuffixPadding - amount of padding bytes at end of keys
        dataPrefixPadding - amount of padding bytes at start of data values
        dataSuffixPadding - amount of padding bytes at end of data values
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        buildKeyEncoding

        +
        public org.cojen.classfile.LocalVariable 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)
+                                                   throws SupportException
        +
        Generates bytecode instructions to encode properties. The encoding is + suitable for "key" encoding, which means it is correctly comparable. + +

        Note: if a partialStartVar is provided and this strategy has a key + prefix, the prefix is allocated only if the runtime value of + partialStartVar is zero. Likewise, if a partialEndVar is provided and + this strategy has a key suffix, the suffix is allocated only of the + runtime value of partialEndVar is one less than the property count.

        +
        Parameters:
        assembler - code assembler to receive bytecode instructions
        properties - specific properties to encode, defaults to all key + properties if null
        instanceVar - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are read from the runtime value of this array instead + of a Storable instance.
        adapterInstanceClass - class containing static references to + adapter instances - defaults to instanceVar
        useReadMethods - when true, access properties by public read + methods instead of protected fields - should be used if class being + generated doesn't have access to these fields
        partialStartVar - optional variable for supporting partial key + generation. It must be an int, whose runtime value must be less than the + properties array length. It marks the range start of the partial + property range.
        partialEndVar - optional variable for supporting partial key + generation. It must be an int, whose runtime value must be less than or + equal to the properties array length. It marks the range end (exclusive) + of the partial property range.
        +
        Returns:
        local variable referencing a byte array with encoded key
        +
        Throws:
        +
        SupportException - if any property type is not supported
        +
        java.lang.IllegalArgumentException - if assembler is null, or if instanceVar + is not the correct instance type, or if partial variable types are not + ints
        +
        • +
      + + + +
        +
      • +

        buildKeyDecoding

        +
        public void 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)
+                      throws SupportException
        +
        Generates bytecode instructions to decode properties. A + CorruptEncodingException may be thrown from generated code.
        +
        Parameters:
        assembler - code assembler to receive bytecode instructions
        properties - specific properties to decode, defaults to all key + properties if null
        instanceVar - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are placed into the runtime value of this array instead + of a Storable instance.
        adapterInstanceClass - class containing static references to + adapter instances - defaults to instanceVar
        useWriteMethods - when true, set properties by public write + methods instead of protected fields - should be used if class being + generated doesn't have access to these fields
        encodedVar - required variable, which must be a byte array. At + runtime, it references an encoded key.
        +
        Throws:
        +
        SupportException - if any property type is not supported
        +
        java.lang.IllegalArgumentException - if assembler is null, or if instanceVar + is not the correct instance type, or if encodedVar is not a byte array
        +
        • +
      + + + +
        +
      • +

        buildDataEncoding

        +
        public org.cojen.classfile.LocalVariable buildDataEncoding(org.cojen.classfile.CodeAssembler assembler,
+                                                  StorableProperty<S>[] properties,
+                                                  org.cojen.classfile.LocalVariable instanceVar,
+                                                  java.lang.Class<?> adapterInstanceClass,
+                                                  boolean useReadMethods,
+                                                  int generation)
+                                                    throws SupportException
        +
        Generates bytecode instructions to encode properties. The encoding is + suitable for "data" encoding, which means it is not correctly + comparable, but it is more efficient than key encoding. Partial encoding + is not supported.
        +
        Parameters:
        assembler - code assembler to receive bytecode instructions
        properties - specific properties to encode, defaults to all non-key + properties if null
        instanceVar - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are read from the runtime value of this array instead + of a Storable instance.
        adapterInstanceClass - class containing static references to + adapter instances - defaults to instanceVar
        useReadMethods - when true, access properties by public read + methods instead of protected fields
        generation - when non-negative, write a storable layout generation + value in one or four bytes. Generation 0..127 is encoded in one byte, and + 128..max is encoded in four bytes, with the most significant bit set.
        +
        Returns:
        local variable referencing a byte array with encoded data
        +
        Throws:
        +
        SupportException - if any property type is not supported
        +
        java.lang.IllegalArgumentException - if assembler is null, or if instanceVar + is not the correct instance type
        +
        • +
      + + + +
        +
      • +

        buildDataDecoding

        +
        public void 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)
+                       throws SupportException
        +
        Generates bytecode instructions to decode properties. A + CorruptEncodingException may be thrown from generated code.
        +
        Parameters:
        assembler - code assembler to receive bytecode instructions
        properties - specific properties to decode, defaults to all non-key + properties if null
        instanceVar - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are placed into the runtime value of this array instead + of a Storable instance.
        adapterInstanceClass - class containing static references to + adapter instances - defaults to instanceVar
        useWriteMethods - when true, set properties by public write + methods instead of protected fields - should be used if class being + generated doesn't have access to these fields
        generation - when non-negative, decoder expects a storable layout + generation value to match this value. Otherwise, it throws a + CorruptEncodingException.
        altGenerationHandler - if non-null and a generation is provided, + this label defines an alternate generation handler. It is executed + instead of throwing a CorruptEncodingException if the generation doesn't + match. The actual generation is available on the top of the stack for + the handler to consume.
        encodedVar - required variable, which must be a byte array. At + runtime, it references encoded data.
        +
        Throws:
        +
        SupportException - if any property type is not supported
        +
        java.lang.IllegalArgumentException - if assembler is null, or if instanceVar + is not the correct instance type, or if encodedVar is not a byte array
        +
        • +
      + + + +
        +
      • +

        buildSerialEncoding

        +
        public org.cojen.classfile.LocalVariable buildSerialEncoding(org.cojen.classfile.CodeAssembler assembler,
+                                                    StorableProperty<S>[] properties)
+                                                      throws SupportException
        +
        Generates bytecode instructions to encode properties and their + states. This encoding is suitable for short-term serialization only.
        +
        Parameters:
        assembler - code assembler to receive bytecode instructions
        properties - specific properties to decode, defaults to all + properties if null
        +
        Returns:
        local variable referencing a byte array with encoded data
        +
        Throws:
        +
        SupportException - if any property type is not supported
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        buildSerialDecoding

        +
        public void buildSerialDecoding(org.cojen.classfile.CodeAssembler assembler,
+                       StorableProperty<S>[] properties,
+                       org.cojen.classfile.LocalVariable encodedVar)
+                         throws SupportException
        +
        Generates bytecode instructions to decode properties and their states. A + CorruptEncodingException may be thrown from generated code.
        +
        Parameters:
        assembler - code assembler to receive bytecode instructions
        properties - specific properties to decode, defaults to all + properties if null
        encodedVar - required variable, which must be a byte array. At + runtime, it references encoded data.
        +
        Throws:
        +
        SupportException - if any property type is not supported
        +
        java.lang.IllegalArgumentException - if encodedVar is not a byte array
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public final java.lang.Class<S> getType()
        +
        Returns the type of Storable that code is generated for.
        +
        • +
      + + + +
        +
      • +

        isSupported

        +
        public boolean isSupported(java.lang.Class<?> propertyType)
        +
        Returns true if the type of the given property type is supported. The + types currently supported are primitives, primitive wrapper objects, + Strings, and byte arrays.
        +
        • +
      + + + +
        +
      • +

        isSupported

        +
        public boolean isSupported(org.cojen.classfile.TypeDesc propertyType)
        +
        Returns true if the type of the given property type is supported. The + types currently supported are primitives, primitive wrapper objects, + Strings, byte arrays and Lobs.
        +
        • +
      + + + +
        +
      • +

        getKeyPrefixPadding

        +
        public int getKeyPrefixPadding()
        +
        • +
      + + + +
        +
      • +

        getKeySuffixPadding

        +
        public int getKeySuffixPadding()
        +
        • +
      + + + +
        +
      • +

        getDataPrefixPadding

        +
        public int getDataPrefixPadding()
        +
        • +
      + + + +
        +
      • +

        getDataSuffixPadding

        +
        public int getDataSuffixPadding()
        +
        • +
      + + + +
        +
      • +

        getConstantKeyPrefixLength

        +
        public int getConstantKeyPrefixLength()
        +
        Returns amount of prefix key bytes that encoding strategy instance + produces which are always the same. Default implementation returns 0.
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        getPrimaryKeyIndex

        +
        protected StorableIndex<S> getPrimaryKeyIndex()
        +
        Returns all key properties in the form of an index.
        +
        • +
      + + + +
        +
      • +

        gatherAllKeyProperties

        +
        protected OrderedProperty<S>[] gatherAllKeyProperties()
        +
        Returns all key properties as ordered properties, possibly with + unspecified directions.
        +
        • +
      + + + +
        +
      • +

        gatherAllDataProperties

        +
        protected StorableProperty<S>[] gatherAllDataProperties()
        +
        Returns all non-derived data properties for storable.
        +
        • +
      + + + +
        +
      • +

        gatherAllProperties

        +
        protected StorableProperty<S>[] gatherAllProperties()
        +
        Returns all non-join, non-derived properties for storable.
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        extraDataEncoding

        +
        protected void extraDataEncoding(org.cojen.classfile.CodeAssembler a,
+                     org.cojen.classfile.LocalVariable dataVar,
+                     int prefix,
+                     int suffix)
        +
        Second phase encoding, which does nothing by default.
        +
        Parameters:
        dataVar - local variable referencing a byte array with data
        prefix - prefix of byte array to preserve
        suffix - suffix of byte array to preserve
        +
        • +
      + + + +
        +
      • +

        extraDataDecoding

        +
        protected void extraDataDecoding(org.cojen.classfile.CodeAssembler a,
+                     org.cojen.classfile.LocalVariable dataVar,
+                     int prefix,
+                     int suffix)
        +
        Second phase decoding, which does nothing by default.
        +
        Parameters:
        dataVar - local variable referencing a byte array with data
        +
        • +
      + + + +
        +
      • +

        loadPropertyValue

        +
        protected boolean loadPropertyValue(org.cojen.classfile.LocalVariable[] stashedProperties,
+                        java.lang.Boolean[] stashedFromInstances,
+                        org.cojen.classfile.CodeAssembler a,
+                        StorablePropertyInfo info,
+                        int ordinal,
+                        boolean useReadMethod,
+                        org.cojen.classfile.LocalVariable instanceVar,
+                        java.lang.Class<?> adapterInstanceClass,
+                        org.cojen.classfile.LocalVariable partialStartVar)
        +
        Generates code to load a property value onto the operand stack.
        +
        Parameters:
        info - info for property to load
        ordinal - zero-based property ordinal, used only if instanceVar + refers to an object array.
        useReadMethod - when true, access property by public read method + instead of protected field
        instanceVar - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are read from the runtime value of this array instead + of a Storable instance.
        adapterInstanceClass - class containing static references to + adapter instances - defaults to instanceVar
        partialStartVar - optional variable for supporting partial key + generation. It must be an int, whose runtime value must be less than the + properties array length. It marks the range start of the partial + property range.
        +
        Returns:
        true if property was loaded from instance, false if loaded from + value array
        +
        • +
      + + + +
        +
      • +

        loadPropertyValue

        +
        protected boolean loadPropertyValue(org.cojen.classfile.CodeAssembler a,
+                        StorablePropertyInfo info,
+                        int ordinal,
+                        boolean useReadMethod,
+                        org.cojen.classfile.LocalVariable instanceVar,
+                        java.lang.Class<?> adapterInstanceClass,
+                        org.cojen.classfile.LocalVariable partialStartVar)
        +
        Generates code to load a property value onto the operand stack.
        +
        Parameters:
        info - info for property to load
        ordinal - zero-based property ordinal, used only if instanceVar + refers to an object array.
        useReadMethod - when true, access property by public read method + instead of protected field
        instanceVar - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are read from the runtime value of this array instead + of a Storable instance.
        adapterInstanceClass - class containing static references to + adapter instances - defaults to instanceVar
        partialStartVar - optional variable for supporting partial key + generation. It must be an int, whose runtime value must be less than the + properties array length. It marks the range start of the partial + property range.
        +
        Returns:
        true if property was loaded from instance, false if loaded from + value array
        +
        • +
      + + + +
        +
      • +

        pushRawSupport

        +
        protected void pushRawSupport(org.cojen.classfile.CodeAssembler a,
+                  org.cojen.classfile.LocalVariable instanceVar)
+                       throws SupportException
        +
        Generates code to push RawSupport instance to the stack. RawSupport is + available only in Storable instances. If instanceVar is an Object[], a + SupportException is thrown.
        +
        Parameters:
        instanceVar - Storable instance or array of property values. Null + is storable instance of "this".
        +
        Throws:
        +
        SupportException
        +
        • +
      + + + +
        +
      • +

        pushDecodingInstanceVar

        +
        protected void pushDecodingInstanceVar(org.cojen.classfile.CodeAssembler a,
+                           int ordinal,
+                           org.cojen.classfile.LocalVariable instanceVar)
        +
        Push decoding instanceVar to stack in preparation to calling + storePropertyValue.
        +
        Parameters:
        ordinal - zero-based property ordinal, used only if instanceVar + refers to an object array.
        instanceVar - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are written to the runtime value of this array instead + of a Storable instance.
        See Also:
        storePropertyValue
        +
        • +
      + + + +
        +
      • +

        storePropertyValue

        +
        protected void storePropertyValue(org.cojen.classfile.CodeAssembler a,
+                      StorablePropertyInfo info,
+                      boolean useWriteMethod,
+                      org.cojen.classfile.LocalVariable instanceVar,
+                      java.lang.Class<?> adapterInstanceClass)
        +
        Generates code to store a property value into an instance which is + already on the operand stack. If instance is an Object array, index into + array must also be on the operand stack.
        +
        Parameters:
        info - info for property to store to
        useWriteMethod - when true, set property by public write method + instead of protected field
        instanceVar - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are written to the runtime value of this array instead + of a Storable instance.
        adapterInstanceClass - class containing static references to + adapter instances - defaults to instanceVar
        See Also:
        pushDecodingInstanceVar
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/GenericInstanceFactory.html b/apidocs/com/amazon/carbonado/raw/GenericInstanceFactory.html new file mode 100644 index 0000000..c4a26ad --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GenericInstanceFactory.html @@ -0,0 +1,250 @@ + + + + + + +GenericInstanceFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Interface GenericInstanceFactory

+
+
+
+
    +
  • +
    +
    +
    public interface GenericInstanceFactory
    +
    Can be used with QuickConstructorGenerator + for instantiating generic storable instances.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/GenericPropertyInfo.html b/apidocs/com/amazon/carbonado/raw/GenericPropertyInfo.html new file mode 100644 index 0000000..7250771 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GenericPropertyInfo.html @@ -0,0 +1,324 @@ + + + + + + +GenericPropertyInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Interface GenericPropertyInfo

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    StorablePropertyInfo
    +
    +
    +
    +
    public interface GenericPropertyInfo
    +
    Minimal information required by GenericEncodingStrategy to encode + and decode a storable property.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.reflect.MethodgetFromStorageAdapter() +
      Returns the optional method used to adapt the property from the + storage supported type to the user visible type.
      +
      java.lang.StringgetPropertyName() 
      org.cojen.classfile.TypeDescgetPropertyType() +
      Returns the user specified property type.
      +
      org.cojen.classfile.TypeDescgetStorageType() +
      Returns the storage supported type.
      +
      java.lang.reflect.MethodgetToStorageAdapter() +
      Returns the optional method used to adapt the property from the user + visible type to the storage supported type.
      +
      booleanisDerived() 
      booleanisLob() 
      booleanisNullable() 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPropertyName

        +
        java.lang.String getPropertyName()
        +
        • +
      + + + +
        +
      • +

        getPropertyType

        +
        org.cojen.classfile.TypeDesc getPropertyType()
        +
        Returns the user specified property type.
        +
        • +
      + + + +
        +
      • +

        getStorageType

        +
        org.cojen.classfile.TypeDesc getStorageType()
        +
        Returns the storage supported type. If it differs from the property + type, then adapter methods must also exist.
        +
        • +
      + + + +
        +
      • +

        isNullable

        +
        boolean isNullable()
        +
        • +
      + + + +
        +
      • +

        isLob

        +
        boolean isLob()
        +
        • +
      + + + +
        +
      • +

        isDerived

        +
        boolean isDerived()
        +
        • +
      + + + +
        +
      • +

        getFromStorageAdapter

        +
        java.lang.reflect.Method getFromStorageAdapter()
        +
        Returns the optional method used to adapt the property from the + storage supported type to the user visible type.
        +
        • +
      + + + +
        +
      • +

        getToStorageAdapter

        +
        java.lang.reflect.Method getToStorageAdapter()
        +
        Returns the optional method used to adapt the property from the user + visible type to the storage supported type.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html b/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html new file mode 100644 index 0000000..b765c1f --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html @@ -0,0 +1,222 @@ + + + + + + +GenericStorableCodec.Decoder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Interface GenericStorableCodec.Decoder<S extends Storable>

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    GenericStorableCodec<S extends Storable>
    +
    +
    +
    +
    public static interface GenericStorableCodec.Decoder<S extends Storable>
    +
    Used for decoding different generations of Storable.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiddecode(S dest, + byte[] data) 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        decode

        +
        void decode(S dest,
+          byte[] data)
+            throws CorruptEncodingException
        +
        Parameters:
        dest - storable to receive decoded properties
        data - decoded into properties, some of which may be dropped if + destination storable doesn't have it
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html b/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html new file mode 100644 index 0000000..9201b11 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html @@ -0,0 +1,313 @@ + + + + + + +GenericStorableCodec.SearchKeyFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Interface GenericStorableCodec.SearchKeyFactory<S extends Storable>

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    GenericStorableCodec<S extends Storable>
    +
    +
    +
    +
    public static interface GenericStorableCodec.SearchKeyFactory<S extends Storable>
    +
    Creates custom raw search keys for Storable types. It is + intended for supporting queries and indexes.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      byte[]encodeSearchKey(java.lang.Object[] values) +
      Build a search key by supplying property values without a storable.
      +
      byte[]encodeSearchKey(java.lang.Object[] values, + int rangeStart, + int rangeEnd) +
      Build a search key by supplying property values without a storable.
      +
      byte[]encodeSearchKey(S storable) +
      Build a search key by extracting all the desired properties from the + given storable.
      +
      byte[]encodeSearchKey(S storable, + int rangeStart, + int rangeEnd) +
      Build a search key by extracting all the desired properties from the + given storable.
      +
      byte[]encodeSearchKeyPrefix() +
      Returns the search key for when there are no values.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        encodeSearchKey

        +
        byte[] encodeSearchKey(S storable)
        +
        Build a search key by extracting all the desired properties from the + given storable.
        +
        Parameters:
        storable - extract a subset of properties from this instance
        +
        Returns:
        raw search key
        +
        • +
      + + + + + +
        +
      • +

        encodeSearchKey

        +
        byte[] encodeSearchKey(S storable,
+                     int rangeStart,
+                     int rangeEnd)
        +
        Build a search key by extracting all the desired properties from the + given storable.
        +
        Parameters:
        storable - extract a subset of properties from this instance
        rangeStart - index of first property to use. Its value must be less + than the count of properties used by this factory.
        rangeEnd - index of last property to use, exlusive. Its value must + be less than or equal to the count of properties used by this factory.
        +
        Returns:
        raw search key
        +
        • +
      + + + +
        +
      • +

        encodeSearchKey

        +
        byte[] encodeSearchKey(java.lang.Object[] values)
        +
        Build a search key by supplying property values without a storable.
        +
        Parameters:
        values - values to build into a key. It must be long enough to + accommodate all of properties used by this factory.
        +
        Returns:
        raw search key
        +
        • +
      + + + +
        +
      • +

        encodeSearchKey

        +
        byte[] encodeSearchKey(java.lang.Object[] values,
+                     int rangeStart,
+                     int rangeEnd)
        +
        Build a search key by supplying property values without a storable.
        +
        Parameters:
        values - values to build into a key. The length may be less than + the amount of properties used by this factory. It must not be less than the + difference between rangeStart and rangeEnd.
        rangeStart - index of first property to use. Its value must be less + than the count of properties used by this factory.
        rangeEnd - index of last property to use, exlusive. Its value must + be less than or equal to the count of properties used by this factory.
        +
        Returns:
        raw search key
        +
        • +
      + + + +
        +
      • +

        encodeSearchKeyPrefix

        +
        byte[] encodeSearchKeyPrefix()
        +
        Returns the search key for when there are no values. Returned value + may be null.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.html b/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.html new file mode 100644 index 0000000..77cb1f3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.html @@ -0,0 +1,702 @@ + + + + + + +GenericStorableCodec (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class GenericStorableCodec<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    StorableCodec<S>
    +
    +
    +
    +
    public class GenericStorableCodec<S extends Storable>
+extends java.lang.Object
+implements StorableCodec<S>
    +
    Generic codec that supports any kind of storable by auto-generating and + caching storable implementations.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    GenericStorableCodecFactory
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiddecode(S dest, + int generation, + byte[] data) +
      Used for decoding different generations of Storable.
      +
      byte[]encodePrimaryKey(java.lang.Object[] values) +
      Encode a key by extracting all the primary key properties from the given + storable.
      +
      byte[]encodePrimaryKey(java.lang.Object[] values, + int rangeStart, + int rangeEnd) +
      Encode a key by extracting all the primary key properties from the given + storable.
      +
      byte[]encodePrimaryKey(S storable) +
      Encode a key by extracting all the primary key properties from the given + storable.
      +
      byte[]encodePrimaryKey(S storable, + int rangeStart, + int rangeEnd) +
      Encode a key by extracting all the primary key properties from the given + storable.
      +
      byte[]encodePrimaryKeyPrefix() +
      Encode the primary key for when there are no values, but there may be a + prefix.
      +
      GenericStorableCodec.Decoder<S>getDecoder(int generation) +
      Deprecated.  +
      use direct decode method
      +
      +
      StorableIndex<S>getPrimaryKeyIndex() +
      Returns the sequence and directions of properties that make up the + primary key.
      +
      intgetPrimaryKeyPrefixLength() +
      Returns the number of prefix bytes in the primary key, which may be + zero.
      +
      GenericStorableCodec.SearchKeyFactory<S>getSearchKeyFactory(OrderedProperty<S>[] properties) +
      Returns a search key factory, which is useful for implementing indexes + and queries.
      +
      java.lang.Class<? extends S>getStorableClass() +
      Returns a concrete Storable implementation, which is fully + thread-safe.
      +
      java.lang.Class<S>getStorableType() +
      Returns the type of Storable that code is generated for.
      +
      RawSupport<S>getSupport() +
      Returns the default RawSupport object that is supplied to + Storable instances produced by this codec.
      +
      Sinstantiate() +
      Instantiate a Storable with no key or value defined yet.
      +
      Sinstantiate(byte[] key) +
      Instantiate a Storable with no value defined yet.
      +
      Sinstantiate(byte[] key, + byte[] value) +
      Instantiate a Storable with a specific key and value.
      +
      Sinstantiate(RawSupport<S> support) +
      Instantiate a Storable with no key or value defined yet.
      +
      Sinstantiate(RawSupport<S> support, + byte[] key, + byte[] value) +
      Instantiate a Storable with a specific key and value.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStorableType

        +
        public final java.lang.Class<S> getStorableType()
        +
        Returns the type of Storable that code is generated for.
        +
        +
        Specified by:
        +
        getStorableType in interface StorableCodec<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        instantiate

        +
        public S instantiate()
        +
        Instantiate a Storable with no key or value defined yet. The default + RawSupport is supplied to the instance.
        +
        +
        Specified by:
        +
        instantiate in interface StorableCodec<S extends Storable>
        +
        Throws:
        +
        java.lang.IllegalStateException - if no default support exists
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        instantiate

        +
        public S instantiate(byte[] key)
+                               throws FetchException
        +
        Instantiate a Storable with no value defined yet. The default RawSupport is supplied to the instance.
        +
        +
        Specified by:
        +
        instantiate in interface StorableCodec<S extends Storable>
        +
        Throws:
        +
        java.lang.IllegalStateException - if no default support exists
        +
        FetchException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        instantiate

        +
        public S instantiate(byte[] key,
+            byte[] value)
+                               throws FetchException
        +
        Instantiate a Storable with a specific key and value. The default + RawSupport is supplied to the instance.
        +
        +
        Specified by:
        +
        instantiate in interface StorableCodec<S extends Storable>
        +
        Throws:
        +
        java.lang.IllegalStateException - if no default support exists
        +
        FetchException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        instantiate

        +
        public S instantiate(RawSupport<S> support)
        +
        Instantiate a Storable with no key or value defined yet. Any + RawSupport can be supplied to the instance.
        +
        +
        Specified by:
        +
        instantiate in interface StorableCodec<S extends Storable>
        +
        Parameters:
        support - binds generated storable with a storage layer
        +
        • +
      + + + + + + + + + + + + + + + + + +
        +
      • +

        encodePrimaryKey

        +
        public byte[] encodePrimaryKey(S storable)
        +
        Description copied from interface: StorableCodec
        +
        Encode a key by extracting all the primary key properties from the given + storable.
        +
        +
        Specified by:
        +
        encodePrimaryKey in interface StorableCodec<S extends Storable>
        +
        Parameters:
        storable - extract primary key properties from this instance
        +
        Returns:
        raw search key
        +
        • +
      + + + + + +
        +
      • +

        encodePrimaryKey

        +
        public byte[] encodePrimaryKey(S storable,
+                      int rangeStart,
+                      int rangeEnd)
        +
        Description copied from interface: StorableCodec
        +
        Encode a key by extracting all the primary key properties from the given + storable.
        +
        +
        Specified by:
        +
        encodePrimaryKey in interface StorableCodec<S extends Storable>
        +
        Parameters:
        storable - extract primary key properties from this instance
        rangeStart - index of first property to use. Its value must be less + than the count of primary key properties.
        rangeEnd - index of last property to use, exlusive. Its value must + be less than or equal to the count of primary key properties.
        +
        Returns:
        raw search key
        +
        • +
      + + + +
        +
      • +

        encodePrimaryKey

        +
        public byte[] encodePrimaryKey(java.lang.Object[] values)
        +
        Description copied from interface: StorableCodec
        +
        Encode a key by extracting all the primary key properties from the given + storable.
        +
        +
        Specified by:
        +
        encodePrimaryKey in interface StorableCodec<S extends Storable>
        +
        Parameters:
        values - values to build into a key. It must be long enough to + accommodate all primary key properties.
        +
        Returns:
        raw search key
        +
        • +
      + + + +
        +
      • +

        encodePrimaryKey

        +
        public byte[] encodePrimaryKey(java.lang.Object[] values,
+                      int rangeStart,
+                      int rangeEnd)
        +
        Description copied from interface: StorableCodec
        +
        Encode a key by extracting all the primary key properties from the given + storable.
        +
        +
        Specified by:
        +
        encodePrimaryKey in interface StorableCodec<S extends Storable>
        +
        Parameters:
        values - values to build into a key. The length may be less than + the amount of primary key properties used by this factory. It must not + be less than the difference between rangeStart and rangeEnd.
        rangeStart - index of first property to use. Its value must be less + than the count of primary key properties.
        rangeEnd - index of last property to use, exlusive. Its value must + be less than or equal to the count of primary key properties.
        +
        Returns:
        raw search key
        +
        • +
      + + + +
        +
      • +

        encodePrimaryKeyPrefix

        +
        public byte[] encodePrimaryKeyPrefix()
        +
        Description copied from interface: StorableCodec
        +
        Encode the primary key for when there are no values, but there may be a + prefix. Returned value may be null if no prefix is defined.
        +
        +
        Specified by:
        +
        encodePrimaryKeyPrefix in interface StorableCodec<S extends Storable>
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getStorableClass

        +
        public java.lang.Class<? extends S> getStorableClass()
        +
        Returns a concrete Storable implementation, which is fully + thread-safe. It has two constructors defined: + + 
        + public <init>(Storage, RawSupport);
+
+ public <init>(Storage, RawSupport, byte[] key, byte[] value);
+
        + + Convenience methods are provided in this class to instantiate the + generated Storable.
        +
        • +
      + + + +
        +
      • +

        getSearchKeyFactory

        +
        public GenericStorableCodec.SearchKeyFactory<S> getSearchKeyFactory(OrderedProperty<S>[] properties)
        +
        Returns a search key factory, which is useful for implementing indexes + and queries.
        +
        Parameters:
        properties - properties to build the search key from
        +
        • +
      + + + + + +
        +
      • +

        decode

        +
        public void decode(S dest,
+          int generation,
+          byte[] data)
+            throws CorruptEncodingException
        +
        Description copied from interface: StorableCodec
        +
        Used for decoding different generations of Storable. If layout + generations are not supported, simply throw a CorruptEncodingException.
        +
        +
        Specified by:
        +
        decode in interface StorableCodec<S extends Storable>
        +
        Parameters:
        dest - storable to receive decoded properties
        generation - storable layout generation number
        data - decoded into properties, some of which may be dropped if + destination storable doesn't have it
        +
        Throws:
        +
        CorruptEncodingException - if generation is unknown or if data cannot be decoded
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/GenericStorableCodecFactory.html b/apidocs/com/amazon/carbonado/raw/GenericStorableCodecFactory.html new file mode 100644 index 0000000..4e2076c --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GenericStorableCodecFactory.html @@ -0,0 +1,406 @@ + + + + + + +GenericStorableCodecFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class GenericStorableCodecFactory

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    StorableCodecFactory
    +
    +
    +
    Direct Known Subclasses:
    +
    CompressedStorableCodecFactory
    +
    +
    +
    +
    public class GenericStorableCodecFactory
+extends java.lang.Object
+implements StorableCodecFactory
    +
    Factory for generic codec that supports any kind of storable by + auto-generating and caching storable implementations.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GenericStorableCodecFactory

        +
        public GenericStorableCodecFactory()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        createCodec

        +
        public <S extends Storable> GenericStorableCodec<S> createCodec(java.lang.Class<S> type,
+                                                       StorableIndex pkIndex,
+                                                       boolean isMaster,
+                                                       Layout layout)
+                                                     throws SupportException
        +
        +
        Specified by:
        +
        createCodec in interface StorableCodecFactory
        +
        Parameters:
        type - type of storable to create codec for
        pkIndex - suggested index for primary key (optional)
        isMaster - when true, version properties and sequences are managed
        layout - when non-null, encode a storable layout generation + value in one or four bytes. Generation 0..127 is encoded in one byte, and + 128..max is encoded in four bytes, with the most significant bit set.
        +
        Throws:
        +
        SupportException - if type is not supported
        +
        • +
      + + + +
        +
      • +

        createCodec

        +
        public <S extends Storable> GenericStorableCodec<S> createCodec(java.lang.Class<S> type,
+                                                       StorableIndex pkIndex,
+                                                       boolean isMaster,
+                                                       Layout layout,
+                                                       RawSupport support)
+                                                     throws SupportException
        +
        +
        Specified by:
        +
        createCodec in interface StorableCodecFactory
        +
        Parameters:
        type - type of storable to create codec for
        pkIndex - suggested index for primary key (optional)
        isMaster - when true, version properties and sequences are managed
        layout - when non-null, encode a storable layout generation + value in one or four bytes. Generation 0..127 is encoded in one byte, and + 128..max is encoded in four bytes, with the most significant bit set.
        support - binds generated storable with a storage layer
        +
        Throws:
        +
        SupportException - if type is not supported
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        createStrategy

        +
        protected <S extends Storable> GenericEncodingStrategy<S> createStrategy(java.lang.Class<S> type,
+                                                             StorableIndex<S> pkIndex)
+                                                              throws SupportException
        +
        Override to return a different EncodingStrategy.
        +
        Parameters:
        type - type of Storable to generate code for
        pkIndex - specifies sequence and ordering of key properties (optional)
        +
        Throws:
        +
        SupportException
        +
        • +
      + + + +
        +
      • +

        createStrategy

        +
        protected <S extends Storable> GenericEncodingStrategy<S> createStrategy(java.lang.Class<S> type,
+                                                             StorableIndex<S> pkIndex,
+                                                             LayoutOptions options)
+                                                              throws SupportException
        +
        Override to return a different EncodingStrategy.
        +
        Parameters:
        type - type of Storable to generate code for
        pkIndex - specifies sequence and ordering of key properties (optional)
        options - additional layout options (optional)
        +
        Throws:
        +
        SupportException
        Since:
        +
        1.2.1
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/GzipCompressor.html b/apidocs/com/amazon/carbonado/raw/GzipCompressor.html new file mode 100644 index 0000000..c00b111 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GzipCompressor.html @@ -0,0 +1,294 @@ + + + + + + +GzipCompressor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class GzipCompressor

+
+
+ +
+
    +
  • +
    +
    +
    public class GzipCompressor
+extends java.lang.Object
    +
    Raw-level data compression using gzip.
    +
    Author:
    +
    Olga Kuznetsova, Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      GzipCompressor() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static byte[]compress(byte[] value, + int prefix) +
      Encodes into compressed form.
      +
      static byte[]decompress(byte[] value, + int prefix) +
      Decodes from compressed form.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GzipCompressor

        +
        public GzipCompressor()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compress

        +
        public static byte[] compress(byte[] value,
+              int prefix)
+                       throws SupportException
        +
        Encodes into compressed form.
        +
        Parameters:
        value - value to compress
        prefix - prefix of byte array to preserve
        +
        Returns:
        compressed value
        +
        Throws:
        +
        SupportException - thrown if compression failed
        +
        • +
      + + + +
        +
      • +

        decompress

        +
        public static byte[] decompress(byte[] value,
+                int prefix)
+                         throws CorruptEncodingException
        +
        Decodes from compressed form.
        +
        Parameters:
        value - value to decompress
        prefix - prefix of byte array to preserve
        +
        Returns:
        decompressed value
        +
        Throws:
        +
        CorruptEncodingException - thrown if value cannot be decompressed
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/KeyDecoder.html b/apidocs/com/amazon/carbonado/raw/KeyDecoder.html new file mode 100644 index 0000000..d46933a --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/KeyDecoder.html @@ -0,0 +1,936 @@ + + + + + + +KeyDecoder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class KeyDecoder

+
+
+ +
+
    +
  • +
    +
    +
    public class KeyDecoder
+extends java.lang.Object
    +
    A very low-level class that decodes key components encoded by methods of + KeyEncoder.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    DataDecoder
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      KeyDecoder() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static intdecode(byte[] src, + int srcOffset, + java.math.BigDecimal[] valueRef) +
      Decodes the given BigDecimal as originally encoded for ascending order.
      +
      static intdecode(byte[] src, + int srcOffset, + java.math.BigInteger[] valueRef) +
      Decodes the given BigInteger as originally encoded for ascending order.
      +
      static intdecode(byte[] src, + int srcOffset, + byte[][] valueRef) +
      Decodes the given byte array as originally encoded for ascending order.
      +
      static booleandecodeBooleanDesc(byte[] src, + int srcOffset) +
      Decodes a boolean from exactly 1 byte, as encoded for descending order.
      +
      static java.lang.BooleandecodeBooleanObjDesc(byte[] src, + int srcOffset) +
      Decodes a Boolean object from exactly 1 byte, as encoded for descending + order.
      +
      static bytedecodeByteDesc(byte[] src, + int srcOffset) +
      Decodes a signed byte from exactly 1 byte, as encoded for descending + order.
      +
      static java.lang.BytedecodeByteObjDesc(byte[] src, + int srcOffset) +
      Decodes a signed Byte object from exactly 1 or 2 bytes, as encoded for + descending order.
      +
      static java.lang.CharacterdecodeCharacterObjDesc(byte[] src, + int srcOffset) +
      Decodes a Character object from exactly 1 or 3 bytes, as encoded for + descending order.
      +
      static chardecodeCharDesc(byte[] src, + int srcOffset) +
      Decodes a char from exactly 2 bytes, as encoded for descending order.
      +
      static intdecodeDesc(byte[] src, + int srcOffset, + java.math.BigDecimal[] valueRef) +
      Decodes the given BigDecimal as originally encoded for descending order.
      +
      static intdecodeDesc(byte[] src, + int srcOffset, + java.math.BigInteger[] valueRef) +
      Decodes the given BigInteger as originally encoded for descending order.
      +
      static intdecodeDesc(byte[] src, + int srcOffset, + byte[][] valueRef) +
      Decodes the given byte array as originally encoded for descending order.
      +
      static doubledecodeDoubleDesc(byte[] src, + int srcOffset) +
      Decodes a double from exactly 8 bytes, as encoded for descending order.
      +
      static java.lang.DoubledecodeDoubleObjDesc(byte[] src, + int srcOffset) +
      Decodes a Double object from exactly 8 bytes.
      +
      static floatdecodeFloatDesc(byte[] src, + int srcOffset) +
      Decodes a float from exactly 4 bytes, as encoded for descending order.
      +
      static java.lang.FloatdecodeFloatObjDesc(byte[] src, + int srcOffset) +
      Decodes a Float object from exactly 4 bytes.
      +
      static intdecodeIntDesc(byte[] src, + int srcOffset) +
      Decodes a signed integer from exactly 4 bytes, as encoded for descending + order.
      +
      static java.lang.IntegerdecodeIntegerObjDesc(byte[] src, + int srcOffset) +
      Decodes a signed Integer object from exactly 1 or 5 bytes, as encoded + for descending order.
      +
      static longdecodeLongDesc(byte[] src, + int srcOffset) +
      Decodes a signed long from exactly 8 bytes, as encoded for descending + order.
      +
      static java.lang.LongdecodeLongObjDesc(byte[] src, + int srcOffset) +
      Decodes a signed Long object from exactly 1 or 9 bytes, as encoded for + descending order.
      +
      static shortdecodeShortDesc(byte[] src, + int srcOffset) +
      Decodes a signed short from exactly 2 bytes, as encoded for descending + order.
      +
      static java.lang.ShortdecodeShortObjDesc(byte[] src, + int srcOffset) +
      Decodes a signed Short object from exactly 1 or 3 bytes, as encoded for + descending order.
      +
      static byte[]decodeSingleDesc(byte[] src) +
      Decodes the given byte array which was encoded by KeyEncoder.encodeSingleDesc(byte[]).
      +
      static byte[]decodeSingleDesc(byte[] src, + int prefixPadding, + int suffixPadding) +
      Decodes the given byte array which was encoded by KeyEncoder.encodeSingleDesc(byte[]).
      +
      static byte[]decodeSingleNullableDesc(byte[] src) +
      Decodes the given byte array which was encoded by KeyEncoder.encodeSingleNullableDesc(byte[]).
      +
      static byte[]decodeSingleNullableDesc(byte[] src, + int prefixPadding, + int suffixPadding) +
      Decodes the given byte array which was encoded by KeyEncoder.encodeSingleNullableDesc(byte[]).
      +
      static intdecodeString(byte[] src, + int srcOffset, + java.lang.String[] valueRef) +
      Decodes an encoded string from the given byte array.
      +
      static intdecodeStringDesc(byte[] src, + int srcOffset, + java.lang.String[] valueRef) +
      Decodes an encoded string from the given byte array as originally + encoded for descending order.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        KeyDecoder

        +
        public KeyDecoder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        decodeIntDesc

        +
        public static int decodeIntDesc(byte[] src,
+                int srcOffset)
+                         throws CorruptEncodingException
        +
        Decodes a signed integer from exactly 4 bytes, as encoded for descending + order.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed integer value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeIntegerObjDesc

        +
        public static java.lang.Integer decodeIntegerObjDesc(byte[] src,
+                                     int srcOffset)
+                                              throws CorruptEncodingException
        +
        Decodes a signed Integer object from exactly 1 or 5 bytes, as encoded + for descending order. If null is returned, then 1 byte was read.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed Integer object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeLongDesc

        +
        public static long decodeLongDesc(byte[] src,
+                  int srcOffset)
+                           throws CorruptEncodingException
        +
        Decodes a signed long from exactly 8 bytes, as encoded for descending + order.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed long value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeLongObjDesc

        +
        public static java.lang.Long decodeLongObjDesc(byte[] src,
+                               int srcOffset)
+                                        throws CorruptEncodingException
        +
        Decodes a signed Long object from exactly 1 or 9 bytes, as encoded for + descending order. If null is returned, then 1 byte was read.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed Long object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeByteDesc

        +
        public static byte decodeByteDesc(byte[] src,
+                  int srcOffset)
+                           throws CorruptEncodingException
        +
        Decodes a signed byte from exactly 1 byte, as encoded for descending + order.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed byte value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeByteObjDesc

        +
        public static java.lang.Byte decodeByteObjDesc(byte[] src,
+                               int srcOffset)
+                                        throws CorruptEncodingException
        +
        Decodes a signed Byte object from exactly 1 or 2 bytes, as encoded for + descending order. If null is returned, then 1 byte was read.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed Byte object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeShortDesc

        +
        public static short decodeShortDesc(byte[] src,
+                    int srcOffset)
+                             throws CorruptEncodingException
        +
        Decodes a signed short from exactly 2 bytes, as encoded for descending + order.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed short value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeShortObjDesc

        +
        public static java.lang.Short decodeShortObjDesc(byte[] src,
+                                 int srcOffset)
+                                          throws CorruptEncodingException
        +
        Decodes a signed Short object from exactly 1 or 3 bytes, as encoded for + descending order. If null is returned, then 1 byte was read.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed Short object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeCharDesc

        +
        public static char decodeCharDesc(byte[] src,
+                  int srcOffset)
+                           throws CorruptEncodingException
        +
        Decodes a char from exactly 2 bytes, as encoded for descending order.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        char value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeCharacterObjDesc

        +
        public static java.lang.Character decodeCharacterObjDesc(byte[] src,
+                                         int srcOffset)
+                                                  throws CorruptEncodingException
        +
        Decodes a Character object from exactly 1 or 3 bytes, as encoded for + descending order. If null is returned, then 1 byte was read.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        Character object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeBooleanDesc

        +
        public static boolean decodeBooleanDesc(byte[] src,
+                        int srcOffset)
+                                 throws CorruptEncodingException
        +
        Decodes a boolean from exactly 1 byte, as encoded for descending order.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        boolean value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeBooleanObjDesc

        +
        public static java.lang.Boolean decodeBooleanObjDesc(byte[] src,
+                                     int srcOffset)
+                                              throws CorruptEncodingException
        +
        Decodes a Boolean object from exactly 1 byte, as encoded for descending + order.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        Boolean object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeFloatDesc

        +
        public static float decodeFloatDesc(byte[] src,
+                    int srcOffset)
+                             throws CorruptEncodingException
        +
        Decodes a float from exactly 4 bytes, as encoded for descending order.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        float value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeFloatObjDesc

        +
        public static java.lang.Float decodeFloatObjDesc(byte[] src,
+                                 int srcOffset)
+                                          throws CorruptEncodingException
        +
        Decodes a Float object from exactly 4 bytes.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        Float object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeDoubleDesc

        +
        public static double decodeDoubleDesc(byte[] src,
+                      int srcOffset)
+                               throws CorruptEncodingException
        +
        Decodes a double from exactly 8 bytes, as encoded for descending order.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        double value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeDoubleObjDesc

        +
        public static java.lang.Double decodeDoubleObjDesc(byte[] src,
+                                   int srcOffset)
+                                            throws CorruptEncodingException
        +
        Decodes a Double object from exactly 8 bytes.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        Double object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decode

        +
        public static int decode(byte[] src,
+         int srcOffset,
+         java.math.BigInteger[] valueRef)
+                  throws CorruptEncodingException
        +
        Decodes the given BigInteger as originally encoded for ascending order.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded BigInteger is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        decodeDesc

        +
        public static int decodeDesc(byte[] src,
+             int srcOffset,
+             java.math.BigInteger[] valueRef)
+                      throws CorruptEncodingException
        +
        Decodes the given BigInteger as originally encoded for descending order.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded BigInteger is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        decode

        +
        public static int decode(byte[] src,
+         int srcOffset,
+         java.math.BigDecimal[] valueRef)
+                  throws CorruptEncodingException
        +
        Decodes the given BigDecimal as originally encoded for ascending order.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded BigDecimal is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        decodeDesc

        +
        public static int decodeDesc(byte[] src,
+             int srcOffset,
+             java.math.BigDecimal[] valueRef)
+                      throws CorruptEncodingException
        +
        Decodes the given BigDecimal as originally encoded for descending order.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded BigDecimal is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        decode

        +
        public static int decode(byte[] src,
+         int srcOffset,
+         byte[][] valueRef)
+                  throws CorruptEncodingException
        +
        Decodes the given byte array as originally encoded for ascending order. + The decoding stops when any kind of terminator or illegal byte has been + read. The decoded bytes are stored in valueRef.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded byte array is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        +
        • +
      + + + +
        +
      • +

        decodeDesc

        +
        public static int decodeDesc(byte[] src,
+             int srcOffset,
+             byte[][] valueRef)
+                      throws CorruptEncodingException
        +
        Decodes the given byte array as originally encoded for descending order. + The decoding stops when any kind of terminator or illegal byte has been + read. The decoded bytes are stored in valueRef.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded byte array is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        +
        • +
      + + + +
        +
      • +

        decodeString

        +
        public static int decodeString(byte[] src,
+               int srcOffset,
+               java.lang.String[] valueRef)
+                        throws CorruptEncodingException
        +
        Decodes an encoded string from the given byte array.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded string is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        +
        • +
      + + + +
        +
      • +

        decodeStringDesc

        +
        public static int decodeStringDesc(byte[] src,
+                   int srcOffset,
+                   java.lang.String[] valueRef)
+                            throws CorruptEncodingException
        +
        Decodes an encoded string from the given byte array as originally + encoded for descending order.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded string is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        +
        • +
      + + + + + + + +
        +
      • +

        decodeSingleDesc

        +
        public static byte[] decodeSingleDesc(byte[] src,
+                      int prefixPadding,
+                      int suffixPadding)
+                               throws CorruptEncodingException
        +
        Decodes the given byte array which was encoded by KeyEncoder.encodeSingleDesc(byte[]). Always returns a new byte array instance.
        +
        Parameters:
        prefixPadding - amount of extra bytes to skip from start of encoded byte array
        suffixPadding - amount of extra bytes to skip at end of encoded byte array
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + + + + + +
        +
      • +

        decodeSingleNullableDesc

        +
        public static byte[] decodeSingleNullableDesc(byte[] src,
+                              int prefixPadding,
+                              int suffixPadding)
+                                       throws CorruptEncodingException
        +
        Decodes the given byte array which was encoded by KeyEncoder.encodeSingleNullableDesc(byte[]). Always returns a new byte array + instance.
        +
        Parameters:
        prefixPadding - amount of extra bytes to skip from start of encoded byte array
        suffixPadding - amount of extra bytes to skip at end of encoded byte array
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/KeyEncoder.html b/apidocs/com/amazon/carbonado/raw/KeyEncoder.html new file mode 100644 index 0000000..12b1a29 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/KeyEncoder.html @@ -0,0 +1,1086 @@ + + + + + + +KeyEncoder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class KeyEncoder

+
+
+ +
+
    +
  • +
    +
    +
    public class KeyEncoder
+extends java.lang.Object
    +
    A very low-level class that supports encoding of primitive data into unique, + sortable byte array keys. If the data to encode is of a variable size, then + it is written in base-32768, using only byte values 32..223. This allows + special values such as nulls and terminators to be unambiguously + encoded. Terminators for variable data can be encoded using 1 for ascending + order and 254 for descending order. Nulls can be encoded as 255 for high + ordering and 0 for low ordering.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    KeyDecoder, +DataEncoder
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      KeyEncoder() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static intcalculateEncodedLength(java.math.BigDecimal value) +
      Returns the amount of bytes required to encode a BigDecimal.
      +
      static intcalculateEncodedLength(java.math.BigInteger value) +
      Returns the amount of bytes required to encode a BigInteger.
      +
      static intcalculateEncodedLength(byte[] value) +
      Returns the amount of bytes required to encode a byte array of the given + length.
      +
      static intcalculateEncodedLength(byte[] value, + int valueOffset, + int valueLength) +
      Returns the amount of bytes required to encode the given byte array.
      +
      static intcalculateEncodedStringLength(java.lang.String value) +
      Returns the amount of bytes required to encode the given String.
      +
      static intencode(java.math.BigDecimal value, + byte[] dst, + int dstOffset) +
      Encodes the given optional BigDecimal into a variable amount of + bytes.
      +
      static intencode(java.math.BigInteger value, + byte[] dst, + int dstOffset) +
      Encodes the given optional BigInteger into a variable amount of + bytes.
      +
      static intencode(byte[] value, + byte[] dst, + int dstOffset) +
      Encodes the given optional unsigned byte array into a variable amount of + bytes.
      +
      static intencode(byte[] value, + int valueOffset, + int valueLength, + byte[] dst, + int dstOffset) +
      Encodes the given optional unsigned byte array into a variable amount of + bytes.
      +
      static intencode(java.lang.String value, + byte[] dst, + int dstOffset) +
      Encodes the given optional String into a variable amount of bytes.
      +
      static intencodeDesc(java.math.BigDecimal value, + byte[] dst, + int dstOffset) +
      Encodes the given optional BigDecimal into a variable amount of bytes + for descending order.
      +
      static intencodeDesc(java.math.BigInteger value, + byte[] dst, + int dstOffset) +
      Encodes the given optional BigInteger into a variable amount of bytes + for descending order.
      +
      static voidencodeDesc(boolean value, + byte[] dst, + int dstOffset) +
      Encodes the given boolean into exactly 1 byte for descending order.
      +
      static voidencodeDesc(java.lang.Boolean value, + byte[] dst, + int dstOffset) +
      Encodes the given Boolean object into exactly 1 byte for descending + order.
      +
      static intencodeDesc(byte[] value, + byte[] dst, + int dstOffset) +
      Encodes the given optional unsigned byte array into a variable amount of + bytes for descending order.
      +
      static intencodeDesc(byte[] value, + int valueOffset, + int valueLength, + byte[] dst, + int dstOffset) +
      Encodes the given optional unsigned byte array into a variable amount of + bytes for descending order.
      +
      static voidencodeDesc(byte value, + byte[] dst, + int dstOffset) +
      Encodes the given signed byte into exactly 1 byte for descending order.
      +
      static intencodeDesc(java.lang.Byte value, + byte[] dst, + int dstOffset) +
      Encodes the given signed Byte object into exactly 1 or 2 bytes for + descending order.
      +
      static intencodeDesc(java.lang.Character value, + byte[] dst, + int dstOffset) +
      Encodes the given Character object into exactly 1 or 3 bytes for + descending order.
      +
      static voidencodeDesc(char value, + byte[] dst, + int dstOffset) +
      Encodes the given character into exactly 2 bytes for descending order.
      +
      static voidencodeDesc(double value, + byte[] dst, + int dstOffset) +
      Encodes the given double into exactly 8 bytes for descending order.
      +
      static voidencodeDesc(java.lang.Double value, + byte[] dst, + int dstOffset) +
      Encodes the given Double object into exactly 8 bytes for descending + order.
      +
      static voidencodeDesc(float value, + byte[] dst, + int dstOffset) +
      Encodes the given float into exactly 4 bytes for descending order.
      +
      static voidencodeDesc(java.lang.Float value, + byte[] dst, + int dstOffset) +
      Encodes the given Float object into exactly 4 bytes for descending + order.
      +
      static voidencodeDesc(int value, + byte[] dst, + int dstOffset) +
      Encodes the given signed integer into exactly 4 bytes for descending + order.
      +
      static intencodeDesc(java.lang.Integer value, + byte[] dst, + int dstOffset) +
      Encodes the given signed Integer object into exactly 1 or 5 bytes for + descending order.
      +
      static voidencodeDesc(long value, + byte[] dst, + int dstOffset) +
      Encodes the given signed long into exactly 8 bytes for descending order.
      +
      static intencodeDesc(java.lang.Long value, + byte[] dst, + int dstOffset) +
      Encodes the given signed Long object into exactly 1 or 9 bytes for + descending order.
      +
      static voidencodeDesc(short value, + byte[] dst, + int dstOffset) +
      Encodes the given signed short into exactly 2 bytes for descending + order.
      +
      static intencodeDesc(java.lang.Short value, + byte[] dst, + int dstOffset) +
      Encodes the given signed Short object into exactly 1 or 3 bytes for + descending order.
      +
      static intencodeDesc(java.lang.String value, + byte[] dst, + int dstOffset) +
      Encodes the given optional String into a variable amount of bytes for + descending order.
      +
      static byte[]encodeSingleDesc(byte[] value) +
      Encodes the given byte array for use when there is only a single + required property, descending order, whose type is a byte array.
      +
      static byte[]encodeSingleDesc(byte[] value, + int prefixPadding, + int suffixPadding) +
      Encodes the given byte array for use when there is only a single + required property, descending order, whose type is a byte array.
      +
      static byte[]encodeSingleNullableDesc(byte[] value) +
      Encodes the given byte array for use when there is only a single + nullable property, descending order, whose type is a byte array.
      +
      static byte[]encodeSingleNullableDesc(byte[] value, + int prefixPadding, + int suffixPadding) +
      Encodes the given byte array for use when there is only a single + nullable property, descending order, whose type is a byte array.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        KeyEncoder

        +
        public KeyEncoder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        encodeDesc

        +
        public static void encodeDesc(int value,
+              byte[] dst,
+              int dstOffset)
        +
        Encodes the given signed integer into exactly 4 bytes for descending + order.
        +
        Parameters:
        value - signed integer value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static int encodeDesc(java.lang.Integer value,
+             byte[] dst,
+             int dstOffset)
        +
        Encodes the given signed Integer object into exactly 1 or 5 bytes for + descending order. If the Integer object is never expected to be null, + consider encoding as an int primitive.
        +
        Parameters:
        value - optional signed Integer value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static void encodeDesc(long value,
+              byte[] dst,
+              int dstOffset)
        +
        Encodes the given signed long into exactly 8 bytes for descending order.
        +
        Parameters:
        value - signed long value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static int encodeDesc(java.lang.Long value,
+             byte[] dst,
+             int dstOffset)
        +
        Encodes the given signed Long object into exactly 1 or 9 bytes for + descending order. If the Long object is never expected to be null, + consider encoding as a long primitive.
        +
        Parameters:
        value - optional signed Long value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static void encodeDesc(byte value,
+              byte[] dst,
+              int dstOffset)
        +
        Encodes the given signed byte into exactly 1 byte for descending order.
        +
        Parameters:
        value - signed byte value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static int encodeDesc(java.lang.Byte value,
+             byte[] dst,
+             int dstOffset)
        +
        Encodes the given signed Byte object into exactly 1 or 2 bytes for + descending order. If the Byte object is never expected to be null, + consider encoding as a byte primitive.
        +
        Parameters:
        value - optional signed Byte value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static void encodeDesc(short value,
+              byte[] dst,
+              int dstOffset)
        +
        Encodes the given signed short into exactly 2 bytes for descending + order.
        +
        Parameters:
        value - signed short value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static int encodeDesc(java.lang.Short value,
+             byte[] dst,
+             int dstOffset)
        +
        Encodes the given signed Short object into exactly 1 or 3 bytes for + descending order. If the Short object is never expected to be null, + consider encoding as a short primitive.
        +
        Parameters:
        value - optional signed Short value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static void encodeDesc(char value,
+              byte[] dst,
+              int dstOffset)
        +
        Encodes the given character into exactly 2 bytes for descending order.
        +
        Parameters:
        value - character value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static int encodeDesc(java.lang.Character value,
+             byte[] dst,
+             int dstOffset)
        +
        Encodes the given Character object into exactly 1 or 3 bytes for + descending order. If the Character object is never expected to be null, + consider encoding as a char primitive.
        +
        Parameters:
        value - optional Character value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static void encodeDesc(boolean value,
+              byte[] dst,
+              int dstOffset)
        +
        Encodes the given boolean into exactly 1 byte for descending order.
        +
        Parameters:
        value - boolean value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static void encodeDesc(java.lang.Boolean value,
+              byte[] dst,
+              int dstOffset)
        +
        Encodes the given Boolean object into exactly 1 byte for descending + order.
        +
        Parameters:
        value - optional Boolean value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static void encodeDesc(float value,
+              byte[] dst,
+              int dstOffset)
        +
        Encodes the given float into exactly 4 bytes for descending order.
        +
        Parameters:
        value - float value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static void encodeDesc(java.lang.Float value,
+              byte[] dst,
+              int dstOffset)
        +
        Encodes the given Float object into exactly 4 bytes for descending + order. A non-canonical NaN value is used to represent null.
        +
        Parameters:
        value - optional Float value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static void encodeDesc(double value,
+              byte[] dst,
+              int dstOffset)
        +
        Encodes the given double into exactly 8 bytes for descending order.
        +
        Parameters:
        value - double value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static void encodeDesc(java.lang.Double value,
+              byte[] dst,
+              int dstOffset)
        +
        Encodes the given Double object into exactly 8 bytes for descending + order. A non-canonical NaN value is used to represent null.
        +
        Parameters:
        value - optional Double value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(java.math.BigInteger value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given optional BigInteger into a variable amount of + bytes. If the BigInteger is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.
        +
        Parameters:
        value - BigInteger value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static int encodeDesc(java.math.BigInteger value,
+             byte[] dst,
+             int dstOffset)
        +
        Encodes the given optional BigInteger into a variable amount of bytes + for descending order. If the BigInteger is null, exactly 1 byte is + written. Otherwise, the amount written can be determined by calling + calculateEncodedLength.
        +
        Parameters:
        value - BigInteger value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        calculateEncodedLength

        +
        public static int calculateEncodedLength(java.math.BigInteger value)
        +
        Returns the amount of bytes required to encode a BigInteger.
        +
        Parameters:
        value - BigInteger value to encode, may be null
        +
        Returns:
        amount of bytes needed to encode
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(java.math.BigDecimal value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given optional BigDecimal into a variable amount of + bytes. If the BigDecimal is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength. + +

        Note: It is recommended that value be normalized by stripping + trailing zeros. This makes searching by value much simpler.

        +
        Parameters:
        value - BigDecimal value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static int encodeDesc(java.math.BigDecimal value,
+             byte[] dst,
+             int dstOffset)
        +
        Encodes the given optional BigDecimal into a variable amount of bytes + for descending order. If the BigDecimal is null, exactly 1 byte is + written. Otherwise, the amount written can be determined by calling + calculateEncodedLength. + +

        Note: It is recommended that value be normalized by stripping + trailing zeros. This makes searching by value much simpler.

        +
        Parameters:
        value - BigDecimal value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        calculateEncodedLength

        +
        public static int calculateEncodedLength(java.math.BigDecimal value)
        +
        Returns the amount of bytes required to encode a BigDecimal. + +

        Note: It is recommended that value be normalized by stripping + trailing zeros. This makes searching by value much simpler.

        +
        Parameters:
        value - BigDecimal value to encode, may be null
        +
        Returns:
        amount of bytes needed to encode
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(byte[] value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given optional unsigned byte array into a variable amount of + bytes. If the byte array is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.
        +
        Parameters:
        value - byte array value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(byte[] value,
+         int valueOffset,
+         int valueLength,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given optional unsigned byte array into a variable amount of + bytes. If the byte array is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.
        +
        Parameters:
        value - byte array value to encode, may be null
        valueOffset - offset into byte array
        valueLength - length of data in byte array
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static int encodeDesc(byte[] value,
+             byte[] dst,
+             int dstOffset)
        +
        Encodes the given optional unsigned byte array into a variable amount of + bytes for descending order. If the byte array is null, exactly 1 byte is + written. Otherwise, the amount written is determined by calling + calculateEncodedLength.
        +
        Parameters:
        value - byte array value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static int encodeDesc(byte[] value,
+             int valueOffset,
+             int valueLength,
+             byte[] dst,
+             int dstOffset)
        +
        Encodes the given optional unsigned byte array into a variable amount of + bytes for descending order. If the byte array is null, exactly 1 byte is + written. Otherwise, the amount written is determined by calling + calculateEncodedLength.
        +
        Parameters:
        value - byte array value to encode, may be null
        valueOffset - offset into byte array
        valueLength - length of data in byte array
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        calculateEncodedLength

        +
        public static int calculateEncodedLength(byte[] value)
        +
        Returns the amount of bytes required to encode a byte array of the given + length.
        +
        Parameters:
        value - byte array value to encode, may be null
        +
        Returns:
        amount of bytes needed to encode
        +
        • +
      + + + +
        +
      • +

        calculateEncodedLength

        +
        public static int calculateEncodedLength(byte[] value,
+                         int valueOffset,
+                         int valueLength)
        +
        Returns the amount of bytes required to encode the given byte array.
        +
        Parameters:
        value - byte array value to encode, may be null
        valueOffset - offset into byte array
        valueLength - length of data in byte array
        +
        Returns:
        amount of bytes needed to encode
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(java.lang.String value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given optional String into a variable amount of bytes. The + amount written can be determined by calling + calculateEncodedStringLength. +

        + Strings are encoded in a fashion similar to UTF-8, in that ASCII + characters are usually written in one byte. This encoding is more + efficient than UTF-8, but it isn't compatible with UTF-8.

        +
        Parameters:
        value - String value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static int encodeDesc(java.lang.String value,
+             byte[] dst,
+             int dstOffset)
        +
        Encodes the given optional String into a variable amount of bytes for + descending order. The amount written can be determined by calling + calculateEncodedStringLength. +

        + Strings are encoded in a fashion similar to UTF-8, in that ASCII + characters are usually written in one byte. This encoding is more + efficient than UTF-8, but it isn't compatible with UTF-8.

        +
        Parameters:
        value - String value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        calculateEncodedStringLength

        +
        public static int calculateEncodedStringLength(java.lang.String value)
        +
        Returns the amount of bytes required to encode the given String.
        +
        Parameters:
        value - String to encode, may be null
        +
        • +
      + + + +
        +
      • +

        encodeSingleDesc

        +
        public static byte[] encodeSingleDesc(byte[] value)
        +
        Encodes the given byte array for use when there is only a single + required property, descending order, whose type is a byte array. The + original byte array is returned if the length is zero.
        +
        • +
      + + + +
        +
      • +

        encodeSingleDesc

        +
        public static byte[] encodeSingleDesc(byte[] value,
+                      int prefixPadding,
+                      int suffixPadding)
        +
        Encodes the given byte array for use when there is only a single + required property, descending order, whose type is a byte array. The + original byte array is returned if the length and padding lengths are + zero.
        +
        Parameters:
        prefixPadding - amount of extra bytes to allocate at start of encoded byte array
        suffixPadding - amount of extra bytes to allocate at end of encoded byte array
        +
        • +
      + + + +
        +
      • +

        encodeSingleNullableDesc

        +
        public static byte[] encodeSingleNullableDesc(byte[] value)
        +
        Encodes the given byte array for use when there is only a single + nullable property, descending order, whose type is a byte array.
        +
        • +
      + + + +
        +
      • +

        encodeSingleNullableDesc

        +
        public static byte[] encodeSingleNullableDesc(byte[] value,
+                              int prefixPadding,
+                              int suffixPadding)
        +
        Encodes the given byte array for use when there is only a single + nullable property, descending order, whose type is a byte array.
        +
        Parameters:
        prefixPadding - amount of extra bytes to allocate at start of encoded byte array
        suffixPadding - amount of extra bytes to allocate at end of encoded byte array
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/RawCursor.html b/apidocs/com/amazon/carbonado/raw/RawCursor.html new file mode 100644 index 0000000..b11229d --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/RawCursor.html @@ -0,0 +1,854 @@ + + + + + + +RawCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class RawCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public abstract class RawCursor<S>
+extends AbstractCursor<S>
    +
    Abstract Cursor implementation for a repository that manipulates raw bytes.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      protected java.util.concurrent.locks.LockmLock +
      Lock object, as passed into the constructor
      +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected RawCursor(java.util.concurrent.locks.Lock lock, + byte[] startBound, + boolean inclusiveStart, + byte[] endBound, + boolean inclusiveEnd, + int maxPrefix, + boolean reverse) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      protected intcompareKeysPartially(byte[] key1, + byte[] key2) +
      Returns <0 if key1 is less, 0 if equal (at least partially), + >0 if key1 is greater.
      +
      protected voiddisableKeyAndValue() +
      An optimization hint which disables key and value acquisition.
      +
      protected voiddisableValue() +
      An optimization hint which disables just value acquisition.
      +
      protected voidenableKeyAndValue() +
      Enable key and value acquisition again, after they have been + disabled.
      +
      protected abstract byte[]getCurrentKey() +
      Returns the contents of the current key being referenced, or null + otherwise.
      +
      protected abstract byte[]getCurrentValue() +
      Returns the contents of the current value being referenced, or null + otherwise.
      +
      protected voidhandleNoSuchElement() +
      Called right before throwing NoSuchElementException.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      protected abstract SinstantiateCurrent() +
      Returns a new Storable instance for the currently referenced entry.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      protected abstract voidrelease() +
      Release any internal resources, called when closed.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      protected abstract booleantoFirst() +
      Move the cursor to the first available entry.
      +
      protected abstract booleantoFirst(byte[] key) +
      Move the cursor to the first available entry at or after the given + key.
      +
      protected abstract booleantoLast() +
      Move the cursor to the last available entry.
      +
      protected abstract booleantoLast(byte[] key) +
      Move the cursor to the last available entry at or before the given + key.
      +
      protected abstract booleantoNext() +
      Move the cursor to the next available entry, returning false if none.
      +
      protected inttoNext(int amount) +
      Move the cursor to the next available entry, incrementing by the amount + given.
      +
      protected booleantoNextKey() +
      Move the cursor to the next unique key, returning false if none.
      +
      protected abstract booleantoPrevious() +
      Move the cursor to the previous available entry, returning false if + none.
      +
      protected inttoPrevious(int amount) +
      Move the cursor to the previous available entry, decrementing by the + amount given.
      +
      protected booleantoPreviousKey() +
      Move the cursor to the previous unique key, returning false if none.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        mLock

        +
        protected final java.util.concurrent.locks.Lock mLock
        +
        Lock object, as passed into the constructor
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RawCursor

        +
        protected RawCursor(java.util.concurrent.locks.Lock lock,
+         byte[] startBound,
+         boolean inclusiveStart,
+         byte[] endBound,
+         boolean inclusiveEnd,
+         int maxPrefix,
+         boolean reverse)
        +
        Parameters:
        lock - operations lock on this object
        startBound - specify the starting key for the cursor, or null if first
        inclusiveStart - true if start bound is inclusive
        endBound - specify the ending key for the cursor, or null if last
        inclusiveEnd - true if end bound is inclusive
        maxPrefix - maximum expected common initial bytes in start and end bound
        reverse - when true, iteration is reversed
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any bound is null but is not inclusive
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException,
+              java.util.NoSuchElementException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        java.util.NoSuchElementException - if the cursor has no next element.
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<S>
        +
        Overrides:
        +
        skipNext in class AbstractCursor<S>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        release

        +
        protected abstract void release()
+                         throws FetchException
        +
        Release any internal resources, called when closed.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        getCurrentKey

        +
        protected abstract byte[] getCurrentKey()
+                                 throws FetchException
        +
        Returns the contents of the current key being referenced, or null + otherwise. Caller is responsible for making a copy of the key. The array + must not be modified concurrently. + +

        If cursor is not opened, null must be returned.

        +
        Returns:
        currently referenced key bytes or null if no current
        +
        Throws:
        +
        java.lang.IllegalStateException - if key is disabled
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        getCurrentValue

        +
        protected abstract byte[] getCurrentValue()
+                                   throws FetchException
        +
        Returns the contents of the current value being referenced, or null + otherwise. Caller is responsible for making a copy of the value. The + array must not be modified concurrently. + +

        If cursor is not opened, null must be returned.

        +
        Returns:
        currently referenced value bytes or null if no current
        +
        Throws:
        +
        java.lang.IllegalStateException - if value is disabled
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        disableKeyAndValue

        +
        protected void disableKeyAndValue()
        +
        An optimization hint which disables key and value acquisition. The + default implementation of this method does nothing.
        +
        • +
      + + + +
        +
      • +

        disableValue

        +
        protected void disableValue()
        +
        An optimization hint which disables just value acquisition. The default + implementation of this method does nothing.
        +
        • +
      + + + +
        +
      • +

        enableKeyAndValue

        +
        protected void enableKeyAndValue()
+                          throws FetchException
        +
        Enable key and value acquisition again, after they have been + disabled. Calling this method forces the key and value to be + re-acquired, if they had been disabled. Key and value acquisition must + be enabled by default. The default implementation of this method does + nothing.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        instantiateCurrent

        +
        protected abstract S instantiateCurrent()
+                                 throws FetchException
        +
        Returns a new Storable instance for the currently referenced entry.
        +
        Returns:
        new Storable instance, never null
        +
        Throws:
        +
        java.lang.IllegalStateException - if no current entry to instantiate
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        toFirst

        +
        protected abstract boolean toFirst()
+                            throws FetchException
        +
        Move the cursor to the first available entry. If false is returned, the + cursor must be positioned before the first available entry.
        +
        Returns:
        true if first entry exists and is now current
        +
        Throws:
        +
        java.lang.IllegalStateException - if cursor is not opened
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        toFirst

        +
        protected abstract boolean toFirst(byte[] key)
+                            throws FetchException
        +
        Move the cursor to the first available entry at or after the given + key. If false is returned, the cursor must be positioned before the + first available entry. Caller is responsible for preserving contents of + array.
        +
        Parameters:
        key - key to search for
        +
        Returns:
        true if first entry exists and is now current
        +
        Throws:
        +
        java.lang.IllegalStateException - if cursor is not opened
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        toLast

        +
        protected abstract boolean toLast()
+                           throws FetchException
        +
        Move the cursor to the last available entry. If false is returned, the + cursor must be positioned after the last available entry.
        +
        Returns:
        true if last entry exists and is now current
        +
        Throws:
        +
        java.lang.IllegalStateException - if cursor is not opened
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        toLast

        +
        protected abstract boolean toLast(byte[] key)
+                           throws FetchException
        +
        Move the cursor to the last available entry at or before the given + key. If false is returned, the cursor must be positioned after the last + available entry. Caller is responsible for preserving contents of array.
        +
        Parameters:
        key - key to search for
        +
        Returns:
        true if last entry exists and is now current
        +
        Throws:
        +
        java.lang.IllegalStateException - if cursor is not opened
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        toNext

        +
        protected abstract boolean toNext()
+                           throws FetchException
        +
        Move the cursor to the next available entry, returning false if none. If + false is returned, the cursor must be positioned after the last + available entry.
        +
        Returns:
        true if moved to next entry
        +
        Throws:
        +
        java.lang.IllegalStateException - if cursor is not opened
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        toNext

        +
        protected int toNext(int amount)
+              throws FetchException
        +
        Move the cursor to the next available entry, incrementing by the amount + given. The actual amount incremented is returned. If the amount is less + then requested, the cursor must be positioned after the last available + entry. Subclasses may wish to override this method with a faster + implementation. + +

        Calling to toNext(1) is equivalent to calling toNext().

        +
        Parameters:
        amount - positive amount to advance
        +
        Returns:
        actual amount advanced
        +
        Throws:
        +
        java.lang.IllegalStateException - if cursor is not opened
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        toNextKey

        +
        protected boolean toNextKey()
+                     throws FetchException
        +
        Move the cursor to the next unique key, returning false if none. If + false is returned, the cursor must be positioned after the last + available entry. Subclasses may wish to override this method with a + faster implementation.
        +
        Returns:
        true if moved to next unique key
        +
        Throws:
        +
        java.lang.IllegalStateException - if cursor is not opened
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        toPrevious

        +
        protected abstract boolean toPrevious()
+                               throws FetchException
        +
        Move the cursor to the previous available entry, returning false if + none. If false is returned, the cursor must be positioned before the + first available entry.
        +
        Returns:
        true if moved to previous entry
        +
        Throws:
        +
        java.lang.IllegalStateException - if cursor is not opened
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        toPrevious

        +
        protected int toPrevious(int amount)
+                  throws FetchException
        +
        Move the cursor to the previous available entry, decrementing by the + amount given. The actual amount decremented is returned. If the amount + is less then requested, the cursor must be positioned before the first + available entry. Subclasses may wish to override this method with a + faster implementation. + +

        Calling to toPrevious(1) is equivalent to calling toPrevious().

        +
        Parameters:
        amount - positive amount to retreat
        +
        Returns:
        actual amount retreated
        +
        Throws:
        +
        java.lang.IllegalStateException - if cursor is not opened
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        toPreviousKey

        +
        protected boolean toPreviousKey()
+                         throws FetchException
        +
        Move the cursor to the previous unique key, returning false if none. If + false is returned, the cursor must be positioned before the first + available entry. Subclasses may wish to override this method with a + faster implementation.
        +
        Returns:
        true if moved to previous unique key
        +
        Throws:
        +
        java.lang.IllegalStateException - if cursor is not opened
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        compareKeysPartially

        +
        protected int compareKeysPartially(byte[] key1,
+                       byte[] key2)
        +
        Returns <0 if key1 is less, 0 if equal (at least partially), + >0 if key1 is greater.
        +
        • +
      + + + +
        +
      • +

        handleNoSuchElement

        +
        protected void handleNoSuchElement()
+                            throws FetchException
        +
        Called right before throwing NoSuchElementException. Subclasses may + override to do special checks or throw a different exception.
        +
        Throws:
        +
        FetchException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/RawStorableGenerator.html b/apidocs/com/amazon/carbonado/raw/RawStorableGenerator.html new file mode 100644 index 0000000..f4fe114 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/RawStorableGenerator.html @@ -0,0 +1,365 @@ + + + + + + +RawStorableGenerator (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class RawStorableGenerator

+
+
+ +
+
    +
  • +
    +
    +
    public class RawStorableGenerator
+extends java.lang.Object
    +
    Generates and caches abstract implementations of Storable types + which are encoded and decoded in a raw format. The generated abstract + classes extend those created by MasterStorableGenerator.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    GenericStorableCodec, +RawSupport
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.lang.StringDECODE_DATA_METHOD_NAME +
      Name of protected abstract method in generated storable
      +
      static java.lang.StringDECODE_KEY_METHOD_NAME +
      Name of protected abstract method in generated storable
      +
      static java.lang.StringENCODE_DATA_METHOD_NAME +
      Name of protected abstract method in generated storable
      +
      static java.lang.StringENCODE_KEY_METHOD_NAME +
      Name of protected abstract method in generated storable
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static <S extends Storable> 
      java.lang.Class<? extends S>      		getAbstractClass(java.lang.Class<S> type, + boolean isMaster) +
      Returns an abstract implementation of the given Storable type, which is + fully thread-safe.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        ENCODE_KEY_METHOD_NAME

        +
        public static final java.lang.String ENCODE_KEY_METHOD_NAME
        +
        Name of protected abstract method in generated storable
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        DECODE_KEY_METHOD_NAME

        +
        public static final java.lang.String DECODE_KEY_METHOD_NAME
        +
        Name of protected abstract method in generated storable
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        ENCODE_DATA_METHOD_NAME

        +
        public static final java.lang.String ENCODE_DATA_METHOD_NAME
        +
        Name of protected abstract method in generated storable
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        DECODE_DATA_METHOD_NAME

        +
        public static final java.lang.String DECODE_DATA_METHOD_NAME
        +
        Name of protected abstract method in generated storable
        +
        See Also:
        Constant Field Values
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAbstractClass

        +
        public static <S extends Storable> java.lang.Class<? extends S> getAbstractClass(java.lang.Class<S> type,
+                                                                 boolean isMaster)
+                                                                      throws SupportException,
+                                                                             java.lang.IllegalArgumentException
        +
        Returns an abstract implementation of the given Storable type, which is + fully thread-safe. The Storable type itself may be an interface or a + class. If it is a class, then it must not be final, and it must have a + public, no-arg constructor. Three constructors are defined for the + abstract implementation: + + 
        + public <init>(RawSupport);
+
+ public <init>(RawSupport, byte[] key);
+
+ public <init>(RawSupport, byte[] key, byte[] value);
+
        + +

        Subclasses must implement the following abstract protected methods, + whose exact names are defined by constants in this class: + + 

        + // Encode the primary key of this storable.
+ protected abstract byte[] encodeKey();
+
+ // Encode all properties of this storable excluding the primary key.
+ protected abstract byte[] encodeData();
+
+ // Decode the primary key into properties of this storable.
+ // Note: this method is also invoked by the three argument constructor.
+ protected abstract void decodeKey(byte[]);
+
+ // Decode the data into properties of this storable.
+ // Note: this method is also invoked by the three argument constructor.
+ protected abstract void decodeData(byte[]);
+
        +
        Parameters:
        isMaster - when true, version properties, sequences, and triggers are managed
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if type is null
        +
        SupportException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/RawSupport.html b/apidocs/com/amazon/carbonado/raw/RawSupport.html new file mode 100644 index 0000000..b8aa31a --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/RawSupport.html @@ -0,0 +1,452 @@ + + + + + + +RawSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Interface RawSupport<S extends Storable>

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiddecode(S dest, + int generation, + byte[] data) +
      Used for decoding different generations of Storable.
      +
      BlobgetBlob(S storable, + java.lang.String name, + long locator) +
      Returns the Blob for the given locator, returning null if not found.
      +
      ClobgetClob(S storable, + java.lang.String name, + long locator) +
      Returns the Clob for the given locator, returning null if not found.
      +
      longgetLocator(Blob blob) +
      Returns the locator for the given Blob, returning zero if null.
      +
      longgetLocator(Clob clob) +
      Returns the locator for the given Clob, returning zero if null.
      +
      voidstore(S storable, + byte[] key, + byte[] value) +
      Try to store the entry referenced by the given key with the given + value.
      +
      booleantryDelete(S storable, + byte[] key) +
      Try to delete the entry referenced by the given key.
      +
      booleantryInsert(S storable, + byte[] key, + byte[] value) +
      Try to insert the entry referenced by the given key with the given + value.
      +
      byte[]tryLoad(S storable, + byte[] key) +
      Try to load the entry referenced by the given key, but return null + if not found.
      +
      + + + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        tryLoad

        +
        byte[] tryLoad(S storable,
+             byte[] key)
+               throws FetchException
        +
        Try to load the entry referenced by the given key, but return null + if not found.
        +
        Parameters:
        storable - user storable which will have its properties set
        key - non-null key to search for
        +
        Returns:
        non-null value that was found, or null if not found
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + + + +
        +
      • +

        tryInsert

        +
        boolean tryInsert(S storable,
+                byte[] key,
+                byte[] value)
+                  throws PersistException
        +
        Try to insert the entry referenced by the given key with the given + value.
        +
        Parameters:
        storable - user storable that key and value were derived from
        key - non-null key to insert
        value - non-null value to insert
        +
        Returns:
        false if unique constraint prevents insert
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        store

        +
        void store(S storable,
+         byte[] key,
+         byte[] value)
+           throws PersistException
        +
        Try to store the entry referenced by the given key with the given + value. If the entry does not exist, insert it. Otherwise, update it.
        +
        Parameters:
        storable - user storable that key and value were derived from
        key - non-null key to store
        value - non-null value to store
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        tryDelete

        +
        boolean tryDelete(S storable,
+                byte[] key)
+                  throws PersistException
        +
        Try to delete the entry referenced by the given key.
        +
        Parameters:
        storable - user supplied storable object
        key - non-null key to delete
        +
        Returns:
        true if entry existed and is now deleted
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        getBlob

        +
        Blob getBlob(S storable,
+           java.lang.String name,
+           long locator)
+             throws FetchException
        +
        Returns the Blob for the given locator, returning null if not found.
        +
        Parameters:
        storable - storable that contains Blob
        name - name of Blob property
        locator - Blob locator
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        getLocator

        +
        long getLocator(Blob blob)
+                throws PersistException
        +
        Returns the locator for the given Blob, returning zero if null.
        +
        Throws:
        +
        PersistException - if blob is unrecognized
        +
        • +
      + + + + + +
        +
      • +

        getClob

        +
        Clob getClob(S storable,
+           java.lang.String name,
+           long locator)
+             throws FetchException
        +
        Returns the Clob for the given locator, returning null if not found.
        +
        Parameters:
        storable - storable that contains Blob
        name - name of Clob property
        locator - Clob locator
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        getLocator

        +
        long getLocator(Clob clob)
+                throws PersistException
        +
        Returns the locator for the given Clob, returning zero if null.
        +
        Throws:
        +
        PersistException - if blob is unrecognized
        +
        • +
      + + + + + +
        +
      • +

        decode

        +
        void decode(S dest,
+          int generation,
+          byte[] data)
+            throws CorruptEncodingException
        +
        Used for decoding different generations of Storable. If layout + generations are not supported, simply throw a CorruptEncodingException.
        +
        Parameters:
        dest - storable to receive decoded properties
        generation - storable layout generation number
        data - decoded into properties, some of which may be dropped if + destination storable doesn't have it
        +
        Throws:
        +
        CorruptEncodingException - if generation is unknown or if data cannot be decoded
        Since:
        +
        1.2.1
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/RawUtil.html b/apidocs/com/amazon/carbonado/raw/RawUtil.html new file mode 100644 index 0000000..2ff4fd1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/RawUtil.html @@ -0,0 +1,286 @@ + + + + + + +RawUtil (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class RawUtil

+
+
+ +
+
    +
  • +
    +
    +
    public class RawUtil
+extends java.lang.Object
    +
    Utilities for manipulating binary data.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      RawUtil() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static booleandecrement(byte[] value) +
      Subtracts one from an unsigned integer, represented as a byte array.
      +
      static booleanincrement(byte[] value) +
      Adds one to an unsigned integer, represented as a byte array.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RawUtil

        +
        public RawUtil()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        increment

        +
        public static boolean increment(byte[] value)
        +
        Adds one to an unsigned integer, represented as a byte array. If + overflowed, value in byte array is 0x00, 0x00, 0x00...
        +
        Parameters:
        value - unsigned integer to increment
        +
        Returns:
        false if overflowed
        +
        • +
      + + + +
        +
      • +

        decrement

        +
        public static boolean decrement(byte[] value)
        +
        Subtracts one from an unsigned integer, represented as a byte array. If + overflowed, value in byte array is 0xff, 0xff, 0xff...
        +
        Parameters:
        value - unsigned integer to decrement
        +
        Returns:
        false if overflowed
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/StorableCodec.html b/apidocs/com/amazon/carbonado/raw/StorableCodec.html new file mode 100644 index 0000000..f647b5b --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/StorableCodec.html @@ -0,0 +1,529 @@ + + + + + + +StorableCodec (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Interface StorableCodec<S extends Storable>

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiddecode(S dest, + int generation, + byte[] data) +
      Used for decoding different generations of Storable.
      +
      byte[]encodePrimaryKey(java.lang.Object[] values) +
      Encode a key by extracting all the primary key properties from the given + storable.
      +
      byte[]encodePrimaryKey(java.lang.Object[] values, + int rangeStart, + int rangeEnd) +
      Encode a key by extracting all the primary key properties from the given + storable.
      +
      byte[]encodePrimaryKey(S storable) +
      Encode a key by extracting all the primary key properties from the given + storable.
      +
      byte[]encodePrimaryKey(S storable, + int rangeStart, + int rangeEnd) +
      Encode a key by extracting all the primary key properties from the given + storable.
      +
      byte[]encodePrimaryKeyPrefix() +
      Encode the primary key for when there are no values, but there may be a + prefix.
      +
      StorableIndex<S>getPrimaryKeyIndex() +
      Returns the sequence and directions of properties that make up the + primary key.
      +
      intgetPrimaryKeyPrefixLength() +
      Returns the number of prefix bytes in the primary key, which may be + zero.
      +
      java.lang.Class<S>getStorableType() +
      Returns the type of Storable produced by this codec.
      +
      RawSupport<S>getSupport() +
      Returns the default RawSupport object that is supplied to + Storable instances produced by this codec.
      +
      Sinstantiate() +
      Instantiate a Storable with no key or value defined yet.
      +
      Sinstantiate(byte[] key) +
      Instantiate a Storable with no value defined yet.
      +
      Sinstantiate(byte[] key, + byte[] value) +
      Instantiate a Storable with a specific key and value.
      +
      Sinstantiate(RawSupport<S> support) +
      Instantiate a Storable with no key or value defined yet.
      +
      Sinstantiate(RawSupport<S> support, + byte[] key, + byte[] value) +
      Instantiate a Storable with a specific key and value.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStorableType

        +
        java.lang.Class<S> getStorableType()
        +
        Returns the type of Storable produced by this codec.
        +
        • +
      + + + +
        +
      • +

        instantiate

        +
        S instantiate()
        +
        Instantiate a Storable with no key or value defined yet. The default + RawSupport is supplied to the instance.
        +
        Throws:
        +
        java.lang.IllegalStateException - if no default support exists
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        instantiate

        +
        S instantiate(byte[] key)
+                               throws FetchException
        +
        Instantiate a Storable with no value defined yet. The default RawSupport is supplied to the instance.
        +
        Throws:
        +
        java.lang.IllegalStateException - if no default support exists
        +
        FetchException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        instantiate

        +
        S instantiate(byte[] key,
+            byte[] value)
+                               throws FetchException
        +
        Instantiate a Storable with a specific key and value. The default + RawSupport is supplied to the instance.
        +
        Throws:
        +
        java.lang.IllegalStateException - if no default support exists
        +
        FetchException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        instantiate

        +
        S instantiate(RawSupport<S> support)
        +
        Instantiate a Storable with no key or value defined yet. Any + RawSupport can be supplied to the instance.
        +
        Parameters:
        support - binds generated storable with a storage layer
        +
        • +
      + + + +
        +
      • +

        instantiate

        +
        S instantiate(RawSupport<S> support,
+            byte[] key,
+            byte[] value)
+                               throws FetchException
        +
        Instantiate a Storable with a specific key and value. Any + RawSupport can be supplied to the instance.
        +
        Parameters:
        support - binds generated storable with a storage layer
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        getPrimaryKeyIndex

        +
        StorableIndex<S> getPrimaryKeyIndex()
        +
        Returns the sequence and directions of properties that make up the + primary key.
        +
        • +
      + + + +
        +
      • +

        getPrimaryKeyPrefixLength

        +
        int getPrimaryKeyPrefixLength()
        +
        Returns the number of prefix bytes in the primary key, which may be + zero.
        +
        • +
      + + + + + +
        +
      • +

        encodePrimaryKey

        +
        byte[] encodePrimaryKey(S storable)
        +
        Encode a key by extracting all the primary key properties from the given + storable.
        +
        Parameters:
        storable - extract primary key properties from this instance
        +
        Returns:
        raw search key
        +
        • +
      + + + + + +
        +
      • +

        encodePrimaryKey

        +
        byte[] encodePrimaryKey(S storable,
+                      int rangeStart,
+                      int rangeEnd)
        +
        Encode a key by extracting all the primary key properties from the given + storable.
        +
        Parameters:
        storable - extract primary key properties from this instance
        rangeStart - index of first property to use. Its value must be less + than the count of primary key properties.
        rangeEnd - index of last property to use, exlusive. Its value must + be less than or equal to the count of primary key properties.
        +
        Returns:
        raw search key
        +
        • +
      + + + +
        +
      • +

        encodePrimaryKey

        +
        byte[] encodePrimaryKey(java.lang.Object[] values)
        +
        Encode a key by extracting all the primary key properties from the given + storable.
        +
        Parameters:
        values - values to build into a key. It must be long enough to + accommodate all primary key properties.
        +
        Returns:
        raw search key
        +
        • +
      + + + +
        +
      • +

        encodePrimaryKey

        +
        byte[] encodePrimaryKey(java.lang.Object[] values,
+                      int rangeStart,
+                      int rangeEnd)
        +
        Encode a key by extracting all the primary key properties from the given + storable.
        +
        Parameters:
        values - values to build into a key. The length may be less than + the amount of primary key properties used by this factory. It must not + be less than the difference between rangeStart and rangeEnd.
        rangeStart - index of first property to use. Its value must be less + than the count of primary key properties.
        rangeEnd - index of last property to use, exlusive. Its value must + be less than or equal to the count of primary key properties.
        +
        Returns:
        raw search key
        +
        • +
      + + + +
        +
      • +

        encodePrimaryKeyPrefix

        +
        byte[] encodePrimaryKeyPrefix()
        +
        Encode the primary key for when there are no values, but there may be a + prefix. Returned value may be null if no prefix is defined.
        +
        • +
      + + + + + +
        +
      • +

        decode

        +
        void decode(S dest,
+          int generation,
+          byte[] data)
+            throws CorruptEncodingException
        +
        Used for decoding different generations of Storable. If layout + generations are not supported, simply throw a CorruptEncodingException.
        +
        Parameters:
        dest - storable to receive decoded properties
        generation - storable layout generation number
        data - decoded into properties, some of which may be dropped if + destination storable doesn't have it
        +
        Throws:
        +
        CorruptEncodingException - if generation is unknown or if data cannot be decoded
        Since:
        +
        1.2.1
        +
        • +
      + + + +
        +
      • +

        getSupport

        +
        RawSupport<S> getSupport()
        +
        Returns the default RawSupport object that is supplied to + Storable instances produced by this codec.
        +
        Since:
        +
        1.2
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/StorableCodecFactory.html b/apidocs/com/amazon/carbonado/raw/StorableCodecFactory.html new file mode 100644 index 0000000..9a19a87 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/StorableCodecFactory.html @@ -0,0 +1,291 @@ + + + + + + +StorableCodecFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Interface StorableCodecFactory

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStorageName

        +
        java.lang.String getStorageName(java.lang.Class<? extends Storable> type)
+                                throws SupportException
        +
        Returns the preferred storage/database name for the given type. Return + null to let repository decide.
        +
        Throws:
        +
        SupportException - if type is not supported
        +
        • +
      + + + +
        +
      • +

        getLayoutOptions

        +
        LayoutOptions getLayoutOptions(java.lang.Class<? extends Storable> type)
        +
        Optionally return additional information regarding storable encoding.
        +
        Since:
        +
        1.2.1
        +
        • +
      + + + +
        +
      • +

        createCodec

        +
        <S extends Storable> StorableCodec<S> createCodec(java.lang.Class<S> type,
+                                                StorableIndex pkIndex,
+                                                boolean isMaster,
+                                                Layout layout)
+                                              throws SupportException
        +
        Parameters:
        type - type of storable to create codec for
        pkIndex - suggested index for primary key (optional)
        isMaster - when true, version properties and sequences are managed
        layout - when non-null, attempt to encode a storable layout + generation value in each storable
        +
        Throws:
        +
        SupportException - if type is not supported
        +
        • +
      + + + +
        +
      • +

        createCodec

        +
        <S extends Storable> StorableCodec<S> createCodec(java.lang.Class<S> type,
+                                                StorableIndex pkIndex,
+                                                boolean isMaster,
+                                                Layout layout,
+                                                RawSupport support)
+                                              throws SupportException
        +
        Parameters:
        type - type of storable to create codec for
        pkIndex - suggested index for primary key (optional)
        isMaster - when true, version properties and sequences are managed
        layout - when non-null, attempt to encode a storable layout + generation value in each storable
        support - binds generated storable with a storage layer
        +
        Throws:
        +
        SupportException - if type is not supported
        Since:
        +
        1.2
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/StorablePropertyInfo.html b/apidocs/com/amazon/carbonado/raw/StorablePropertyInfo.html new file mode 100644 index 0000000..02749bc --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/StorablePropertyInfo.html @@ -0,0 +1,474 @@ + + + + + + +StorablePropertyInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class StorablePropertyInfo

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidaddInvokeReadMethod(org.cojen.classfile.CodeAssembler a) 
      voidaddInvokeReadMethod(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.TypeDesc instanceType) 
      voidaddInvokeWriteMethod(org.cojen.classfile.CodeAssembler a) 
      voidaddInvokeWriteMethod(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.TypeDesc instanceType) 
      java.lang.reflect.MethodgetFromStorageAdapter() +
      Returns the optional method used to adapt the property from the + storage supported type to the user visible type.
      +
      java.lang.StringgetPropertyName() 
      org.cojen.classfile.TypeDescgetPropertyType() +
      Returns the user specified property type.
      +
      java.lang.StringgetReadMethodName() 
      org.cojen.classfile.TypeDescgetStorageType() +
      Returns the storage supported type.
      +
      java.lang.reflect.MethodgetToStorageAdapter() +
      Returns the optional method used to adapt the property from the user + visible type to the storage supported type.
      +
      java.lang.StringgetWriteMethodName() 
      booleanisDerived() 
      booleanisLob() 
      booleanisNullable() 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        getStorageType

        +
        public org.cojen.classfile.TypeDesc getStorageType()
        +
        Description copied from interface: GenericPropertyInfo
        +
        Returns the storage supported type. If it differs from the property + type, then adapter methods must also exist.
        +
        +
        Specified by:
        +
        getStorageType in interface GenericPropertyInfo
        +
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        getFromStorageAdapter

        +
        public java.lang.reflect.Method getFromStorageAdapter()
        +
        Description copied from interface: GenericPropertyInfo
        +
        Returns the optional method used to adapt the property from the + storage supported type to the user visible type.
        +
        +
        Specified by:
        +
        getFromStorageAdapter in interface GenericPropertyInfo
        +
        +
        • +
      + + + +
        +
      • +

        getToStorageAdapter

        +
        public java.lang.reflect.Method getToStorageAdapter()
        +
        Description copied from interface: GenericPropertyInfo
        +
        Returns the optional method used to adapt the property from the user + visible type to the storage supported type.
        +
        +
        Specified by:
        +
        getToStorageAdapter in interface GenericPropertyInfo
        +
        +
        • +
      + + + +
        +
      • +

        getReadMethodName

        +
        public java.lang.String getReadMethodName()
        +
        • +
      + + + +
        +
      • +

        addInvokeReadMethod

        +
        public void addInvokeReadMethod(org.cojen.classfile.CodeAssembler a)
        +
        • +
      + + + +
        +
      • +

        addInvokeReadMethod

        +
        public void addInvokeReadMethod(org.cojen.classfile.CodeAssembler a,
+                       org.cojen.classfile.TypeDesc instanceType)
        +
        • +
      + + + +
        +
      • +

        getWriteMethodName

        +
        public java.lang.String getWriteMethodName()
        +
        • +
      + + + +
        +
      • +

        addInvokeWriteMethod

        +
        public void addInvokeWriteMethod(org.cojen.classfile.CodeAssembler a)
        +
        • +
      + + + +
        +
      • +

        addInvokeWriteMethod

        +
        public void addInvokeWriteMethod(org.cojen.classfile.CodeAssembler a,
+                        org.cojen.classfile.TypeDesc instanceType)
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.raw.CompressedEncodingStrategy

+
+
No usage of com.amazon.carbonado.raw.CompressedEncodingStrategy
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.raw.CompressedStorableCodecFactory

+
+
No usage of com.amazon.carbonado.raw.CompressedStorableCodecFactory
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.raw.CompressionType

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

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

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

Uses of Interface
com.amazon.carbonado.raw.CustomStorableCodec.InstanceFactory

+
+
No usage of com.amazon.carbonado.raw.CustomStorableCodec.InstanceFactory
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.raw.CustomStorableCodec

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

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

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

Uses of Class
com.amazon.carbonado.raw.CustomStorableCodecFactory

+
+
No usage of com.amazon.carbonado.raw.CustomStorableCodecFactory
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.raw.DataDecoder

+
+
No usage of com.amazon.carbonado.raw.DataDecoder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.raw.DataEncoder

+
+
No usage of com.amazon.carbonado.raw.DataEncoder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/class-use/GenericEncodingStrategy.html b/apidocs/com/amazon/carbonado/raw/class-use/GenericEncodingStrategy.html new file mode 100644 index 0000000..68d3703 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/GenericEncodingStrategy.html @@ -0,0 +1,192 @@ + + + + + + +Uses of Class com.amazon.carbonado.raw.GenericEncodingStrategy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.raw.GenericEncodingStrategy

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

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

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

Uses of Interface
com.amazon.carbonado.raw.GenericInstanceFactory

+
+
No usage of com.amazon.carbonado.raw.GenericInstanceFactory
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/class-use/GenericPropertyInfo.html b/apidocs/com/amazon/carbonado/raw/class-use/GenericPropertyInfo.html new file mode 100644 index 0000000..1670e50 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/GenericPropertyInfo.html @@ -0,0 +1,160 @@ + + + + + + +Uses of Interface com.amazon.carbonado.raw.GenericPropertyInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.raw.GenericPropertyInfo

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.Decoder.html b/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.Decoder.html new file mode 100644 index 0000000..1b7b1c8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.Decoder.html @@ -0,0 +1,164 @@ + + + + + + +Uses of Interface com.amazon.carbonado.raw.GenericStorableCodec.Decoder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.raw.GenericStorableCodec.Decoder

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.SearchKeyFactory.html b/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.SearchKeyFactory.html new file mode 100644 index 0000000..0b6e280 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.SearchKeyFactory.html @@ -0,0 +1,163 @@ + + + + + + +Uses of Interface com.amazon.carbonado.raw.GenericStorableCodec.SearchKeyFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.raw.GenericStorableCodec.SearchKeyFactory

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.html b/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.html new file mode 100644 index 0000000..44d6215 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.html @@ -0,0 +1,171 @@ + + + + + + +Uses of Class com.amazon.carbonado.raw.GenericStorableCodec (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.raw.GenericStorableCodec

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

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

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

Uses of Class
com.amazon.carbonado.raw.GenericStorableCodecFactory

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/raw/class-use/GzipCompressor.html b/apidocs/com/amazon/carbonado/raw/class-use/GzipCompressor.html new file mode 100644 index 0000000..36b65b6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/GzipCompressor.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.raw.GzipCompressor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.raw.GzipCompressor

+
+
No usage of com.amazon.carbonado.raw.GzipCompressor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/raw/class-use/KeyDecoder.html b/apidocs/com/amazon/carbonado/raw/class-use/KeyDecoder.html new file mode 100644 index 0000000..4e70647 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/KeyDecoder.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.raw.KeyDecoder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.raw.KeyDecoder

+
+
No usage of com.amazon.carbonado.raw.KeyDecoder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/raw/class-use/KeyEncoder.html b/apidocs/com/amazon/carbonado/raw/class-use/KeyEncoder.html new file mode 100644 index 0000000..f7f134d --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/KeyEncoder.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.raw.KeyEncoder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.raw.KeyEncoder

+
+
No usage of com.amazon.carbonado.raw.KeyEncoder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/raw/class-use/RawCursor.html b/apidocs/com/amazon/carbonado/raw/class-use/RawCursor.html new file mode 100644 index 0000000..3c80731 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/RawCursor.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.raw.RawCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.raw.RawCursor

+
+
No usage of com.amazon.carbonado.raw.RawCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/raw/class-use/RawStorableGenerator.html b/apidocs/com/amazon/carbonado/raw/class-use/RawStorableGenerator.html new file mode 100644 index 0000000..5b31f74 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/RawStorableGenerator.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.raw.RawStorableGenerator (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.raw.RawStorableGenerator

+
+
No usage of com.amazon.carbonado.raw.RawStorableGenerator
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/raw/class-use/RawSupport.html b/apidocs/com/amazon/carbonado/raw/class-use/RawSupport.html new file mode 100644 index 0000000..3ca6b5e --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/RawSupport.html @@ -0,0 +1,289 @@ + + + + + + +Uses of Interface com.amazon.carbonado.raw.RawSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.raw.RawSupport

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/raw/class-use/RawUtil.html b/apidocs/com/amazon/carbonado/raw/class-use/RawUtil.html new file mode 100644 index 0000000..a04452d --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/RawUtil.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.raw.RawUtil (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.raw.RawUtil

+
+
No usage of com.amazon.carbonado.raw.RawUtil
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/raw/class-use/StorableCodec.html b/apidocs/com/amazon/carbonado/raw/class-use/StorableCodec.html new file mode 100644 index 0000000..852c901 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/StorableCodec.html @@ -0,0 +1,193 @@ + + + + + + +Uses of Interface com.amazon.carbonado.raw.StorableCodec (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.raw.StorableCodec

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/raw/class-use/StorableCodecFactory.html b/apidocs/com/amazon/carbonado/raw/class-use/StorableCodecFactory.html new file mode 100644 index 0000000..c8a7efd --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/StorableCodecFactory.html @@ -0,0 +1,217 @@ + + + + + + +Uses of Interface com.amazon.carbonado.raw.StorableCodecFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.raw.StorableCodecFactory

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/raw/class-use/StorablePropertyInfo.html b/apidocs/com/amazon/carbonado/raw/class-use/StorablePropertyInfo.html new file mode 100644 index 0000000..01b893b --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/StorablePropertyInfo.html @@ -0,0 +1,210 @@ + + + + + + +Uses of Class com.amazon.carbonado.raw.StorablePropertyInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.raw.StorablePropertyInfo

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/raw/package-frame.html b/apidocs/com/amazon/carbonado/raw/package-frame.html new file mode 100644 index 0000000..d4a3664 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/package-frame.html @@ -0,0 +1,50 @@ + + + + + + +com.amazon.carbonado.raw (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.raw

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/raw/package-summary.html b/apidocs/com/amazon/carbonado/raw/package-summary.html new file mode 100644 index 0000000..005f986 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/package-summary.html @@ -0,0 +1,319 @@ + + + + + + +com.amazon.carbonado.raw (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.raw

+
+
Provides support for repositories that encode/decode storables in a raw + binary format.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.raw Description

+
Provides support for repositories that encode/decode storables in a raw + binary format.
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/raw/package-tree.html b/apidocs/com/amazon/carbonado/raw/package-tree.html new file mode 100644 index 0000000..bb6c70a --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/package-tree.html @@ -0,0 +1,190 @@ + + + + + + +com.amazon.carbonado.raw Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.raw

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/raw/package-use.html b/apidocs/com/amazon/carbonado/raw/package-use.html new file mode 100644 index 0000000..8024cb2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/package-use.html @@ -0,0 +1,236 @@ + + + + + + +Uses of Package com.amazon.carbonado.raw (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.raw

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html b/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html new file mode 100644 index 0000000..53038eb --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html @@ -0,0 +1,226 @@ + + + + + + +IndexEntryAccessCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.indexed
+

Interface IndexEntryAccessCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface IndexEntryAccessCapability
+extends Capability
    +
    Capability for gaining low-level access to index data, which can be used for + manual inspection and repair.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      <S extends Storable> 
      IndexEntryAccessor<S>[]      		getIndexEntryAccessors(java.lang.Class<S> storableType) +
      Returns index entry accessors for the known indexes of the given + storable type.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getIndexEntryAccessors

        +
        <S extends Storable> IndexEntryAccessor<S>[] getIndexEntryAccessors(java.lang.Class<S> storableType)
+                                                                throws RepositoryException
        +
        Returns index entry accessors for the known indexes of the given + storable type. The array might be empty, but it is never null. The array + is a copy, and so it may be safely modified.
        +
        Throws:
        +
        RepositoryException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html b/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html new file mode 100644 index 0000000..7a61df5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html @@ -0,0 +1,346 @@ + + + + + + +IndexEntryAccessor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.indexed
+

Interface IndexEntryAccessor<S extends Storable>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    IndexInfo
    +
    +
    +
    +
    public interface IndexEntryAccessor<S extends Storable>
+extends IndexInfo
    +
    Provides low-level access to index data, which can be used for manual + inspection and repair.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    IndexEntryAccessCapability
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidcopyFromMaster(Storable indexEntry, + S master) +
      Sets all the properties of the given index entry, using the applicable + properties of the given master.
      +
      voidcopyToMasterPrimaryKey(Storable indexEntry, + S master) +
      Sets all the primary key properties of the given master, using the + applicable properties of the given index entry.
      +
      java.util.Comparator<? extends Storable>getComparator() +
      Returns a comparator for ordering index entries.
      +
      Storage<?>getIndexEntryStorage() +
      Returns the index entry storage.
      +
      booleanisConsistent(Storable indexEntry, + S master) +
      Returns true if the properties of the given index entry match those + contained in the master, exluding any version property.
      +
      voidrepair(double desiredSpeed) +
      Repairs the index by inserting missing entries and fixing + inconsistencies.
      +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getIndexEntryStorage

        +
        Storage<?> getIndexEntryStorage()
        +
        Returns the index entry storage.
        +
        • +
      + + + + + +
        +
      • +

        copyToMasterPrimaryKey

        +
        void copyToMasterPrimaryKey(Storable indexEntry,
+                          S master)
+                            throws FetchException
        +
        Sets all the primary key properties of the given master, using the + applicable properties of the given index entry.
        +
        Parameters:
        indexEntry - source of property values
        master - master whose primary key properties will be set
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + + + +
        +
      • +

        copyFromMaster

        +
        void copyFromMaster(Storable indexEntry,
+                  S master)
+                    throws FetchException
        +
        Sets all the properties of the given index entry, using the applicable + properties of the given master.
        +
        Parameters:
        indexEntry - index entry whose properties will be set
        master - source of property values
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + + + +
        +
      • +

        isConsistent

        +
        boolean isConsistent(Storable indexEntry,
+                   S master)
+                     throws FetchException
        +
        Returns true if the properties of the given index entry match those + contained in the master, exluding any version property. This will always + return true after a call to copyFromMaster.
        +
        Parameters:
        indexEntry - index entry whose properties will be tested
        master - source of property values
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        repair

        +
        void repair(double desiredSpeed)
+            throws RepositoryException
        +
        Repairs the index by inserting missing entries and fixing + inconsistencies.
        +
        Parameters:
        desiredSpeed - throttling parameter - 1.0 = full speed, 0.5 = half + speed, 0.1 = one-tenth speed, etc
        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        getComparator

        +
        java.util.Comparator<? extends Storable> getComparator()
        +
        Returns a comparator for ordering index entries.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html new file mode 100644 index 0000000..a18c2a3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html @@ -0,0 +1,616 @@ + + + + + + +IndexedRepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.repo.indexed
+

Class IndexedRepositoryBuilder

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      Repositorybuild(java.util.concurrent.atomic.AtomicReference<Repository> rootRef) +
      Builds a repository instance.
      +
      voiderrorCheck(java.util.Collection<java.lang.String> messages) +
      This method is called by assertReady, and subclasses must override to + perform custom checks.
      +
      doublegetIndexRepairThrottle() +
      Returns the throttle parameter used when indexes are added, dropped or + bulk repaired.
      +
      java.lang.StringgetName() +
      Returns the name of the repository.
      +
      RepositoryBuildergetWrappedRepository() 
      booleanisAllClustered() +
      Returns true if all indexes should be identified as clustered.
      +
      booleanisIndexRepairEnabled() 
      booleanisMaster() +
      Returns true if repository should assume the role of master, which is + true by default.
      +
      voidsetAllClustered(boolean clustered) +
      When all indexes are identified as clustered, the query analyzer treats + all indexes as performing equally well.
      +
      voidsetIndexRepairDiscardDuplicates(boolean discardDuplicates) +
      Set true to skip collisions during index repair, logging each as a + warning.
      +
      voidsetIndexRepairEnabled(boolean enabled) +
      By default, index repair is enabled.
      +
      voidsetIndexRepairThrottle(double desiredSpeed) +
      Sets the throttle parameter used when indexes are added, dropped or bulk + repaired.
      +
      voidsetIndexRepairVerifyOnly(boolean verifyOnly) +
      Set true to build and verify indexes, but don't apply any changes.
      +
      voidsetMaster(boolean b) +
      Set to false if repository should not assume the role of master.
      +
      voidsetName(java.lang.String name) +
      Set name for the repository, which is required.
      +
      voidsetStrictTriggers(boolean strict) +
      Set to true to require that index maintenance triggers use a "for update" transaction, + avoiding deadlocks and lock upgrade failures.
      +
      voidsetWrappedRepository(RepositoryBuilder repoBuilder) +
      Set the required wrapped respository, which must support the + IndexInfoCapability.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        IndexedRepositoryBuilder

        +
        public IndexedRepositoryBuilder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        build

        +
        public Repository build(java.util.concurrent.atomic.AtomicReference<Repository> rootRef)
+                 throws RepositoryException
        +
        Description copied from interface: RepositoryBuilder
        +
        Builds a repository instance. + +

        If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.

        +
        Parameters:
        rootRef - reference to root parent repository, to be set by + parent repository upon being built
        +
        Throws:
        +
        ConfigurationException - if there is a problem in the builder's configuration
        +
        RepositoryException - if there is a general problem opening the repository
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns the name of the repository.
        +
        • +
      + + + +
        +
      • +

        setName

        +
        public void setName(java.lang.String name)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set name for the repository, which is required.
        +
        • +
      + + + +
        +
      • +

        isMaster

        +
        public boolean isMaster()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        setMaster

        +
        public void setMaster(boolean b)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        getWrappedRepository

        +
        public RepositoryBuilder getWrappedRepository()
        +
        Returns:
        wrapped respository
        +
        • +
      + + + +
        +
      • +

        setWrappedRepository

        +
        public void setWrappedRepository(RepositoryBuilder repoBuilder)
        +
        Set the required wrapped respository, which must support the + IndexInfoCapability.
        +
        • +
      + + + + + + + +
        +
      • +

        setIndexRepairEnabled

        +
        public void setIndexRepairEnabled(boolean enabled)
        +
        By default, index repair is enabled. In this mode, the first time a + Storable type is used, new indexes are populated and old indexes are + removed. Until finished, access to the Storable is blocked. + +

        When index repair is disabled, the Storable is immediately + available. This does have consequences, however. The set of indexes + available for queries is defined by the intersection of the old + and new index sets. The set of indexes that are kept up-to-date is + defined by the union of the old and new index sets. + +

        While index repair is disabled, another process can safely repair the + indexes in the background. When it is complete, index repair can be + enabled for this repository too.

        +
        • +
      + + + +
        +
      • +

        getIndexRepairThrottle

        +
        public double getIndexRepairThrottle()
        +
        Returns the throttle parameter used when indexes are added, dropped or + bulk repaired. By default this value is 1.0, or maximum speed.
        +
        • +
      + + + +
        +
      • +

        setIndexRepairThrottle

        +
        public void setIndexRepairThrottle(double desiredSpeed)
        +
        Sets the throttle parameter used when indexes are added, dropped or bulk + repaired. By default this value is 1.0, or maximum speed.
        +
        Parameters:
        desiredSpeed - 1.0 = perform work at full speed, + 0.5 = perform work at half speed, 0.0 = fully suspend work
        +
        • +
      + + + +
        +
      • +

        setIndexRepairDiscardDuplicates

        +
        public void setIndexRepairDiscardDuplicates(boolean discardDuplicates)
        +
        Set true to skip collisions during index repair, logging each as a + warning.
        +
        • +
      + + + +
        +
      • +

        setIndexRepairVerifyOnly

        +
        public void setIndexRepairVerifyOnly(boolean verifyOnly)
        +
        Set true to build and verify indexes, but don't apply any changes.
        +
        • +
      + + + +
        +
      • +

        isAllClustered

        +
        public boolean isAllClustered()
        +
        Returns true if all indexes should be identified as clustered. This + affects how indexes are selected by the query analyzer.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        setAllClustered

        +
        public void setAllClustered(boolean clustered)
        +
        When all indexes are identified as clustered, the query analyzer treats + all indexes as performing equally well. This is suitable for indexing + repositories that never read from a slow storage medium.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        setStrictTriggers

        +
        public void setStrictTriggers(boolean strict)
        +
        Set to true to require that index maintenance triggers use a "for update" transaction, + avoiding deadlocks and lock upgrade failures.
        +
        • +
      + + + +
        +
      • +

        errorCheck

        +
        public void errorCheck(java.util.Collection<java.lang.String> messages)
+                throws ConfigurationException
        +
        Description copied from class: AbstractRepositoryBuilder
        +
        This method is called by assertReady, and subclasses must override to + perform custom checks. Be sure to call super.errorCheck as well.
        +
        +
        Overrides:
        +
        errorCheck in class AbstractRepositoryBuilder
        +
        Parameters:
        messages - add any error messages to this list
        +
        Throws:
        +
        ConfigurationException - if error checking indirectly caused + another exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/indexed/StoredIndexInfo.html b/apidocs/com/amazon/carbonado/repo/indexed/StoredIndexInfo.html new file mode 100644 index 0000000..9ce8482 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/StoredIndexInfo.html @@ -0,0 +1,375 @@ + + + + + + +StoredIndexInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.indexed
+

Interface StoredIndexInfo

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Storable, Unevolvable, Unindexed
    +
    +
    +
    +
    @PrimaryKey(value="indexName")
+@Independent
+@Alias(value="CARBONADO_INDEX_INFO")
+public interface StoredIndexInfo
+extends Storable, Unevolvable, Unindexed
    +
    Stores basic information about the indexes managed by IndexedRepository. + +

    Note: This storable cannot have indexes defined, since it is used to + discover information about indexes. It would create a cyclic dependency.

    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getIndexName

        +
        java.lang.String getIndexName()
        +
        Returns the index name, which is also a valid index name + descriptor. This descriptor is defined by StorableIndex. The name descriptor does not + contain type information.
        +
        • +
      + + + +
        +
      • +

        setIndexName

        +
        void setIndexName(java.lang.String name)
        +
        • +
      + + + +
        +
      • +

        getIndexTypeDescriptor

        +
        @Nullable
+java.lang.String getIndexTypeDescriptor()
        +
        Returns the types of the index properties. This descriptor is defined by + StorableIndex.
        +
        • +
      + + + +
        +
      • +

        setIndexTypeDescriptor

        +
        void setIndexTypeDescriptor(java.lang.String descriptor)
        +
        • +
      + + + +
        +
      • +

        getCreationTimestamp

        +
        long getCreationTimestamp()
        +
        Returns the milliseconds from 1970-01-01T00:00:00Z when this record was + created.
        +
        • +
      + + + +
        +
      • +

        setCreationTimestamp

        +
        void setCreationTimestamp(long timestamp)
        +
        • +
      + + + +
        +
      • +

        getVersionNumber

        +
        @Version
+int getVersionNumber()
        +
        Record version number for this StoredIndexInfo instance. Some encoding + strategies require a version number.
        +
        • +
      + + + +
        +
      • +

        setVersionNumber

        +
        void setVersionNumber(int version)
        +
        • +
      + + + +
        +
      • +

        getExtraData

        +
        @Nullable
+byte[] getExtraData()
        +
        Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records. This record cannot evolve + because an evolution strategy likely depends on this interface remaining + stable, avoiding a cyclic dependency.
        +
        • +
      + + + +
        +
      • +

        setExtraData

        +
        void setExtraData(byte[] data)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/indexed/Unindexed.html b/apidocs/com/amazon/carbonado/repo/indexed/Unindexed.html new file mode 100644 index 0000000..1563e98 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/Unindexed.html @@ -0,0 +1,171 @@ + + + + + + +Unindexed (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.indexed
+

Interface Unindexed

+
+
+
+
    +
  • +
    +
    All Known Subinterfaces:
    +
    StoredIndexInfo
    +
    +
    +
    All Known Implementing Classes:
    +
    StoredDatabaseInfo
    +
    +
    +
    +
    public interface Unindexed
    +
    Marker interface for storables that are not allowed to have indexes.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessCapability.html b/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessCapability.html new file mode 100644 index 0000000..38e77db --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessCapability.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.indexed.IndexEntryAccessCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.indexed.IndexEntryAccessCapability

+
+
No usage of com.amazon.carbonado.repo.indexed.IndexEntryAccessCapability
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessor.html b/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessor.html new file mode 100644 index 0000000..0349ef9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessor.html @@ -0,0 +1,163 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.indexed.IndexEntryAccessor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.indexed.IndexEntryAccessor

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexedRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexedRepositoryBuilder.html new file mode 100644 index 0000000..5ae0a01 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexedRepositoryBuilder.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder

+
+
No usage of com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/indexed/class-use/StoredIndexInfo.html b/apidocs/com/amazon/carbonado/repo/indexed/class-use/StoredIndexInfo.html new file mode 100644 index 0000000..c9b990f --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/class-use/StoredIndexInfo.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.indexed.StoredIndexInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.indexed.StoredIndexInfo

+
+
No usage of com.amazon.carbonado.repo.indexed.StoredIndexInfo
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/indexed/class-use/Unindexed.html b/apidocs/com/amazon/carbonado/repo/indexed/class-use/Unindexed.html new file mode 100644 index 0000000..cb241b5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/class-use/Unindexed.html @@ -0,0 +1,189 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.indexed.Unindexed (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.indexed.Unindexed

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/indexed/package-frame.html b/apidocs/com/amazon/carbonado/repo/indexed/package-frame.html new file mode 100644 index 0000000..4bed9bf --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/package-frame.html @@ -0,0 +1,27 @@ + + + + + + +com.amazon.carbonado.repo.indexed (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.repo.indexed

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/repo/indexed/package-summary.html b/apidocs/com/amazon/carbonado/repo/indexed/package-summary.html new file mode 100644 index 0000000..07a36e4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/package-summary.html @@ -0,0 +1,187 @@ + + + + + + +com.amazon.carbonado.repo.indexed (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.repo.indexed

+
+
Repository implementation that adds index support for repositories that have + little or no index support.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.repo.indexed Description

+
Repository implementation that adds index support for repositories that have + little or no index support. The wrapped repository must support creation of + new types.
+
See Also:
IndexedRepositoryBuilder
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/indexed/package-tree.html b/apidocs/com/amazon/carbonado/repo/indexed/package-tree.html new file mode 100644 index 0000000..0e00182 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/package-tree.html @@ -0,0 +1,162 @@ + + + + + + +com.amazon.carbonado.repo.indexed Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.repo.indexed

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/indexed/package-use.html b/apidocs/com/amazon/carbonado/repo/indexed/package-use.html new file mode 100644 index 0000000..c6e3662 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/package-use.html @@ -0,0 +1,185 @@ + + + + + + +Uses of Package com.amazon.carbonado.repo.indexed (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.repo.indexed

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html new file mode 100644 index 0000000..7a08397 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html @@ -0,0 +1,215 @@ + + + + + + +JDBCBlobLoader (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.jdbc
+

Interface JDBCBlobLoader

+
+
+
+
    +
  • +
    +
    +
    public interface JDBCBlobLoader
    +
    Callback for reloading Blobs outside original transaction.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html new file mode 100644 index 0000000..d8b97a8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html @@ -0,0 +1,215 @@ + + + + + + +JDBCClobLoader (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.jdbc
+

Interface JDBCClobLoader

+
+
+
+
    +
  • +
    +
    +
    public interface JDBCClobLoader
    +
    Callback for reloading Clobs outside original transaction.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html new file mode 100644 index 0000000..9198bd4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html @@ -0,0 +1,370 @@ + + + + + + +JDBCConnectionCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.jdbc
+

Interface JDBCConnectionCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    All Known Subinterfaces:
    +
    JDBCSupport<S>
    +
    +
    +
    +
    public interface JDBCConnectionCapability
+extends Capability
    +
    Capability to directly access the JDBC connection being used by the current + transaction, which is thread-local. If no transaction is in progress, then + the connection is in auto-commit mode. + +

    All connections retrieved from this capability must be properly + yielded. Do not close the connection directly, as this interferes with the + transaction's ability to properly manage it. + +

    It is perfectly okay for other Carbonado calls to be made while the + connection is in use. Also, it is okay to request more connections, + although they will usually be the same instance. Failing to yield a + connection has an undefined behavior. + + 

    + JDBCConnectionCapability cap = repo.getCapability(JDBCConnectionCapability.class);
+ Transaction txn = repo.enterTransaction();
+ try {
+     Connection con = cap.getConnection();
+     try {
+         ...
+     } finally {
+         cap.yieldConnection(con);
+     }
+     ...
+     txn.commit();
+ } finally {
+     txn.exit();
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.sql.ConnectiongetConnection() +
      Any connection returned by this method must be closed by calling + yieldConnection.
      +
      java.lang.StringgetDatabaseProductName() +
      Returns the name of the database product connected to.
      +
      booleanisTransactionForUpdate() +
      Returns true if a transaction is in progress and it is for update.
      +
      booleanisUniqueConstraintError(java.sql.SQLException e) +
      Examines the SQLSTATE code of the given SQL exception and determines if + it is a unique constaint violation.
      +
      FetchExceptiontoFetchException(java.lang.Throwable e) +
      Transforms the given throwable into an appropriate fetch exception.
      +
      PersistExceptiontoPersistException(java.lang.Throwable e) +
      Transforms the given throwable into an appropriate persist exception.
      +
      voidyieldConnection(java.sql.Connection con) +
      Gives up a connection returned from getConnection.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getConnection

        +
        java.sql.Connection getConnection()
+                                  throws FetchException
        +
        Any connection returned by this method must be closed by calling + yieldConnection.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        yieldConnection

        +
        void yieldConnection(java.sql.Connection con)
+                     throws FetchException
        +
        Gives up a connection returned from getConnection. Connection must be + yielded in same thread that retrieved it.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        toFetchException

        +
        FetchException toFetchException(java.lang.Throwable e)
        +
        Transforms the given throwable into an appropriate fetch exception. If + it already is a fetch exception, it is simply casted.
        +
        Parameters:
        e - required exception to transform
        +
        Returns:
        FetchException, never null
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        toPersistException

        +
        PersistException toPersistException(java.lang.Throwable e)
        +
        Transforms the given throwable into an appropriate persist exception. If + it already is a persist exception, it is simply casted.
        +
        Parameters:
        e - required exception to transform
        +
        Returns:
        PersistException, never null
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        isUniqueConstraintError

        +
        boolean isUniqueConstraintError(java.sql.SQLException e)
        +
        Examines the SQLSTATE code of the given SQL exception and determines if + it is a unique constaint violation.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        isTransactionForUpdate

        +
        boolean isTransactionForUpdate()
        +
        Returns true if a transaction is in progress and it is for update.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getDatabaseProductName

        +
        java.lang.String getDatabaseProductName()
        +
        Returns the name of the database product connected to.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html new file mode 100644 index 0000000..9f33066 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html @@ -0,0 +1,947 @@ + + + + + + +JDBCRepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.repo.jdbc
+

Class JDBCRepositoryBuilder

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    RepositoryBuilder
    +
    +
    +
    +
    public class JDBCRepositoryBuilder
+extends AbstractRepositoryBuilder
    +
    Builds a repository instance backed by a JDBC accessible database. + JDBCRepository is not independent of the underlying database schema, and so + it requires matching tables and columns in the database. It will not alter + or create tables. Use the Alias + annotation to control precisely which tables and columns must be matched up. + +

    Note: The current JDBC repository implementation makes certain + assumptions about the database it is accessing. It must support transactions + and multiple statements per connection. If it doesn't support savepoints, + then nested transactions are faked -- rollback of inner transaction will + appear to do nothing. + +

    + The following extra capabilities are supported: +

    +
    Author:
    +
    Brian S O'Neill, bcastill, Adam D Bradley
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      Repositorybuild(java.util.concurrent.atomic.AtomicReference<Repository> rootRef) +
      Builds a repository instance.
      +
      voiderrorCheck(java.util.Collection<java.lang.String> messages) +
      This method is called by assertReady, and subclasses must override to + perform custom checks.
      +
      java.lang.StringgetCatalog() +
      Returns the optional catalog to search for metadata.
      +
      javax.sql.DataSourcegetDataSource() +
      Returns the source of JDBC connections, which defaults to a non-pooling + source if driver class, driver URL, username, and password are all + supplied.
      +
      booleangetDataSourceCloseOnShutdown() +
      Returns true if DataSource is closed when the repository is closed or + shutdown.
      +
      booleangetDataSourceLogging() +
      Returns true if debug logging is enabled.
      +
      java.lang.IntegergetDefaultFetchSize() +
      Returns the default fetch size when running queries, or null if driver + default is used instead.
      +
      java.lang.StringgetDriverClassName() +
      Returns the driver class name, which may be null if a DataSource was provided.
      +
      java.lang.StringgetDriverURL() +
      Returns the connection URL, which may be null if a DataSource was + provided.
      +
      java.lang.StringgetName() +
      Returns the name of the repository.
      +
      java.lang.StringgetPassword() +
      Returns the optional password to use with DataSource.
      +
      java.lang.StringgetSchema() +
      Returns the optional schema to search for metadata.
      +
      java.lang.StringgetSequenceSelectStatement() +
      Returns the native sequence select statement, which is null if the + default is chosen.
      +
      java.lang.StringgetUserName() +
      Returns the optional username to use with DataSource.
      +
      booleanisForceStoredSequence() +
      Returns true if native sequences should not be used.
      +
      booleanisMaster() +
      Returns true if repository should assume the role of master, which is + true by default.
      +
      voidsetAutoVersioningEnabled(boolean enabled, + java.lang.String className) +
      By default, JDBCRepository assumes that version numbers are initialized and + incremented by triggers installed on the database.
      +
      voidsetCatalog(java.lang.String catalog) +
      Optionally set the catalog to search for metadata.
      +
      voidsetDataSource(javax.sql.DataSource dataSource) +
      Set the source of JDBC connections, overriding any configuration + supported by these methods: + + + setDriverClassName(java.lang.String) + setDriverURL(java.lang.String) + setUserName(java.lang.String) + setPassword(java.lang.String) +
      +
      voidsetDataSourceCloseOnShutdown(boolean b) +
      Pass true to cause the DataSource to be closed when the repository is + closed or shutdown.
      +
      voidsetDataSourceLogging(boolean b) +
      Pass true to enable debug logging.
      +
      voidsetDefaultFetchSize(java.lang.Integer size) +
      Set the default fetch size when running queries.
      +
      voidsetDriverClassName(java.lang.String driverClassName) +
      Set the JDBC driver class name, which is required if a DataSource was not provided.
      +
      voidsetDriverURL(java.lang.String url) +
      Set the JDBC connection URL, which is required if a DataSource was not + provided.
      +
      voidsetForceStoredSequence(boolean forceStoredSequence) +
      By default, native sequences are used if supported.
      +
      voidsetMaster(boolean b) +
      Set to false if repository should not assume the role of master.
      +
      voidsetName(java.lang.String name) +
      Set name for the repository, which is required.
      +
      voidsetPassword(java.lang.String password) +
      Optionally set the password to use with DataSource.
      +
      voidsetPrimaryKeyCheckDisabled(boolean primaryKeyCheckDisabled) +
      By default, JDBCRepository makes sure that every declared primary key + in the database table for a Storable lines up with a declared + PrimaryKey or AlternateKey.
      +
      voidsetSchema(java.lang.String schema) +
      Optionally set the schema to search for metadata.
      +
      voidsetSequenceSelectStatement(java.lang.String sequenceSelectStatement) +
      Override the default native sequence select statement with a printf.
      +
      voidsetSuppressReload(boolean suppress, + java.lang.String className) +
      By default, JDBCRepository reloads Storables after every insert or + update.
      +
      voidsetUserName(java.lang.String username) +
      Optionally set the username to use with DataSource.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        JDBCRepositoryBuilder

        +
        public JDBCRepositoryBuilder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        build

        +
        public Repository build(java.util.concurrent.atomic.AtomicReference<Repository> rootRef)
+                 throws RepositoryException
        +
        Description copied from interface: RepositoryBuilder
        +
        Builds a repository instance. + +

        If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.

        +
        Parameters:
        rootRef - reference to root parent repository, to be set by + parent repository upon being built
        +
        Throws:
        +
        ConfigurationException - if there is a problem in the builder's configuration
        +
        RepositoryException - if there is a general problem opening the repository
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns the name of the repository.
        +
        • +
      + + + +
        +
      • +

        setName

        +
        public void setName(java.lang.String name)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set name for the repository, which is required.
        +
        • +
      + + + +
        +
      • +

        isMaster

        +
        public boolean isMaster()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        setMaster

        +
        public void setMaster(boolean b)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + + + + + +
        +
      • +

        getDataSource

        +
        public javax.sql.DataSource getDataSource()
+                                   throws ConfigurationException
        +
        Returns the source of JDBC connections, which defaults to a non-pooling + source if driver class, driver URL, username, and password are all + supplied.
        +
        Throws:
        +
        ConfigurationException - if driver class wasn't found
        +
        • +
      + + + +
        +
      • +

        setDataSourceCloseOnShutdown

        +
        public void setDataSourceCloseOnShutdown(boolean b)
        +
        Pass true to cause the DataSource to be closed when the repository is + closed or shutdown. By default, this option is false.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getDataSourceCloseOnShutdown

        +
        public boolean getDataSourceCloseOnShutdown()
        +
        Returns true if DataSource is closed when the repository is closed or + shutdown. By default, this option is false.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        setDataSourceLogging

        +
        public void setDataSourceLogging(boolean b)
        +
        Pass true to enable debug logging. By default, it is false.
        +
        See Also:
        LoggingDataSource
        +
        • +
      + + + +
        +
      • +

        getDataSourceLogging

        +
        public boolean getDataSourceLogging()
        +
        Returns true if debug logging is enabled.
        +
        See Also:
        LoggingDataSource
        +
        • +
      + + + +
        +
      • +

        setCatalog

        +
        public void setCatalog(java.lang.String catalog)
        +
        Optionally set the catalog to search for metadata.
        +
        • +
      + + + +
        +
      • +

        getCatalog

        +
        public java.lang.String getCatalog()
        +
        Returns the optional catalog to search for metadata.
        +
        • +
      + + + +
        +
      • +

        setSchema

        +
        public void setSchema(java.lang.String schema)
        +
        Optionally set the schema to search for metadata.
        +
        • +
      + + + +
        +
      • +

        getSchema

        +
        public java.lang.String getSchema()
        +
        Returns the optional schema to search for metadata.
        +
        • +
      + + + +
        +
      • +

        setDriverClassName

        +
        public void setDriverClassName(java.lang.String driverClassName)
        +
        Set the JDBC driver class name, which is required if a DataSource was not provided.
        +
        • +
      + + + +
        +
      • +

        getDriverClassName

        +
        public java.lang.String getDriverClassName()
        +
        Returns the driver class name, which may be null if a DataSource was provided.
        +
        • +
      + + + +
        +
      • +

        setDriverURL

        +
        public void setDriverURL(java.lang.String url)
        +
        Set the JDBC connection URL, which is required if a DataSource was not + provided.
        +
        • +
      + + + +
        +
      • +

        getDriverURL

        +
        public java.lang.String getDriverURL()
        +
        Returns the connection URL, which may be null if a DataSource was + provided.
        +
        • +
      + + + +
        +
      • +

        setUserName

        +
        public void setUserName(java.lang.String username)
        +
        Optionally set the username to use with DataSource.
        +
        • +
      + + + +
        +
      • +

        getUserName

        +
        public java.lang.String getUserName()
        +
        Returns the optional username to use with DataSource.
        +
        • +
      + + + +
        +
      • +

        setPassword

        +
        public void setPassword(java.lang.String password)
        +
        Optionally set the password to use with DataSource.
        +
        • +
      + + + +
        +
      • +

        getPassword

        +
        public java.lang.String getPassword()
        +
        Returns the optional password to use with DataSource.
        +
        • +
      + + + +
        +
      • +

        setDefaultFetchSize

        +
        public void setDefaultFetchSize(java.lang.Integer size)
        +
        Set the default fetch size when running queries. Pass null to let driver + use its own default.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getDefaultFetchSize

        +
        public java.lang.Integer getDefaultFetchSize()
        +
        Returns the default fetch size when running queries, or null if driver + default is used instead.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        setAutoVersioningEnabled

        +
        public void setAutoVersioningEnabled(boolean enabled,
+                            java.lang.String className)
        +
        By default, JDBCRepository assumes that version numbers are initialized and + incremented by triggers installed on the database. Enabling automatic + versioning here causes the JDBCRepository to manage these operations + itself.
        +
        Parameters:
        enabled - true to enable, false to disable
        className - name of Storable type to enable automatic version + management on; pass null to enable all
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        setSuppressReload

        +
        public void setSuppressReload(boolean suppress,
+                     java.lang.String className)
        +
        By default, JDBCRepository reloads Storables after every insert or + update. This ensures that any applied defaults or triggered changes are + available to the Storable. If the database has no such defaults or + triggers, suppressing reload can improve performance. + +

        Note: If Storable has a version property and auto versioning is not + enabled, or if the Storable has any automatic properties, the Storable + might still be reloaded.

        +
        Parameters:
        suppress - true to suppress, false to unsuppress
        className - name of Storable type to suppress reload for; pass null + to suppress all
        Since:
        +
        1.1.3
        +
        • +
      + + + +
        +
      • +

        getSequenceSelectStatement

        +
        public java.lang.String getSequenceSelectStatement()
        +
        Returns the native sequence select statement, which is null if the + default is chosen.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        setSequenceSelectStatement

        +
        public void setSequenceSelectStatement(java.lang.String sequenceSelectStatement)
        +
        Override the default native sequence select statement with a printf. + For example, "SELECT %s.NEXTVAL FROM DUAL".
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        isForceStoredSequence

        +
        public boolean isForceStoredSequence()
        +
        Returns true if native sequences should not be used.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        setForceStoredSequence

        +
        public void setForceStoredSequence(boolean forceStoredSequence)
        +
        By default, native sequences are used if supported. Otherwise, a table + named "CARBONADO_SEQUENCE" or "CARBONADO_SEQUENCES" is used instead to + hold sequence values. When forced, the table is always used instead of + native sequences.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        setPrimaryKeyCheckDisabled

        +
        public void setPrimaryKeyCheckDisabled(boolean primaryKeyCheckDisabled)
        +
        By default, JDBCRepository makes sure that every declared primary key + in the database table for a Storable lines up with a declared + PrimaryKey or AlternateKey. This is not always the desired behavior; + for example, you may have a table which uses a bigint for its actual + primary key but uses another column with a unique index as the + "primary" key from the application's point of view. Setting this + value to true allows this check to fail gracefully instead of + throwing a MismatchException.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        errorCheck

        +
        public void errorCheck(java.util.Collection<java.lang.String> messages)
+                throws ConfigurationException
        +
        Description copied from class: AbstractRepositoryBuilder
        +
        This method is called by assertReady, and subclasses must override to + perform custom checks. Be sure to call super.errorCheck as well.
        +
        +
        Overrides:
        +
        errorCheck in class AbstractRepositoryBuilder
        +
        Parameters:
        messages - add any error messages to this list
        +
        Throws:
        +
        ConfigurationException - if error checking indirectly caused + another exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html new file mode 100644 index 0000000..39ad99c --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html @@ -0,0 +1,423 @@ + + + + + + +JDBCStorableInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.jdbc
+

Interface JDBCStorableInfo<S extends Storable>

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isSupported

        +
        boolean isSupported()
        +
        Returns false only if storable type is independent + and no matching table was found.
        +
        • +
      + + + +
        +
      • +

        getCatalogName

        +
        java.lang.String getCatalogName()
        +
        Returns the optional catalog name for the Storable. Some databases use a + catalog name to fully qualify the table name.
        +
        • +
      + + + +
        +
      • +

        getSchemaName

        +
        java.lang.String getSchemaName()
        +
        Returns the optional schema name for the Storable. Some databases use a + schema name to fully qualify the table name.
        +
        • +
      + + + +
        +
      • +

        getTableName

        +
        java.lang.String getTableName()
        +
        Returns the table name for the Storable or null if unsupported.
        +
        • +
      + + + +
        +
      • +

        getQualifiedTableName

        +
        java.lang.String getQualifiedTableName()
        +
        Returns the qualified table name for the Storable or null if + unsupported. Is used by SQL statements.
        +
        • +
      + + + +
        +
      • +

        getIndexInfo

        +
        IndexInfo[] getIndexInfo()
        +
        • +
      + + + +
        +
      • +

        getAllProperties

        +
        java.util.Map<java.lang.String,JDBCStorableProperty<S>> getAllProperties()
        +
        Description copied from interface: StorableInfo
        +
        Returns all the storable properties in an unmodifiable map. Properties + are always ordered, case-sensitive, by name. Primary key properties are + grouped first.
        +
        +
        Specified by:
        +
        getAllProperties in interface StorableInfo<S extends Storable>
        +
        Returns:
        maps property names to property objects
        +
        • +
      + + + +
        +
      • +

        getPrimaryKeyProperties

        +
        java.util.Map<java.lang.String,JDBCStorableProperty<S>> getPrimaryKeyProperties()
        +
        Description copied from interface: StorableInfo
        +
        Returns a subset of the storable properties in an unmodifiable map + that define the primary key. Properties are always ordered, + case-sensitive, by name.
        +
        +
        Specified by:
        +
        getPrimaryKeyProperties in interface StorableInfo<S extends Storable>
        +
        Returns:
        maps property names to property objects
        +
        • +
      + + + +
        +
      • +

        getDataProperties

        +
        java.util.Map<java.lang.String,JDBCStorableProperty<S>> getDataProperties()
        +
        Description copied from interface: StorableInfo
        +
        Returns a subset of the storable properties in an unmodifiable map + that define the basic data properties. Primary keys and joins are + excluded. Properties are always ordered, case-sensitive, by name.
        +
        +
        Specified by:
        +
        getDataProperties in interface StorableInfo<S extends Storable>
        +
        Returns:
        maps property names to property objects
        +
        • +
      + + + +
        +
      • +

        getIdentityProperties

        +
        java.util.Map<java.lang.String,JDBCStorableProperty<S>> getIdentityProperties()
        +
        Returns auto-increment properties which are primary key members. The map + should almost always be empty or contain one property.
        +
        Since:
        +
        1.2
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html new file mode 100644 index 0000000..6a25a05 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html @@ -0,0 +1,297 @@ + + + + + + +JDBCStorableIntrospector (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.repo.jdbc
+

Class JDBCStorableIntrospector

+
+
+ +
+
    +
  • +
    +
    +
    public class JDBCStorableIntrospector
+extends StorableIntrospector
    +
    Provides additional metadata for a Storable type needed by + JDBCRepository. The storable type must match to a table in an external + database. All examined data is cached, so repeat examinations are fast, + unless the examination failed.
    +
    Author:
    +
    Brian S O'Neill, Adam D Bradley, Tobias Holgers, Archit Shivaprakash, Matt Carlson
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static <S extends Storable> 
      JDBCStorableInfo<S>      		examine(java.lang.Class<S> type, + javax.sql.DataSource ds, + java.lang.String catalog, + java.lang.String schema) +
      Examines the given class and returns a JDBCStorableInfo describing it.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        JDBCStorableIntrospector

        +
        public JDBCStorableIntrospector()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        examine

        +
        public static <S extends Storable> JDBCStorableInfo<S> examine(java.lang.Class<S> type,
+                                               javax.sql.DataSource ds,
+                                               java.lang.String catalog,
+                                               java.lang.String schema)
+                                                    throws java.sql.SQLException,
+                                                           SupportException
        +
        Examines the given class and returns a JDBCStorableInfo describing it. A + MalformedTypeException is thrown for a variety of reasons if the given + class is not a well-defined Storable type or if it can't match up with + an entity in the external database.
        +
        Parameters:
        type - Storable type to examine
        ds - source of JDBC connections to use for matching to a table
        catalog - optional catalog to search
        schema - optional schema to search
        +
        Throws:
        +
        MalformedTypeException - if Storable type is not well-formed
        +
        RepositoryException - if there was a problem in accessing the database
        +
        java.lang.IllegalArgumentException - if type is null
        +
        java.sql.SQLException
        +
        SupportException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html new file mode 100644 index 0000000..d8b240a --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html @@ -0,0 +1,554 @@ + + + + + + +JDBCStorableProperty (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.jdbc
+

Interface JDBCStorableProperty<S extends Storable>

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isSupported

        +
        boolean isSupported()
        +
        Returns false only if property is independent and no matching column was + found.
        +
        • +
      + + + +
        +
      • +

        isSelectable

        +
        boolean isSelectable()
        +
        Returns true if property is both supported and not a join. Simply put, + it can appear in a select statement.
        +
        • +
      + + + +
        +
      • +

        isAutoIncrement

        +
        boolean isAutoIncrement()
        +
        Returns true if property is declared as @Automatic and column is + designated as auto-increment.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getColumnName

        +
        java.lang.String getColumnName()
        +
        Returns the table column for this property.
        +
        Returns:
        null if property is unsupported
        +
        • +
      + + + +
        +
      • +

        getDataType

        +
        java.lang.Integer getDataType()
        +
        Returns the data type as defined by Types.
        +
        Returns:
        null if property is unsupported
        +
        • +
      + + + +
        +
      • +

        getDataTypeName

        +
        java.lang.String getDataTypeName()
        +
        Returns the data type name.
        +
        Returns:
        null if property is unsupported
        +
        • +
      + + + +
        +
      • +

        isColumnNullable

        +
        boolean isColumnNullable()
        +
        Returns:
        true if column is nullable
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getResultSetGetMethod

        +
        java.lang.reflect.Method getResultSetGetMethod()
        +
        Returns the method to use to access this property (by index) from a + ResultSet.
        +
        Returns:
        null if property is unsupported
        +
        • +
      + + + +
        +
      • +

        getPreparedStatementSetMethod

        +
        java.lang.reflect.Method getPreparedStatementSetMethod()
        +
        Returns the method to use to set this property (by index) into a + PreparedStatement.
        +
        Returns:
        null if property is unsupported
        +
        • +
      + + + +
        +
      • +

        getAppliedAdapter

        +
        StorablePropertyAdapter getAppliedAdapter()
        +
        Returns the adapter that needs to be applied to properties returned from + ResultSets and set into PreparedStatements. Is null if not needed.
        +
        Returns:
        null if property is unsupported or if adapter not needed.
        +
        • +
      + + + +
        +
      • +

        getColumnSize

        +
        java.lang.Integer getColumnSize()
        +
        The column size is either the maximum number of characters or the + numeric precision.
        +
        Returns:
        null if property is unsupported
        +
        • +
      + + + +
        +
      • +

        getDecimalDigits

        +
        java.lang.Integer getDecimalDigits()
        +
        Returns the amount of fractional decimal digits.
        +
        Returns:
        null if property is unsupported
        +
        • +
      + + + +
        +
      • +

        getCharOctetLength

        +
        java.lang.Integer getCharOctetLength()
        +
        Returns the maximum amount of bytes for property value.
        +
        Returns:
        null if property is unsupported
        +
        • +
      + + + +
        +
      • +

        getOrdinalPosition

        +
        java.lang.Integer getOrdinalPosition()
        +
        Returns the one-based index of the column in the table.
        +
        Returns:
        null if property is unsupported
        +
        • +
      + + + + + + + + + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/JDBCSupport.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCSupport.html new file mode 100644 index 0000000..d8acf12 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCSupport.html @@ -0,0 +1,348 @@ + + + + + + +JDBCSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.jdbc
+

Interface JDBCSupport<S extends Storable>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/LoggingDataSource.html b/apidocs/com/amazon/carbonado/repo/jdbc/LoggingDataSource.html new file mode 100644 index 0000000..d9f8e69 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/LoggingDataSource.html @@ -0,0 +1,447 @@ + + + + + + +LoggingDataSource (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.jdbc
+

Class LoggingDataSource

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.sql.Wrapper, javax.sql.CommonDataSource, javax.sql.DataSource
    +
    +
    +
    +
    public class LoggingDataSource
+extends java.lang.Object
+implements javax.sql.DataSource
    +
    Wraps another DataSource such that all SQL statements are logged as debug.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() 
      static javax.sql.DataSourcecreate(javax.sql.DataSource ds) +
      Wraps the given DataSource which logs to the default log.
      +
      static javax.sql.DataSourcecreate(javax.sql.DataSource ds, + org.apache.commons.logging.Log log) +
      Wraps the given DataSource which logs to the given log.
      +
      java.sql.ConnectiongetConnection() 
      java.sql.ConnectiongetConnection(java.lang.String username, + java.lang.String password) 
      intgetLoginTimeout() 
      java.io.PrintWritergetLogWriter() 
      java.util.logging.LoggergetParentLogger() 
      booleanisWrapperFor(java.lang.Class<?> iface) 
      voidsetLoginTimeout(int seconds) 
      voidsetLogWriter(java.io.PrintWriter writer) 
      <T> Tunwrap(java.lang.Class<T> iface) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        create

        +
        public static javax.sql.DataSource create(javax.sql.DataSource ds)
        +
        Wraps the given DataSource which logs to the default log. If debug + logging is disabled, the original DataSource is returned.
        +
        • +
      + + + +
        +
      • +

        create

        +
        public static javax.sql.DataSource create(javax.sql.DataSource ds,
+                          org.apache.commons.logging.Log log)
        +
        Wraps the given DataSource which logs to the given log. If debug logging + is disabled, the original DataSource is returned.
        +
        • +
      + + + +
        +
      • +

        getConnection

        +
        public java.sql.Connection getConnection()
+                                  throws java.sql.SQLException
        +
        +
        Specified by:
        +
        getConnection in interface javax.sql.DataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        getConnection

        +
        public java.sql.Connection getConnection(java.lang.String username,
+                                java.lang.String password)
+                                  throws java.sql.SQLException
        +
        +
        Specified by:
        +
        getConnection in interface javax.sql.DataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        getLogWriter

        +
        public java.io.PrintWriter getLogWriter()
+                                 throws java.sql.SQLException
        +
        +
        Specified by:
        +
        getLogWriter in interface javax.sql.CommonDataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        setLogWriter

        +
        public void setLogWriter(java.io.PrintWriter writer)
+                  throws java.sql.SQLException
        +
        +
        Specified by:
        +
        setLogWriter in interface javax.sql.CommonDataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        setLoginTimeout

        +
        public void setLoginTimeout(int seconds)
+                     throws java.sql.SQLException
        +
        +
        Specified by:
        +
        setLoginTimeout in interface javax.sql.CommonDataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        getLoginTimeout

        +
        public int getLoginTimeout()
+                    throws java.sql.SQLException
        +
        +
        Specified by:
        +
        getLoginTimeout in interface javax.sql.CommonDataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws java.sql.SQLException
        +
        Throws:
        +
        java.sql.SQLException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        unwrap

        +
        public <T> T unwrap(java.lang.Class<T> iface)
+         throws java.sql.SQLException
        +
        +
        Specified by:
        +
        unwrap in interface java.sql.Wrapper
        +
        Throws:
        +
        java.sql.SQLException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        isWrapperFor

        +
        public boolean isWrapperFor(java.lang.Class<?> iface)
+                     throws java.sql.SQLException
        +
        +
        Specified by:
        +
        isWrapperFor in interface java.sql.Wrapper
        +
        Throws:
        +
        java.sql.SQLException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getParentLogger

        +
        public java.util.logging.Logger getParentLogger()
+                                         throws java.sql.SQLFeatureNotSupportedException
        +
        +
        Specified by:
        +
        getParentLogger in interface javax.sql.CommonDataSource
        +
        Throws:
        +
        java.sql.SQLFeatureNotSupportedException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/SimpleDataSource.html b/apidocs/com/amazon/carbonado/repo/jdbc/SimpleDataSource.html new file mode 100644 index 0000000..44d9458 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/SimpleDataSource.html @@ -0,0 +1,501 @@ + + + + + + +SimpleDataSource (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.repo.jdbc
+

Class SimpleDataSource

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.sql.Wrapper, javax.sql.CommonDataSource, javax.sql.DataSource
    +
    +
    +
    +
    public class SimpleDataSource
+extends java.lang.Object
+implements javax.sql.DataSource
    +
    SimpleDataSource does not implement any connection pooling.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      SimpleDataSource(java.lang.String driverClass, + java.lang.String driverURL, + java.util.Properties properties) 
      SimpleDataSource(java.lang.String driverClass, + java.lang.String driverURL, + java.lang.String username, + java.lang.String password) 
      SimpleDataSource(java.lang.String driverClass, + java.lang.String driverURL, + java.lang.String username, + java.lang.String password, + java.util.Properties properties) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() 
      java.sql.ConnectiongetConnection() 
      java.sql.ConnectiongetConnection(java.lang.String username, + java.lang.String password) 
      intgetLoginTimeout() 
      java.io.PrintWritergetLogWriter() 
      java.util.logging.LoggergetParentLogger() 
      booleanisWrapperFor(java.lang.Class<?> iface) 
      voidsetLoginTimeout(int seconds) 
      voidsetLogWriter(java.io.PrintWriter writer) 
      <T> Tunwrap(java.lang.Class<T> iface) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SimpleDataSource

        +
        public SimpleDataSource(java.lang.String driverClass,
+                java.lang.String driverURL,
+                java.util.Properties properties)
+                 throws java.sql.SQLException
        +
        Parameters:
        driverClass - JDBC driver to load; can pass null if already loaded
        driverURL - JDBC driver URL
        properties - optional connection properties
        +
        Throws:
        +
        java.sql.SQLException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        SimpleDataSource

        +
        public SimpleDataSource(java.lang.String driverClass,
+                java.lang.String driverURL,
+                java.lang.String username,
+                java.lang.String password)
+                 throws java.sql.SQLException
        +
        Parameters:
        driverClass - JDBC driver to load; can pass null if already loaded
        driverURL - JDBC driver URL
        username - optional username to connect with
        password - optional password to connect with
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        SimpleDataSource

        +
        public SimpleDataSource(java.lang.String driverClass,
+                java.lang.String driverURL,
+                java.lang.String username,
+                java.lang.String password,
+                java.util.Properties properties)
+                 throws java.sql.SQLException
        +
        Parameters:
        driverClass - JDBC driver to load; can pass null if already loaded
        driverURL - JDBC driver URL
        username - optional username to connect with
        password - optional password to connect with
        properties - optional connection properties
        +
        Throws:
        +
        java.sql.SQLException
        Since:
        +
        1.2
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getConnection

        +
        public java.sql.Connection getConnection()
+                                  throws java.sql.SQLException
        +
        +
        Specified by:
        +
        getConnection in interface javax.sql.DataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        getConnection

        +
        public java.sql.Connection getConnection(java.lang.String username,
+                                java.lang.String password)
+                                  throws java.sql.SQLException
        +
        +
        Specified by:
        +
        getConnection in interface javax.sql.DataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        getLogWriter

        +
        public java.io.PrintWriter getLogWriter()
+                                 throws java.sql.SQLException
        +
        +
        Specified by:
        +
        getLogWriter in interface javax.sql.CommonDataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        setLogWriter

        +
        public void setLogWriter(java.io.PrintWriter writer)
+                  throws java.sql.SQLException
        +
        +
        Specified by:
        +
        setLogWriter in interface javax.sql.CommonDataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        setLoginTimeout

        +
        public void setLoginTimeout(int seconds)
+                     throws java.sql.SQLException
        +
        +
        Specified by:
        +
        setLoginTimeout in interface javax.sql.CommonDataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        getLoginTimeout

        +
        public int getLoginTimeout()
+                    throws java.sql.SQLException
        +
        +
        Specified by:
        +
        getLoginTimeout in interface javax.sql.CommonDataSource
        +
        Throws:
        +
        java.sql.SQLException
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws java.sql.SQLException
        +
        Throws:
        +
        java.sql.SQLException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        unwrap

        +
        public <T> T unwrap(java.lang.Class<T> iface)
+         throws java.sql.SQLException
        +
        +
        Specified by:
        +
        unwrap in interface java.sql.Wrapper
        +
        Throws:
        +
        java.sql.SQLException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        isWrapperFor

        +
        public boolean isWrapperFor(java.lang.Class<?> iface)
+                     throws java.sql.SQLException
        +
        +
        Specified by:
        +
        isWrapperFor in interface java.sql.Wrapper
        +
        Throws:
        +
        java.sql.SQLException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getParentLogger

        +
        public java.util.logging.Logger getParentLogger()
+                                         throws java.sql.SQLFeatureNotSupportedException
        +
        +
        Specified by:
        +
        getParentLogger in interface javax.sql.CommonDataSource
        +
        Throws:
        +
        java.sql.SQLFeatureNotSupportedException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCBlobLoader.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCBlobLoader.html new file mode 100644 index 0000000..66eb446 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCBlobLoader.html @@ -0,0 +1,161 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCBlobLoader (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.jdbc.JDBCBlobLoader

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCClobLoader.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCClobLoader.html new file mode 100644 index 0000000..dfbc020 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCClobLoader.html @@ -0,0 +1,161 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCClobLoader (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.jdbc.JDBCClobLoader

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCConnectionCapability.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCConnectionCapability.html new file mode 100644 index 0000000..05be10c --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCConnectionCapability.html @@ -0,0 +1,177 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCRepositoryBuilder.html new file mode 100644 index 0000000..52cd724 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCRepositoryBuilder.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder

+
+
No usage of com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableInfo.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableInfo.html new file mode 100644 index 0000000..aa5420a --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableInfo.html @@ -0,0 +1,165 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCStorableInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.jdbc.JDBCStorableInfo

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableIntrospector.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableIntrospector.html new file mode 100644 index 0000000..e53b20e --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableIntrospector.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.repo.jdbc.JDBCStorableIntrospector (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.repo.jdbc.JDBCStorableIntrospector

+
+
No usage of com.amazon.carbonado.repo.jdbc.JDBCStorableIntrospector
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableProperty.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableProperty.html new file mode 100644 index 0000000..a5f144e --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableProperty.html @@ -0,0 +1,203 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCStorableProperty (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.jdbc.JDBCStorableProperty

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCSupport.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCSupport.html new file mode 100644 index 0000000..c814a5c --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCSupport.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.jdbc.JDBCSupport

+
+
No usage of com.amazon.carbonado.repo.jdbc.JDBCSupport
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/LoggingDataSource.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/LoggingDataSource.html new file mode 100644 index 0000000..a3aca5b --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/LoggingDataSource.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.repo.jdbc.LoggingDataSource (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.repo.jdbc.LoggingDataSource

+
+
No usage of com.amazon.carbonado.repo.jdbc.LoggingDataSource
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/SimpleDataSource.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/SimpleDataSource.html new file mode 100644 index 0000000..fec23d1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/SimpleDataSource.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.repo.jdbc.SimpleDataSource (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.repo.jdbc.SimpleDataSource

+
+
No usage of com.amazon.carbonado.repo.jdbc.SimpleDataSource
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/package-frame.html b/apidocs/com/amazon/carbonado/repo/jdbc/package-frame.html new file mode 100644 index 0000000..bf1a213 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +com.amazon.carbonado.repo.jdbc (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.repo.jdbc

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/package-summary.html b/apidocs/com/amazon/carbonado/repo/jdbc/package-summary.html new file mode 100644 index 0000000..0d3cc12 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/package-summary.html @@ -0,0 +1,218 @@ + + + + + + +com.amazon.carbonado.repo.jdbc (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.repo.jdbc

+
+
Repository implementation that connects to an external SQL database via + JDBC.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.repo.jdbc Description

+
Repository implementation that connects to an external SQL database via + JDBC. JDBC repository is not independent of the underlying database schema, + and so it requires matching tables and columns in the database. It will not + alter or create tables. Use the Alias + annotation to control precisely which tables and columns must be matched up.
+
See Also:
JDBCRepositoryBuilder
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/package-tree.html b/apidocs/com/amazon/carbonado/repo/jdbc/package-tree.html new file mode 100644 index 0000000..7348f68 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/package-tree.html @@ -0,0 +1,191 @@ + + + + + + +com.amazon.carbonado.repo.jdbc Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.repo.jdbc

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/package-use.html b/apidocs/com/amazon/carbonado/repo/jdbc/package-use.html new file mode 100644 index 0000000..cae08e9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/package-use.html @@ -0,0 +1,177 @@ + + + + + + +Uses of Package com.amazon.carbonado.repo.jdbc (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.repo.jdbc

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/logging/CommonsLog.html b/apidocs/com/amazon/carbonado/repo/logging/CommonsLog.html new file mode 100644 index 0000000..fc37f49 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/CommonsLog.html @@ -0,0 +1,299 @@ + + + + + + +CommonsLog (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.repo.logging
+

Class CommonsLog

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Log
    +
    +
    +
    +
    public class CommonsLog
+extends java.lang.Object
+implements Log
    +
    Log implementation that uses Jakarta Commons Logging at debug level.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      CommonsLog(java.lang.Class clazz) 
      CommonsLog(org.apache.commons.logging.Log log) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanisEnabled() 
      voidwrite(java.lang.String message) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CommonsLog

        +
        public CommonsLog(org.apache.commons.logging.Log log)
        +
        • +
      + + + +
        +
      • +

        CommonsLog

        +
        public CommonsLog(java.lang.Class clazz)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isEnabled

        +
        public boolean isEnabled()
        +
        +
        Specified by:
        +
        isEnabled in interface Log
        +
        +
        • +
      + + + +
        +
      • +

        write

        +
        public void write(java.lang.String message)
        +
        +
        Specified by:
        +
        write in interface Log
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/logging/Log.html b/apidocs/com/amazon/carbonado/repo/logging/Log.html new file mode 100644 index 0000000..7fd808e --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/Log.html @@ -0,0 +1,228 @@ + + + + + + +Log (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.logging
+

Interface Log

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    CommonsLog
    +
    +
    +
    +
    public interface Log
    +
    Very simple Log interface.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanisEnabled() 
      voidwrite(java.lang.String message) 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isEnabled

        +
        boolean isEnabled()
        +
        • +
      + + + +
        +
      • +

        write

        +
        void write(java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/logging/LogAccessCapability.html b/apidocs/com/amazon/carbonado/repo/logging/LogAccessCapability.html new file mode 100644 index 0000000..ce9c79c --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/LogAccessCapability.html @@ -0,0 +1,216 @@ + + + + + + +LogAccessCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.logging
+

Interface LogAccessCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface LogAccessCapability
+extends Capability
    +
    Provides access to the Log.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      LoggetLog() 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getLog

        +
        Log getLog()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html new file mode 100644 index 0000000..5532586 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html @@ -0,0 +1,484 @@ + + + + + + +LoggingRepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.repo.logging
+

Class LoggingRepositoryBuilder

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    RepositoryBuilder
    +
    +
    +
    +
    public class LoggingRepositoryBuilder
+extends AbstractRepositoryBuilder
    +
    Repository implementation which logs activity against it. By default, all + logged messages are at the debug level. + +

    + The following extra capabilities are supported: +

    + + Example: + + 
    + LoggingRepositoryBuilder loggingBuilder = new LoggingRepositoryBuilder();
+ loggingBuilder.setActualRepositoryBuilder(...);
+ Repository repo = loggingBuilder.build();
+
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      Repositorybuild(java.util.concurrent.atomic.AtomicReference<Repository> rootRef) +
      Builds a repository instance.
      +
      voiderrorCheck(java.util.Collection<java.lang.String> messages) +
      This method is called by assertReady, and subclasses must override to + perform custom checks.
      +
      RepositoryBuildergetActualRepositoryBuilder() +
      Returns the Repository that all calls are wrapped to.
      +
      LoggetLog() +
      Return the Log to use.
      +
      java.lang.StringgetName() +
      Returns the name of the repository.
      +
      booleanisMaster() +
      Returns true if repository should assume the role of master, which is + true by default.
      +
      voidsetActualRepositoryBuilder(RepositoryBuilder builder) +
      Set the Repository to wrap all calls to.
      +
      voidsetLog(Log log) +
      Set the Log to use.
      +
      voidsetMaster(boolean master) +
      Set to false if repository should not assume the role of master.
      +
      voidsetName(java.lang.String name) +
      Set name for the repository, which is required.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LoggingRepositoryBuilder

        +
        public LoggingRepositoryBuilder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        build

        +
        public Repository build(java.util.concurrent.atomic.AtomicReference<Repository> rootRef)
+                 throws RepositoryException
        +
        Description copied from interface: RepositoryBuilder
        +
        Builds a repository instance. + +

        If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.

        +
        Parameters:
        rootRef - reference to root parent repository, to be set by + parent repository upon being built
        +
        Throws:
        +
        ConfigurationException - if there is a problem in the builder's configuration
        +
        RepositoryException - if there is a general problem opening the repository
        +
        • +
      + + + +
        +
      • +

        setName

        +
        public void setName(java.lang.String name)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set name for the repository, which is required.
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns the name of the repository.
        +
        • +
      + + + +
        +
      • +

        setMaster

        +
        public void setMaster(boolean master)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        isMaster

        +
        public boolean isMaster()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        setLog

        +
        public void setLog(Log log)
        +
        Set the Log to use. If null, use default. Log must be enabled when build + is called, or else no logging is ever performed.
        +
        • +
      + + + +
        +
      • +

        getLog

        +
        public Log getLog()
        +
        Return the Log to use. If null, use default.
        +
        • +
      + + + +
        +
      • +

        setActualRepositoryBuilder

        +
        public void setActualRepositoryBuilder(RepositoryBuilder builder)
        +
        Set the Repository to wrap all calls to.
        +
        • +
      + + + +
        +
      • +

        getActualRepositoryBuilder

        +
        public RepositoryBuilder getActualRepositoryBuilder()
        +
        Returns the Repository that all calls are wrapped to.
        +
        • +
      + + + +
        +
      • +

        errorCheck

        +
        public void errorCheck(java.util.Collection<java.lang.String> messages)
+                throws ConfigurationException
        +
        Description copied from class: AbstractRepositoryBuilder
        +
        This method is called by assertReady, and subclasses must override to + perform custom checks. Be sure to call super.errorCheck as well.
        +
        +
        Overrides:
        +
        errorCheck in class AbstractRepositoryBuilder
        +
        Parameters:
        messages - add any error messages to this list
        +
        Throws:
        +
        ConfigurationException - if error checking indirectly caused + another exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/logging/class-use/CommonsLog.html b/apidocs/com/amazon/carbonado/repo/logging/class-use/CommonsLog.html new file mode 100644 index 0000000..9b9bb3f --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/class-use/CommonsLog.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.repo.logging.CommonsLog (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.repo.logging.CommonsLog

+
+
No usage of com.amazon.carbonado.repo.logging.CommonsLog
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/logging/class-use/Log.html b/apidocs/com/amazon/carbonado/repo/logging/class-use/Log.html new file mode 100644 index 0000000..a895db1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/class-use/Log.html @@ -0,0 +1,195 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.logging.Log (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.logging.Log

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/logging/class-use/LogAccessCapability.html b/apidocs/com/amazon/carbonado/repo/logging/class-use/LogAccessCapability.html new file mode 100644 index 0000000..febcf9a --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/class-use/LogAccessCapability.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.logging.LogAccessCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.logging.LogAccessCapability

+
+
No usage of com.amazon.carbonado.repo.logging.LogAccessCapability
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/logging/class-use/LoggingRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/logging/class-use/LoggingRepositoryBuilder.html new file mode 100644 index 0000000..818055b --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/class-use/LoggingRepositoryBuilder.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder

+
+
No usage of com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/logging/package-frame.html b/apidocs/com/amazon/carbonado/repo/logging/package-frame.html new file mode 100644 index 0000000..732c5d9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/package-frame.html @@ -0,0 +1,26 @@ + + + + + + +com.amazon.carbonado.repo.logging (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.repo.logging

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/repo/logging/package-summary.html b/apidocs/com/amazon/carbonado/repo/logging/package-summary.html new file mode 100644 index 0000000..bbc8a11 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/package-summary.html @@ -0,0 +1,177 @@ + + + + + + +com.amazon.carbonado.repo.logging (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.repo.logging

+
+
Repository implementation which logs activity against it.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.repo.logging Description

+
Repository implementation which logs activity against it. By default, all + logged messages are at the debug level.
+
See Also:
LoggingRepositoryBuilder
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/logging/package-tree.html b/apidocs/com/amazon/carbonado/repo/logging/package-tree.html new file mode 100644 index 0000000..dd712a0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/package-tree.html @@ -0,0 +1,144 @@ + + + + + + +com.amazon.carbonado.repo.logging Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.repo.logging

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/logging/package-use.html b/apidocs/com/amazon/carbonado/repo/logging/package-use.html new file mode 100644 index 0000000..570c33a --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/package-use.html @@ -0,0 +1,154 @@ + + + + + + +Uses of Package com.amazon.carbonado.repo.logging (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.repo.logging

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/map/MapRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/map/MapRepositoryBuilder.html new file mode 100644 index 0000000..8191fcb --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/map/MapRepositoryBuilder.html @@ -0,0 +1,481 @@ + + + + + + +MapRepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.repo.map
+

Class MapRepositoryBuilder

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    RepositoryBuilder
    +
    +
    +
    +
    public class MapRepositoryBuilder
+extends AbstractRepositoryBuilder
    +
    Volatile repository implementation backed by a concurrent map. Locks used by + repository are coarse, much like table locks. Loads and queries + acquire read locks, and modifications acquire write locks. Within + transactions, loads and queries always acquire upgradable locks, to reduce + the likelihood of deadlock. + +

    This repository supports transactions, which also may be + nested. Supported isolation levels are read committed and serializable. Read + uncommitted is promoted to read committed, and repeatable read is promoted + to serializable. + +

    + The following extra capabilities are supported: +

    + +

    Note: This repository uses concurrent navigable map classes, which became + available in JDK1.6.

    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      Repositorybuild(java.util.concurrent.atomic.AtomicReference<Repository> rootRef) +
      Builds a repository instance.
      +
      intgetLockTimeout() +
      Returns the lock timeout.
      +
      java.util.concurrent.TimeUnitgetLockTimeoutUnit() +
      Returns the lock timeout unit.
      +
      java.lang.StringgetName() +
      Returns the name of the repository.
      +
      booleanisMaster() +
      Returns true if repository should assume the role of master, which is + true by default.
      +
      static RepositorynewRepository() +
      Convenience method to build a new MapRepository.
      +
      voidsetLockTimeout(int timeout, + java.util.concurrent.TimeUnit unit) +
      Set the lock timeout.
      +
      voidsetLockTimeoutMillis(int timeout) +
      Set the lock timeout, in milliseconds.
      +
      voidsetMaster(boolean b) +
      Set to false if repository should not assume the role of master.
      +
      voidsetName(java.lang.String name) +
      Set name for the repository, which is required.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MapRepositoryBuilder

        +
        public MapRepositoryBuilder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        newRepository

        +
        public static Repository newRepository()
        +
        Convenience method to build a new MapRepository.
        +
        • +
      + + + +
        +
      • +

        build

        +
        public Repository build(java.util.concurrent.atomic.AtomicReference<Repository> rootRef)
+                 throws RepositoryException
        +
        Description copied from interface: RepositoryBuilder
        +
        Builds a repository instance. + +

        If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.

        +
        Parameters:
        rootRef - reference to root parent repository, to be set by + parent repository upon being built
        +
        Throws:
        +
        ConfigurationException - if there is a problem in the builder's configuration
        +
        RepositoryException - if there is a general problem opening the repository
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns the name of the repository.
        +
        • +
      + + + +
        +
      • +

        setName

        +
        public void setName(java.lang.String name)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set name for the repository, which is required.
        +
        • +
      + + + +
        +
      • +

        isMaster

        +
        public boolean isMaster()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        setMaster

        +
        public void setMaster(boolean b)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        setLockTimeoutMillis

        +
        public void setLockTimeoutMillis(int timeout)
        +
        Set the lock timeout, in milliseconds. Default value is 500 milliseconds.
        +
        • +
      + + + +
        +
      • +

        setLockTimeout

        +
        public void setLockTimeout(int timeout,
+                  java.util.concurrent.TimeUnit unit)
        +
        Set the lock timeout. Default value is 500 milliseconds.
        +
        • +
      + + + +
        +
      • +

        getLockTimeout

        +
        public int getLockTimeout()
        +
        Returns the lock timeout. Call getLockTimeoutUnit to get the unit.
        +
        • +
      + + + +
        +
      • +

        getLockTimeoutUnit

        +
        public java.util.concurrent.TimeUnit getLockTimeoutUnit()
        +
        Returns the lock timeout unit. Call getLockTimeout to get the timeout.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/map/class-use/MapRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/map/class-use/MapRepositoryBuilder.html new file mode 100644 index 0000000..029556d --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/map/class-use/MapRepositoryBuilder.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.repo.map.MapRepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.repo.map.MapRepositoryBuilder

+
+
No usage of com.amazon.carbonado.repo.map.MapRepositoryBuilder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/map/package-frame.html b/apidocs/com/amazon/carbonado/repo/map/package-frame.html new file mode 100644 index 0000000..2c3eda2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/map/package-frame.html @@ -0,0 +1,20 @@ + + + + + + +com.amazon.carbonado.repo.map (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.repo.map

+
+

Classes

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/repo/map/package-summary.html b/apidocs/com/amazon/carbonado/repo/map/package-summary.html new file mode 100644 index 0000000..d4d670e --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/map/package-summary.html @@ -0,0 +1,147 @@ + + + + + + +com.amazon.carbonado.repo.map (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.repo.map

+
+
Volatile repository implementation backed by a concurrent map.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.repo.map Description

+
Volatile repository implementation backed by a concurrent map.
+
See Also:
MapRepositoryBuilder
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/map/package-tree.html b/apidocs/com/amazon/carbonado/repo/map/package-tree.html new file mode 100644 index 0000000..994619c --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/map/package-tree.html @@ -0,0 +1,134 @@ + + + + + + +com.amazon.carbonado.repo.map Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.repo.map

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/map/package-use.html b/apidocs/com/amazon/carbonado/repo/map/package-use.html new file mode 100644 index 0000000..a868c87 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/map/package-use.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Package com.amazon.carbonado.repo.map (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.repo.map

+
+
No usage of com.amazon.carbonado.repo.map
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html new file mode 100644 index 0000000..15c406c --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html @@ -0,0 +1,473 @@ + + + + + + +ReplicatedRepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.repo.replicated
+

Class ReplicatedRepositoryBuilder

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    RepositoryBuilder
    +
    +
    +
    +
    public class ReplicatedRepositoryBuilder
+extends AbstractRepositoryBuilder
    +
    Repository builder for the replicated repository. +

    + The following extra capabilities are supported: +

    +
    Author:
    +
    Don Schneider, Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ReplicatedRepositoryBuilder

        +
        public ReplicatedRepositoryBuilder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        build

        +
        public Repository build(java.util.concurrent.atomic.AtomicReference<Repository> rootRef)
+                 throws RepositoryException
        +
        Description copied from interface: RepositoryBuilder
        +
        Builds a repository instance. + +

        If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.

        +
        Parameters:
        rootRef - reference to root parent repository, to be set by + parent repository upon being built
        +
        Throws:
        +
        ConfigurationException - if there is a problem in the builder's configuration
        +
        RepositoryException - if there is a general problem opening the repository
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns the name of the repository.
        +
        • +
      + + + +
        +
      • +

        setName

        +
        public void setName(java.lang.String name)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set name for the repository, which is required.
        +
        • +
      + + + +
        +
      • +

        isMaster

        +
        public boolean isMaster()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        setMaster

        +
        public void setMaster(boolean b)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        getReplicaRepositoryBuilder

        +
        public RepositoryBuilder getReplicaRepositoryBuilder()
        +
        Returns:
        "replica" respository to replicate to.
        +
        • +
      + + + +
        +
      • +

        setReplicaRepositoryBuilder

        +
        public void setReplicaRepositoryBuilder(RepositoryBuilder replicaRepositoryBuilder)
        +
        Set "replica" respository to replicate to, which is required. This builder + automatically sets the master option of the given repository builder to + false.
        +
        • +
      + + + +
        +
      • +

        getMasterRepositoryBuilder

        +
        public RepositoryBuilder getMasterRepositoryBuilder()
        +
        Returns:
        "master" respository to replicate from.
        +
        • +
      + + + +
        +
      • +

        setMasterRepositoryBuilder

        +
        public void setMasterRepositoryBuilder(RepositoryBuilder masterRepositoryBuilder)
        +
        Set "master" respository to replicate from, which is required. This + builder automatically sets the master option of the given repository to + true.
        +
        • +
      + + + +
        +
      • +

        errorCheck

        +
        public void errorCheck(java.util.Collection<java.lang.String> messages)
+                throws ConfigurationException
        +
        Description copied from class: AbstractRepositoryBuilder
        +
        This method is called by assertReady, and subclasses must override to + perform custom checks. Be sure to call super.errorCheck as well.
        +
        +
        Overrides:
        +
        errorCheck in class AbstractRepositoryBuilder
        +
        Parameters:
        messages - add any error messages to this list
        +
        Throws:
        +
        ConfigurationException - if error checking indirectly caused + another exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/replicated/class-use/ReplicatedRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/replicated/class-use/ReplicatedRepositoryBuilder.html new file mode 100644 index 0000000..f321a4d --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/replicated/class-use/ReplicatedRepositoryBuilder.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder

+
+
No usage of com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/replicated/package-frame.html b/apidocs/com/amazon/carbonado/repo/replicated/package-frame.html new file mode 100644 index 0000000..c83cb1c --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/replicated/package-frame.html @@ -0,0 +1,20 @@ + + + + + + +com.amazon.carbonado.repo.replicated (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.repo.replicated

+
+

Classes

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/repo/replicated/package-summary.html b/apidocs/com/amazon/carbonado/repo/replicated/package-summary.html new file mode 100644 index 0000000..3516d8b --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/replicated/package-summary.html @@ -0,0 +1,151 @@ + + + + + + +com.amazon.carbonado.repo.replicated (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.repo.replicated

+
+
Repository implementation that supports replication between two + repositories.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.repo.replicated Description

+
Repository implementation that supports replication between two + repositories. One repository is the replica, and the other is the + master. Read operations are served by the replica, and the master is + consulted when writing. Changes to the master are copied to the replica.
+
See Also:
ReplicatedRepositoryBuilder
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/replicated/package-tree.html b/apidocs/com/amazon/carbonado/repo/replicated/package-tree.html new file mode 100644 index 0000000..ac2af7f --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/replicated/package-tree.html @@ -0,0 +1,134 @@ + + + + + + +com.amazon.carbonado.repo.replicated Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.repo.replicated

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/replicated/package-use.html b/apidocs/com/amazon/carbonado/repo/replicated/package-use.html new file mode 100644 index 0000000..3f38ced --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/replicated/package-use.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Package com.amazon.carbonado.repo.replicated (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.repo.replicated

+
+
No usage of com.amazon.carbonado.repo.replicated
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html new file mode 100644 index 0000000..bd9736e --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html @@ -0,0 +1,217 @@ + + + + + + +BDBPanicHandler (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.sleepycat
+

Interface BDBPanicHandler

+
+
+
+
    +
  • +
    +
    +
    public interface BDBPanicHandler
    +
    Interface for a generic panic handler for any BDB products.
    +
    Author:
    +
    Jesse Morgan
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidonPanic(java.lang.Object environment, + java.lang.Exception exception) +
      Called when an Environment panics or an EnvironmentFailureException is thrown.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        onPanic

        +
        void onPanic(java.lang.Object environment,
+           java.lang.Exception exception)
        +
        Called when an Environment panics or an EnvironmentFailureException is thrown.
        +
        Parameters:
        environment - The affected environment or null if the environment could not be opened.
        exception - The related exception.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/BDBProduct.html b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBProduct.html new file mode 100644 index 0000000..a452514 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBProduct.html @@ -0,0 +1,392 @@ + + + + + + +BDBProduct (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.repo.sleepycat
+

Enum BDBProduct

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<BDBProduct>
    +
    +
    +
    +
    public enum BDBProduct
+extends java.lang.Enum<BDBProduct>
    +
    Set of supported BDB products.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      DB +
      BDB Native
      +
      DB_HA +
      BDB Native, High Availability
      +
      DB_Legacy +
      BDB Native, legacy API
      +
      DBX +
      BDB Native, with reduced concurrency to eliminate deadlocks.
      +
      JE +
      BDB Java Edition
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static BDBProductforString(java.lang.String name) 
      static BDBProductvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static BDBProduct[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        DB_Legacy

        +
        public static final BDBProduct DB_Legacy
        +
        BDB Native, legacy API
        +
        • +
      + + + +
        +
      • +

        DB

        +
        public static final BDBProduct DB
        +
        BDB Native
        +
        • +
      + + + +
        +
      • +

        DBX

        +
        public static final BDBProduct DBX
        +
        BDB Native, with reduced concurrency to eliminate deadlocks. Exclusive + lock is held when modifications are made, and at most one open + transaction is allowed at any given time.
        +
        • +
      + + + +
        +
      • +

        DB_HA

        +
        public static final BDBProduct DB_HA
        +
        BDB Native, High Availability
        +
        • +
      + + + +
        +
      • +

        JE

        +
        public static final BDBProduct JE
        +
        BDB Java Edition
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static BDBProduct[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (BDBProduct c : BDBProduct.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in +the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static BDBProduct valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      + + + +
        +
      • +

        forString

        +
        public static BDBProduct forString(java.lang.String name)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html new file mode 100644 index 0000000..90bc0eb --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html @@ -0,0 +1,237 @@ + + + + + + +BDBRepositoryBuilder.DatabaseHook (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.sleepycat
+

Interface BDBRepositoryBuilder.DatabaseHook

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    BDBRepositoryBuilder
    +
    +
    +
    +
    public static interface BDBRepositoryBuilder.DatabaseHook
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringdatabaseName(java.lang.String typeName) +
      Returns an appropriate database name for the given type.
      +
      voidprepareForOpening(java.lang.Object db) +
      Called right before database is opened.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        databaseName

        +
        java.lang.String databaseName(java.lang.String typeName)
        +
        Returns an appropriate database name for the given type. Simply + return the type name as-is to support default behavior.
        +
        • +
      + + + +
        +
      • +

        prepareForOpening

        +
        void prepareForOpening(java.lang.Object db)
+                       throws RepositoryException
        +
        Called right before database is opened.
        +
        Parameters:
        db - reference to database or config - actual type depends on BDB + implementation.
        +
        Throws:
        +
        RepositoryException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html new file mode 100644 index 0000000..425a599 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html @@ -0,0 +1,2121 @@ + + + + + + +BDBRepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.repo.sleepycat
+

Class BDBRepositoryBuilder

+
+
+ +
+ +
+
+
    +
  • + + + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      Repositorybuild(java.util.concurrent.atomic.AtomicReference<Repository> rootRef) +
      Builds a repository instance.
      +
      voiderrorCheck(java.util.Collection<java.lang.String> messages) +
      This method is called by assertReady, and subclasses must override to + perform custom checks.
      +
      BDBProductgetBDBProduct() +
      Returns the BDB product to use, which is JE by default.
      +
      java.lang.IntegergetCachePercent() +
      Returns the percent of JVM heap used by the repository cache, or + null if default should be selected.
      +
      java.lang.LonggetCacheSize() +
      Returns the repository cache size, or null if default should be + selected.
      +
      intgetCheckpointInterval() 
      intgetCheckpointThresholdKB() 
      intgetCheckpointThresholdMinutes() 
      java.lang.BooleangetChecksumEnabled() +
      Returns true if checksum verification is enabled.
      +
      java.lang.StringgetCompressor(java.lang.String type) +
      Return the compressor used for the given storable.
      +
      BDBRepositoryBuilder.DatabaseHookgetDatabaseHook() +
      Returns the custom open database hook, or null if none.
      +
      java.lang.BooleangetDatabasesTransactional() +
      Returns true if the databases are configured to be transactional, + false if configured to not be transactional, null if this override was never set
      +
      java.lang.StringgetDataHome() +
      Returns the directory to store data files.
      +
      java.io.FilegetDataHomeFile() +
      Returns the optional directory to store data files.
      +
      java.lang.StringgetEnvironmentHome() +
      Returns the repository environment home directory.
      +
      java.io.FilegetEnvironmentHomeFile() +
      Returns the repository environment home directory.
      +
      doublegetIndexRepairThrottle() +
      Returns the throttle parameter used when indexes are added, dropped or + bulk repaired.
      +
      booleangetIndexSupport() +
      Returns true if indexes are supported, which is true by default.
      +
      java.lang.ObjectgetInitialDatabaseConfig() +
      Returns the optional BDB specific database configuration to use + for all databases created.
      +
      java.lang.ObjectgetInitialEnvironmentConfig() +
      Returns the optional BDB specific environment configuration to use.
      +
      booleangetInitializeLogging() 
      booleangetKeepOldLogFiles() +
      Returns false by default.
      +
      booleangetLockConflictDeadlockDetectMode() +
      Returns true if deadlock detection is run whenever a lock conflict occurs.
      +
      doublegetLockTimeout() +
      Returns the lock timeout, in seconds.
      +
      longgetLockTimeoutInMicroseconds() +
      Returns the lock timeout, in microseconds, limited to max long value.
      +
      java.lang.IntegergetLogFileMaxSize() +
      Returns null if default size will be used.
      +
      booleangetLogInMemory() +
      Returns false by default, indicating that transaction logs are persisted.
      +
      java.lang.IntegergetLogRegionSize() +
      Returns the repository log region size, or null if the default + should be selected.
      +
      java.lang.IntegergetMaxLocks() 
      java.lang.StringgetName() +
      Returns the name of the repository.
      +
      BDBPanicHandlergetPanicHandler() +
      Return the panic handler to call if the database panics.
      +
      java.lang.RunnablegetPreShutdownHook() +
      Returns the custom shutdown hook that runs before the repository has + finished running its own shutdown hooks, or null if none.
      +
      java.lang.StringgetProduct() +
      Returns the BDB product to use, which is JE by default.
      +
      booleangetReadOnly() +
      Returns true if repository should be opened read-only.
      +
      booleangetRunCheckpointer() +
      Returns true if checkpointer is run automatically.
      +
      booleangetRunDeadlockDetector() +
      Returns true if deadlock detector is configured to run.
      +
      booleangetRunFullRecovery() +
      Returns true if a full (catastrophic) recovery should be performed when + environment is opened.
      +
      java.lang.RunnablegetShutdownHook() +
      Returns the custom shutdown hook that runs after the repository has + finished running its own shutdown hooks, or null if none.
      +
      java.lang.StringgetSingleFileName() +
      Returns the single file that all BDB databases should reside in.
      +
      StorableCodecFactorygetStorableCodecFactory() +
      Returns the storable codec factory used.
      +
      java.lang.IntegergetTransactionMaxActive() +
      Returns the maximum number of concurrent transactions, or null if the + default is used.
      +
      booleangetTransactionNoSync() +
      Returns true if transactions are not written or flushed to disk.
      +
      doublegetTransactionTimeout() +
      Returns the repository transaction timeout, in seconds.
      +
      longgetTransactionTimeoutInMicroseconds() +
      Returns the repository transaction timeout, in microseconds, limited to + max long value.
      +
      booleangetTransactionWriteNoSync() +
      Returns true if transactions are not flushed to disk.
      +
      booleanisIndexRepairEnabled() 
      booleanisMaster() +
      Returns true if repository should assume the role of master, which is + true by default.
      +
      booleanisMultiversion() +
      Returns false by default because multiversion concurrency control (MVCC) + is not enabled.
      +
      booleanisPrivate() +
      Returns true if BDB environment is private.
      +
      booleanisReverseSplitOff() 
      voidsetBDBProduct(BDBProduct product) +
      Sets the BDB product to use, which defaults to JE.
      +
      voidsetCachePercent(int cachePercent) +
      Set the percent of JVM heap used by the repository cache.
      +
      voidsetCachePercent(java.lang.Integer cachePercent) +
      Set the percent of JVM heap used by the repository cache.
      +
      voidsetCacheSize(long cacheSize) +
      Set the repository cache size, in bytes.
      +
      voidsetCacheSize(java.lang.Long cacheSize) +
      Set the repository cache size, in bytes.
      +
      voidsetCheckpointInterval(int intervalMillis) +
      Set the interval to run checkpoints.
      +
      voidsetCheckpointThresholdKB(int thresholdKB) +
      Set the size threshold to run checkpoints.
      +
      voidsetCheckpointThresholdMinutes(int thresholdMinutes) +
      Set the time threshold to run checkpoints.
      +
      voidsetChecksumEnabled(java.lang.Boolean checksumEnabled) +
      When true, enable checksum verification of pages read into the cache + from the backing filestore.
      +
      voidsetCompressor(java.lang.String type, + java.lang.String compressionType) +
      Set the compressor for the given class, overriding a custom StorableCodecFactory.
      +
      voidsetDatabaseHook(BDBRepositoryBuilder.DatabaseHook hook) +
      Sets a hook to be called whenever a database is opened.
      +
      voidsetDatabasePageSize(java.lang.Integer bytes, + java.lang.Class<? extends Storable> type) +
      Sets the desired page size for a given type.
      +
      voidsetDatabasesTransactional(java.lang.Boolean transactional) +
      When true, allows databases to be transactional.
      +
      voidsetDataHome(java.lang.String dir) +
      By default, data files are stored relative to the environment home.
      +
      voidsetDataHomeFile(java.io.File dir) +
      By default, data files are stored relative to the environment home.
      +
      voidsetEnvironmentHome(java.lang.String envHome) +
      Sets the repository environment home directory, which is required.
      +
      voidsetEnvironmentHomeFile(java.io.File envHome) +
      Sets the repository environment home directory, which is required.
      +
      voidsetFileName(java.lang.String filename, + java.lang.String typeName) +
      Specify the file that a BDB database should reside in, except for log + files and caches.
      +
      voidsetIndexRepairEnabled(boolean enabled) +
      By default, index repair is enabled.
      +
      voidsetIndexRepairThrottle(double desiredSpeed) +
      Sets the throttle parameter used when indexes are added, dropped or bulk + repaired.
      +
      voidsetIndexSupport(boolean indexSupport) +
      By default, user specified indexes are supported.
      +
      voidsetInitialDatabaseConfig(java.lang.Object dbConfig) +
      Optionally set the BDB specific database configuration to use + for all databases created.
      +
      voidsetInitialEnvironmentConfig(java.lang.Object envConfig) +
      Optionally set the BDB specific environment configuration to + use.
      +
      voidsetInitializeLogging(boolean b) +
      Ensure the transaction logging sub-system is initialized, which is + usually implied.
      +
      voidsetKeepOldLogFiles(boolean keep) +
      By default, transaction log files are deleted when no longer needed.
      +
      voidsetLockConflictDeadlockDetectMode(boolean b) +
      Enable deadlock detection whenever a lock conflict occurs.
      +
      voidsetLockTimeout(double lockTimeout) +
      Set the lock timeout, in seconds.
      +
      voidsetLogFileMaxSize(java.lang.Integer sizeInBytes) +
      Set the maximum transaction log file size for the BDB environment.
      +
      voidsetLogInMemory(boolean logInMemory) +
      Set true to store transaction logs in memory only instead of persistent + storage.
      +
      voidsetLogRegionSize(int logRegionSize) +
      Set the repository log region size, in bytes.
      +
      voidsetLogRegionSize(java.lang.Integer logRegionSize) +
      Set the repository log region size, in bytes.
      +
      voidsetMaster(boolean b) +
      Set to false if repository should not assume the role of master.
      +
      voidsetMaxLocks(java.lang.Integer max) 
      voidsetMultiversion(boolean multiversion) +
      Set true to enable multiversion concurrency control (MVCC) on BDB + environment.
      +
      voidsetName(java.lang.String name) +
      Set name for the repository, which is required.
      +
      voidsetPanicHandler(BDBPanicHandler handler) +
      Set the handler to call if the database panics.
      +
      voidsetPreShutdownHook(java.lang.Runnable hook) +
      Sets a callback to be invoked before the repository has finished running + its own shutdown hooks.
      +
      voidsetPrivate(boolean b) +
      When true, BDB environment cannot be shared by other processes, and + region files are not created.
      +
      voidsetProduct(java.lang.String product) +
      Sets the BDB product to use, which defaults to JE.
      +
      voidsetReadOnly(boolean readOnly) +
      Sets the repository to read-only mode.
      +
      voidsetReverseSplitOff(boolean off) +
      Pass true to disable reverse split of B-tree nodes to reduce deadlocks.
      +
      voidsetRunCheckpointer(boolean runCheckpointer) +
      Disable automatic checkpointing of database if another process is + responsible for that.
      +
      voidsetRunDeadlockDetector(boolean runDeadlockDetector) +
      Disable automatic deadlock detection of database if another thread is + responsible for that.
      +
      voidsetRunFullRecovery(boolean runRecovery) +
      Pass true to override the default and run a full (catastrophic) recovery + when environment is opened.
      +
      voidsetShutdownHook(java.lang.Runnable hook) +
      Sets a callback to be invoked after repository has finished running its + own shutdown hooks.
      +
      voidsetSingleFileName(java.lang.String filename) +
      Specify that all BDB databases should reside in one file, except for log + files and caches.
      +
      voidsetStorableCodecFactory(StorableCodecFactory factory) +
      Override the default storable codec factory.
      +
      voidsetTransactionMaxActive(java.lang.Integer max) +
      Set the maximum number of concurrent transactions, or pass null to use + the default.
      +
      voidsetTransactionNoSync(boolean noSync) +
      When true, commits are not immediately written or flushed to disk.
      +
      voidsetTransactionTimeout(double txnTimeout) +
      Set the transaction timeout, in seconds.
      +
      voidsetTransactionWriteNoSync(boolean noSync) +
      When true, commits are written, but they are not flushed to disk.
      +
      booleanverify(java.io.PrintStream out) +
      Opens the BDB environment, checks if it is corrupt, and then closes it.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BDBRepositoryBuilder

        +
        public BDBRepositoryBuilder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        build

        +
        public Repository build(java.util.concurrent.atomic.AtomicReference<Repository> rootRef)
+                 throws RepositoryException
        +
        Description copied from interface: RepositoryBuilder
        +
        Builds a repository instance. + +

        If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.

        +
        Parameters:
        rootRef - reference to root parent repository, to be set by + parent repository upon being built
        +
        Throws:
        +
        ConfigurationException - if there is a problem in the builder's configuration
        +
        RepositoryException - if there is a general problem opening the repository
        +
        • +
      + + + +
        +
      • +

        verify

        +
        public boolean verify(java.io.PrintStream out)
+               throws RepositoryException
        +
        Opens the BDB environment, checks if it is corrupt, and then closes it. + Only one process should open the environment for verification. Expect it + to take a long time.
        +
        Parameters:
        out - optional stream to capture any verfication errors
        +
        Returns:
        true if environment passes verification
        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns the name of the repository.
        +
        • +
      + + + +
        +
      • +

        setName

        +
        public void setName(java.lang.String name)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set name for the repository, which is required.
        +
        • +
      + + + +
        +
      • +

        isMaster

        +
        public boolean isMaster()
        +
        Description copied from interface: RepositoryBuilder
        +
        Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        setMaster

        +
        public void setMaster(boolean b)
        +
        Description copied from interface: RepositoryBuilder
        +
        Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + +

        A master repository is responsible for version and + sequence properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an OptimisticLockException should be thrown.

        +
        See Also:
        ReplicatedRepositoryBuilder
        +
        • +
      + + + +
        +
      • +

        setProduct

        +
        public void setProduct(java.lang.String product)
        +
        Sets the BDB product to use, which defaults to JE. Also supported is DB + and DB_HA. If not supported, an IllegalArgumentException is thrown.
        +
        • +
      + + + +
        +
      • +

        getProduct

        +
        public java.lang.String getProduct()
        +
        Returns the BDB product to use, which is JE by default.
        +
        • +
      + + + +
        +
      • +

        setBDBProduct

        +
        public void setBDBProduct(BDBProduct product)
        +
        Sets the BDB product to use, which defaults to JE.
        +
        • +
      + + + +
        +
      • +

        getBDBProduct

        +
        public BDBProduct getBDBProduct()
        +
        Returns the BDB product to use, which is JE by default.
        +
        • +
      + + + +
        +
      • +

        setEnvironmentHomeFile

        +
        public void setEnvironmentHomeFile(java.io.File envHome)
        +
        Sets the repository environment home directory, which is required.
        +
        • +
      + + + +
        +
      • +

        getEnvironmentHomeFile

        +
        public java.io.File getEnvironmentHomeFile()
        +
        Returns the repository environment home directory.
        +
        • +
      + + + +
        +
      • +

        setEnvironmentHome

        +
        public void setEnvironmentHome(java.lang.String envHome)
        +
        Sets the repository environment home directory, which is required.
        +
        Throws:
        +
        RepositoryException - if environment home is not valid
        +
        • +
      + + + +
        +
      • +

        getEnvironmentHome

        +
        public java.lang.String getEnvironmentHome()
        +
        Returns the repository environment home directory.
        +
        • +
      + + + +
        +
      • +

        setDataHomeFile

        +
        public void setDataHomeFile(java.io.File dir)
        +
        By default, data files are stored relative to the environment home. Call + this method to override. For BDBRepositories that are log files only, + this configuration is ignored.
        +
        • +
      + + + +
        +
      • +

        getDataHomeFile

        +
        public java.io.File getDataHomeFile()
        +
        Returns the optional directory to store data files. Returns null if data + files are expected to be relative to the environment home.
        +
        • +
      + + + +
        +
      • +

        setDataHome

        +
        public void setDataHome(java.lang.String dir)
        +
        By default, data files are stored relative to the environment home. Call + this method to override. For BDBRepositories that are log files only, + this configuration is ignored.
        +
        • +
      + + + +
        +
      • +

        getDataHome

        +
        public java.lang.String getDataHome()
        +
        Returns the directory to store data files.
        +
        • +
      + + + +
        +
      • +

        setSingleFileName

        +
        public void setSingleFileName(java.lang.String filename)
        +
        Specify that all BDB databases should reside in one file, except for log + files and caches. The filename is relative to the environment home, + unless data directories have been specified. For BDBRepositories that + are log files only, this configuration is ignored. + +

        Note: When setting this option, the storable codec factory must also + be changed, since the default storable codec factory is unable to + distinguish storable types that reside in a single database file. Call + setFileName instead to use built-in BDB feature for supporting multiple + databases in one file.

        +
        • +
      + + + +
        +
      • +

        getSingleFileName

        +
        public java.lang.String getSingleFileName()
        +
        Returns the single file that all BDB databases should reside in.
        +
        • +
      + + + +
        +
      • +

        setFileName

        +
        public void setFileName(java.lang.String filename,
+               java.lang.String typeName)
        +
        Specify the file that a BDB database should reside in, except for log + files and caches. The filename is relative to the environment home, + unless data directories have been specified. For BDBRepositories that + are log files only, this configuration is ignored.
        +
        Parameters:
        filename - BDB database filename
        typeName - type to store in file; if null, the file is used by default + for all types
        +
        • +
      + + + +
        +
      • +

        setIndexSupport

        +
        public void setIndexSupport(boolean indexSupport)
        +
        By default, user specified indexes are supported. Pass false to disable + this, and no indexes will be built. Another consequence of this option + is that no unique constraint checks will be applied to alternate keys.
        +
        • +
      + + + +
        +
      • +

        getIndexSupport

        +
        public boolean getIndexSupport()
        +
        Returns true if indexes are supported, which is true by default.
        +
        • +
      + + + + + + + +
        +
      • +

        setIndexRepairEnabled

        +
        public void setIndexRepairEnabled(boolean enabled)
        +
        By default, index repair is enabled. In this mode, the first time a + Storable type is used, new indexes are populated and old indexes are + removed. Until finished, access to the Storable is blocked. + +

        When index repair is disabled, the Storable is immediately + available. This does have consequences, however. The set of indexes + available for queries is defined by the intersection of the old + and new index sets. The set of indexes that are kept up-to-date is + defined by the union of the old and new index sets. + +

        While index repair is disabled, another process can safely repair the + indexes in the background. When it is complete, index repair can be + enabled for this repository too.

        +
        • +
      + + + +
        +
      • +

        getIndexRepairThrottle

        +
        public double getIndexRepairThrottle()
        +
        Returns the throttle parameter used when indexes are added, dropped or + bulk repaired. By default this value is 1.0, or maximum speed.
        +
        • +
      + + + +
        +
      • +

        setIndexRepairThrottle

        +
        public void setIndexRepairThrottle(double desiredSpeed)
        +
        Sets the throttle parameter used when indexes are added, dropped or bulk + repaired. By default this value is 1.0, or maximum speed.
        +
        Parameters:
        desiredSpeed - 1.0 = perform work at full speed, + 0.5 = perform work at half speed, 0.0 = fully suspend work
        +
        • +
      + + + +
        +
      • +

        setReadOnly

        +
        public void setReadOnly(boolean readOnly)
        +
        Sets the repository to read-only mode. By default, repository is opened + for reads and writes.
        +
        • +
      + + + +
        +
      • +

        getReadOnly

        +
        public boolean getReadOnly()
        +
        Returns true if repository should be opened read-only.
        +
        • +
      + + + +
        +
      • +

        setCacheSize

        +
        public void setCacheSize(long cacheSize)
        +
        Set the repository cache size, in bytes. Actual BDB implementation will + select a suitable default if this is not set.
        +
        • +
      + + + +
        +
      • +

        setCacheSize

        +
        public void setCacheSize(java.lang.Long cacheSize)
        +
        Set the repository cache size, in bytes. Actual BDB implementation will + select a suitable default if this is not set.
        +
        Parameters:
        cacheSize - cache size to use, or null for default
        +
        • +
      + + + +
        +
      • +

        getCacheSize

        +
        public java.lang.Long getCacheSize()
        +
        Returns the repository cache size, or null if default should be + selected.
        +
        • +
      + + + +
        +
      • +

        setLogRegionSize

        +
        public void setLogRegionSize(int logRegionSize)
        +
        Set the repository log region size, in bytes.
        +
        • +
      + + + +
        +
      • +

        setLogRegionSize

        +
        public void setLogRegionSize(java.lang.Integer logRegionSize)
        +
        Set the repository log region size, in bytes.
        +
        • +
      + + + +
        +
      • +

        getLogRegionSize

        +
        public java.lang.Integer getLogRegionSize()
        +
        Returns the repository log region size, or null if the default + should be selected.
        +
        • +
      + + + +
        +
      • +

        setCachePercent

        +
        public void setCachePercent(int cachePercent)
        +
        Set the percent of JVM heap used by the repository cache. Actual + BDB implementation will select a suitable default if this is not + set. This is overridden by setting an explicit cacheSize.
        +
        • +
      + + + +
        +
      • +

        setCachePercent

        +
        public void setCachePercent(java.lang.Integer cachePercent)
        +
        Set the percent of JVM heap used by the repository cache. Actual + BDB implementation will select a suitable default if this is not + set. This is overridden by setting an explicit cacheSize.
        +
        Parameters:
        cachePercent - percent of JVM heap to use, or null for default
        +
        • +
      + + + +
        +
      • +

        getCachePercent

        +
        public java.lang.Integer getCachePercent()
        +
        Returns the percent of JVM heap used by the repository cache, or + null if default should be selected.
        +
        • +
      + + + +
        +
      • +

        setLockTimeout

        +
        public void setLockTimeout(double lockTimeout)
        +
        Set the lock timeout, in seconds. Default value is 0.5 seconds.
        +
        • +
      + + + +
        +
      • +

        getLockTimeout

        +
        public double getLockTimeout()
        +
        Returns the lock timeout, in seconds.
        +
        • +
      + + + +
        +
      • +

        getLockTimeoutInMicroseconds

        +
        public long getLockTimeoutInMicroseconds()
        +
        Returns the lock timeout, in microseconds, limited to max long value.
        +
        • +
      + + + +
        +
      • +

        setMaxLocks

        +
        public void setMaxLocks(java.lang.Integer max)
        +
        • +
      + + + +
        +
      • +

        getMaxLocks

        +
        public java.lang.Integer getMaxLocks()
        +
        • +
      + + + +
        +
      • +

        setTransactionTimeout

        +
        public void setTransactionTimeout(double txnTimeout)
        +
        Set the transaction timeout, in seconds. Default value is 300 seconds.
        +
        • +
      + + + +
        +
      • +

        getTransactionTimeout

        +
        public double getTransactionTimeout()
        +
        Returns the repository transaction timeout, in seconds.
        +
        • +
      + + + +
        +
      • +

        getTransactionTimeoutInMicroseconds

        +
        public long getTransactionTimeoutInMicroseconds()
        +
        Returns the repository transaction timeout, in microseconds, limited to + max long value.
        +
        • +
      + + + +
        +
      • +

        setTransactionNoSync

        +
        public void setTransactionNoSync(boolean noSync)
        +
        When true, commits are not immediately written or flushed to disk. This + improves performance, but there is a chance of losing the most recent + commits if the process is killed or if the machine crashes.
        +
        • +
      + + + +
        +
      • +

        getTransactionNoSync

        +
        public boolean getTransactionNoSync()
        +
        Returns true if transactions are not written or flushed to disk.
        +
        • +
      + + + +
        +
      • +

        setTransactionWriteNoSync

        +
        public void setTransactionWriteNoSync(boolean noSync)
        +
        When true, commits are written, but they are not flushed to disk. This + improves performance, but there is a chance of losing the most recent + commits if the machine crashes.
        +
        • +
      + + + +
        +
      • +

        getTransactionWriteNoSync

        +
        public boolean getTransactionWriteNoSync()
        +
        Returns true if transactions are not flushed to disk.
        +
        • +
      + + + +
        +
      • +

        setTransactionMaxActive

        +
        public void setTransactionMaxActive(java.lang.Integer max)
        +
        Set the maximum number of concurrent transactions, or pass null to use + the default. This setting has no effect for BDB-JE.
        +
        • +
      + + + +
        +
      • +

        getTransactionMaxActive

        +
        public java.lang.Integer getTransactionMaxActive()
        +
        Returns the maximum number of concurrent transactions, or null if the + default is used.
        +
        • +
      + + + +
        +
      • +

        setDatabasesTransactional

        +
        public void setDatabasesTransactional(java.lang.Boolean transactional)
        +
        When true, allows databases to be transactional. This setting affects + the databases, not the environment. If this is not explicitly set, the + environment getTransactional is used.
        +
        • +
      + + + +
        +
      • +

        getDatabasesTransactional

        +
        public java.lang.Boolean getDatabasesTransactional()
        +
        Returns true if the databases are configured to be transactional, + false if configured to not be transactional, null if this override was never set
        +
        • +
      + + + +
        +
      • +

        setReverseSplitOff

        +
        public void setReverseSplitOff(boolean off)
        +
        Pass true to disable reverse split of B-tree nodes to reduce deadlocks. + This setting has no effect for BDB-JE.
        +
        • +
      + + + +
        +
      • +

        isReverseSplitOff

        +
        public boolean isReverseSplitOff()
        +
        • +
      + + + +
        +
      • +

        setDatabasePageSize

        +
        public void setDatabasePageSize(java.lang.Integer bytes,
+                       java.lang.Class<? extends Storable> type)
        +
        Sets the desired page size for a given type. If not specified, the page + size applies to all types.
        +
        • +
      + + + +
        +
      • +

        setPrivate

        +
        public void setPrivate(boolean b)
        +
        When true, BDB environment cannot be shared by other processes, and + region files are not created. By default, environment is shared, if + supported.
        +
        • +
      + + + +
        +
      • +

        isPrivate

        +
        public boolean isPrivate()
        +
        Returns true if BDB environment is private. By default, environment is + shared, if supported.
        +
        • +
      + + + +
        +
      • +

        setMultiversion

        +
        public void setMultiversion(boolean multiversion)
        +
        Set true to enable multiversion concurrency control (MVCC) on BDB + environment. This enables snapshot isolation, and is it is not supported + by all BDB products and versions.
        +
        • +
      + + + +
        +
      • +

        isMultiversion

        +
        public boolean isMultiversion()
        +
        Returns false by default because multiversion concurrency control (MVCC) + is not enabled.
        +
        • +
      + + + +
        +
      • +

        setLogInMemory

        +
        public void setLogInMemory(boolean logInMemory)
        +
        Set true to store transaction logs in memory only instead of persistent + storage. For BDB products which are entirely log based, no records are + ever persisted.
        +
        • +
      + + + +
        +
      • +

        getLogInMemory

        +
        public boolean getLogInMemory()
        +
        Returns false by default, indicating that transaction logs are persisted.
        +
        • +
      + + + +
        +
      • +

        setLogFileMaxSize

        +
        public void setLogFileMaxSize(java.lang.Integer sizeInBytes)
        +
        Set the maximum transaction log file size for the BDB environment.
        +
        • +
      + + + +
        +
      • +

        getLogFileMaxSize

        +
        public java.lang.Integer getLogFileMaxSize()
        +
        Returns null if default size will be used.
        +
        • +
      + + + +
        +
      • +

        setInitializeLogging

        +
        public void setInitializeLogging(boolean b)
        +
        Ensure the transaction logging sub-system is initialized, which is + usually implied.
        +
        • +
      + + + +
        +
      • +

        getInitializeLogging

        +
        public boolean getInitializeLogging()
        +
        • +
      + + + +
        +
      • +

        setRunFullRecovery

        +
        public void setRunFullRecovery(boolean runRecovery)
        +
        Pass true to override the default and run a full (catastrophic) recovery + when environment is opened. This setting has no effect for BDB-JE.
        +
        • +
      + + + +
        +
      • +

        getRunFullRecovery

        +
        public boolean getRunFullRecovery()
        +
        Returns true if a full (catastrophic) recovery should be performed when + environment is opened.
        +
        • +
      + + + +
        +
      • +

        setRunCheckpointer

        +
        public void setRunCheckpointer(boolean runCheckpointer)
        +
        Disable automatic checkpointing of database if another process is + responsible for that. The false setting is implied for read-only + databases.
        +
        • +
      + + + +
        +
      • +

        getRunCheckpointer

        +
        public boolean getRunCheckpointer()
        +
        Returns true if checkpointer is run automatically.
        +
        • +
      + + + +
        +
      • +

        setCheckpointInterval

        +
        public void setCheckpointInterval(int intervalMillis)
        +
        Set the interval to run checkpoints. This setting is ignored if the + checkpointer is not configured to run.
        +
        Parameters:
        intervalMillis - interval between checkpoints, in milliseconds
        +
        • +
      + + + +
        +
      • +

        getCheckpointInterval

        +
        public int getCheckpointInterval()
        +
        Returns:
        interval between checkpoints, in milliseconds
        +
        • +
      + + + +
        +
      • +

        setCheckpointThresholdKB

        +
        public void setCheckpointThresholdKB(int thresholdKB)
        +
        Set the size threshold to run checkpoints. This setting is ignored if + the checkpointer is not configured to run. Default value is 1024 KB. + +

        Checkpoint threshold is only used by Carbonado's built-in + checkpointer, and is ignored when using BDB-JE.

        +
        Parameters:
        thresholdKB - run checkpoint if at least this many kilobytes in log
        +
        • +
      + + + +
        +
      • +

        getCheckpointThresholdKB

        +
        public int getCheckpointThresholdKB()
        +
        Returns:
        run checkpoint if at least this many kilobytes in log
        +
        • +
      + + + +
        +
      • +

        setCheckpointThresholdMinutes

        +
        public void setCheckpointThresholdMinutes(int thresholdMinutes)
        +
        Set the time threshold to run checkpoints. This setting is ignored if + the checkpointer is not configured to run. Default value is 1 minute. + +

        Checkpoint threshold is only used by Carbonado's built-in + checkpointer, and is ignored when using BDB-JE.

        +
        Parameters:
        thresholdMinutes - run checkpoint if at least this many minutes + passed since last checkpoint
        +
        • +
      + + + +
        +
      • +

        getCheckpointThresholdMinutes

        +
        public int getCheckpointThresholdMinutes()
        +
        Returns:
        run checkpoint if at least this many minutes passed since last + checkpoint
        +
        • +
      + + + +
        +
      • +

        setKeepOldLogFiles

        +
        public void setKeepOldLogFiles(boolean keep)
        +
        By default, transaction log files are deleted when no longer needed. + Keeping log files can be used for incremental backups or for diagnosing + problems. If using BDB-JE, old log files are renamed with a ".del" + extension. If using BDB-core, the db_archive utility is required for + identifying old log files.
        +
        • +
      + + + +
        +
      • +

        getKeepOldLogFiles

        +
        public boolean getKeepOldLogFiles()
        +
        Returns false by default.
        +
        • +
      + + + +
        +
      • +

        setRunDeadlockDetector

        +
        public void setRunDeadlockDetector(boolean runDeadlockDetector)
        +
        Disable automatic deadlock detection of database if another thread is + responsible for that.
        +
        • +
      + + + +
        +
      • +

        getRunDeadlockDetector

        +
        public boolean getRunDeadlockDetector()
        +
        Returns true if deadlock detector is configured to run.
        +
        • +
      + + + +
        +
      • +

        setLockConflictDeadlockDetectMode

        +
        public void setLockConflictDeadlockDetectMode(boolean b)
        +
        Enable deadlock detection whenever a lock conflict occurs. Default is + off, and it has no effect for BDB-JE.
        +
        • +
      + + + +
        +
      • +

        getLockConflictDeadlockDetectMode

        +
        public boolean getLockConflictDeadlockDetectMode()
        +
        Returns true if deadlock detection is run whenever a lock conflict occurs.
        +
        • +
      + + + +
        +
      • +

        setChecksumEnabled

        +
        public void setChecksumEnabled(java.lang.Boolean checksumEnabled)
        +
        When true, enable checksum verification of pages read into the cache + from the backing filestore. By default checksum is enabled for BDB-JE, + and disabled for BDB-C.
        +
        • +
      + + + +
        +
      • +

        getChecksumEnabled

        +
        public java.lang.Boolean getChecksumEnabled()
        +
        Returns true if checksum verification is enabled. Returns null if the + BDB default is used.
        +
        • +
      + + + +
        +
      • +

        setInitialEnvironmentConfig

        +
        public void setInitialEnvironmentConfig(java.lang.Object envConfig)
        +
        Optionally set the BDB specific environment configuration to + use. The builder will verify that needed configuration values are set.
        +
        • +
      + + + +
        +
      • +

        getInitialEnvironmentConfig

        +
        public java.lang.Object getInitialEnvironmentConfig()
        +
        Returns the optional BDB specific environment configuration to use.
        +
        • +
      + + + +
        +
      • +

        setInitialDatabaseConfig

        +
        public void setInitialDatabaseConfig(java.lang.Object dbConfig)
        +
        Optionally set the BDB specific database configuration to use + for all databases created. The storage will verify that needed + configuration values are set.
        +
        • +
      + + + +
        +
      • +

        getInitialDatabaseConfig

        +
        public java.lang.Object getInitialDatabaseConfig()
        +
        Returns the optional BDB specific database configuration to use + for all databases created.
        +
        • +
      + + + +
        +
      • +

        setStorableCodecFactory

        +
        public void setStorableCodecFactory(StorableCodecFactory factory)
        +
        Override the default storable codec factory.
        +
        • +
      + + + +
        +
      • +

        getStorableCodecFactory

        +
        public StorableCodecFactory getStorableCodecFactory()
        +
        Returns the storable codec factory used.
        +
        • +
      + + + +
        +
      • +

        setPreShutdownHook

        +
        public void setPreShutdownHook(java.lang.Runnable hook)
        +
        Sets a callback to be invoked before the repository has finished running + its own shutdown hooks. This method is also invoked when repository is + manually closed.
        +
        • +
      + + + +
        +
      • +

        getPreShutdownHook

        +
        public java.lang.Runnable getPreShutdownHook()
        +
        Returns the custom shutdown hook that runs before the repository has + finished running its own shutdown hooks, or null if none.
        +
        • +
      + + + +
        +
      • +

        setShutdownHook

        +
        public void setShutdownHook(java.lang.Runnable hook)
        +
        Sets a callback to be invoked after repository has finished running its + own shutdown hooks. This method is also invoked when repository is + manually closed.
        +
        • +
      + + + +
        +
      • +

        getShutdownHook

        +
        public java.lang.Runnable getShutdownHook()
        +
        Returns the custom shutdown hook that runs after the repository has + finished running its own shutdown hooks, or null if none.
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        setCompressor

        +
        public void setCompressor(java.lang.String type,
+                 java.lang.String compressionType)
        +
        Set the compressor for the given class, overriding a custom StorableCodecFactory.
        +
        Parameters:
        type - Storable to compress.
        compressionType - String representation of type of + compression. Available options are "NONE" for no compression or "GZIP" + for gzip compression
        +
        • +
      + + + +
        +
      • +

        getCompressor

        +
        public java.lang.String getCompressor(java.lang.String type)
        +
        Return the compressor used for the given storable.
        +
        Parameters:
        type - Storable to compress
        +
        Returns:
        String representation of the type of compression used. Available options are "NONE" + for no compression and "GZIP" for gzip compression.
        +
        • +
      + + + +
        +
      • +

        setPanicHandler

        +
        public void setPanicHandler(BDBPanicHandler handler)
        +
        Set the handler to call if the database panics.
        +
        Parameters:
        handler -
        +
        • +
      + + + +
        +
      • +

        getPanicHandler

        +
        public BDBPanicHandler getPanicHandler()
        +
        Return the panic handler to call if the database panics.
        +
        Returns:
        The BDBPanicHandler or null if unset.
        +
        • +
      + + + +
        +
      • +

        errorCheck

        +
        public void errorCheck(java.util.Collection<java.lang.String> messages)
+                throws ConfigurationException
        +
        Description copied from class: AbstractRepositoryBuilder
        +
        This method is called by assertReady, and subclasses must override to + perform custom checks. Be sure to call super.errorCheck as well.
        +
        +
        Overrides:
        +
        errorCheck in class AbstractRepositoryBuilder
        +
        Parameters:
        messages - add any error messages to this list
        +
        Throws:
        +
        ConfigurationException - if error checking indirectly caused + another exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html new file mode 100644 index 0000000..9d9eaf1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html @@ -0,0 +1,291 @@ + + + + + + +CheckpointCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.sleepycat
+

Interface CheckpointCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface CheckpointCapability
+extends Capability
    +
    Capability to control BDB checkpointing.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    HotBackupCapability
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidforceCheckpoint() +
      Forces a checkpoint to run now, even if checkpointer is suspended or + disabled.
      +
      voidresumeCheckpointer() +
      Resumes the checkpointer if it was suspended.
      +
      voidsuspendCheckpointer(long suspensionTime) +
      Suspend the checkpointer until the suspension time has expired or until + manually resumed.
      +
      voidsync() +
      Synchronously flushes changes to stable storage, which is cheaper than + performing a checkpoint.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        suspendCheckpointer

        +
        void suspendCheckpointer(long suspensionTime)
        +
        Suspend the checkpointer until the suspension time has expired or until + manually resumed. If a checkpoint is in progress, this method will block + until it is finished. If checkpointing is disabled, calling this method + has no effect. + +

        Calling this method repeatedly resets the suspension time. Each + invocation of suspendCheckpointer is like a lease renewal or heartbeat.

        +
        Parameters:
        suspensionTime - minimum length of suspension, in milliseconds, + unless checkpointer is manually resumed
        +
        • +
      + + + +
        +
      • +

        resumeCheckpointer

        +
        void resumeCheckpointer()
        +
        Resumes the checkpointer if it was suspended. If checkpointing is + disabled or if not suspended, calling this method has no effect.
        +
        • +
      + + + +
        +
      • +

        forceCheckpoint

        +
        void forceCheckpoint()
+                     throws PersistException
        +
        Forces a checkpoint to run now, even if checkpointer is suspended or + disabled. If a checkpoint is in progress, then this method will block + until it is finished, and then run another checkpoint. This method does + not return until the requested checkpoint has finished.
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        sync

        +
        void sync()
+          throws PersistException
        +
        Synchronously flushes changes to stable storage, which is cheaper than + performing a checkpoint.
        +
        Throws:
        +
        PersistException
        Since:
        +
        1.2.2
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html b/apidocs/com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html new file mode 100644 index 0000000..bea8c9d --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html @@ -0,0 +1,264 @@ + + + + + + +CompactionCapability.Result (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.sleepycat
+

Interface CompactionCapability.Result<S extends Storable>

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPagesExamine

        +
        int getPagesExamine()
        +
        • +
      + + + +
        +
      • +

        getPagesFree

        +
        int getPagesFree()
        +
        • +
      + + + +
        +
      • +

        getPagesTruncated

        +
        int getPagesTruncated()
        +
        • +
      + + + +
        +
      • +

        getLevels

        +
        int getLevels()
        +
        • +
      + + + +
        +
      • +

        getDeadlockCount

        +
        int getDeadlockCount()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/CompactionCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/CompactionCapability.html new file mode 100644 index 0000000..1b0e2e6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/CompactionCapability.html @@ -0,0 +1,244 @@ + + + + + + +CompactionCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.sleepycat
+

Interface CompactionCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface CompactionCapability
+extends Capability
    +
    Capability to compact a BDB database. This capability is not supported by + all versions of BDB.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html new file mode 100644 index 0000000..08405e2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html @@ -0,0 +1,284 @@ + + + + + + +EnvironmentCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.sleepycat
+

Interface EnvironmentCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface EnvironmentCapability
+extends Capability
    +
    Capability to provide direct access to the underlying BDB environment.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      BDBProductgetBDBProduct() 
      java.io.FilegetDataHome() +
      Returns the directory where data files are stored, which is the same as + the home directory by default.
      +
      java.lang.ObjectgetEnvironment() +
      Returns the BDB environment object, which must be cast to the expected + type, depending on the BDB product and version being used.
      +
      java.io.FilegetHome() +
      Returns the home directory for the BDB environment.
      +
      int[]getVersion() +
      Returns the major, minor, and patch version numbers.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getEnvironment

        +
        java.lang.Object getEnvironment()
        +
        Returns the BDB environment object, which must be cast to the expected + type, depending on the BDB product and version being used.
        +
        • +
      + + + +
        +
      • +

        getBDBProduct

        +
        BDBProduct getBDBProduct()
        +
        • +
      + + + +
        +
      • +

        getVersion

        +
        int[] getVersion()
        +
        Returns the major, minor, and patch version numbers.
        +
        • +
      + + + +
        +
      • +

        getHome

        +
        java.io.File getHome()
        +
        Returns the home directory for the BDB environment.
        +
        • +
      + + + +
        +
      • +

        getDataHome

        +
        java.io.File getDataHome()
        +
        Returns the directory where data files are stored, which is the same as + the home directory by default.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html b/apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html new file mode 100644 index 0000000..e6dfea5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html @@ -0,0 +1,309 @@ + + + + + + +HotBackupCapability.Backup (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.sleepycat
+

Interface HotBackupCapability.Backup

+
+
+
+
    +
  • +
    +
    Enclosing interface:
    +
    HotBackupCapability
    +
    +
    +
    +
    public static interface HotBackupCapability.Backup
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidendBackup() +
      Resume normal operation.
      +
      java.io.File[]getDataFiles() +
      Returns all the data files to be copied.
      +
      java.io.File[]getFiles() +
      Deprecated.  +
      use getDataFiles and getLogFiles
      +
      +
      longgetLastLogNumber() +
      Can be called after a backup has been performed to find the last log file + that has been backed up.
      +
      java.io.File[]getLogFiles() +
      Returns all the transaction log files to be copied, in the exact + order in which they must be copied.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        getDataFiles

        +
        java.io.File[] getDataFiles()
+                            throws RepositoryException
        +
        Returns all the data files to be copied. After these files are + durably copied, call getLogFiles() and copy the log files + which were created while the data files were copied.
        +
        Returns:
        array of data files, which might be empty
        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        getLogFiles

        +
        java.io.File[] getLogFiles()
+                           throws RepositoryException
        +
        Returns all the transaction log files to be copied, in the exact + order in which they must be copied. After these files are durably + copied, call endBackup().
        +
        Returns:
        array of transaction log files, never empty
        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        getLastLogNumber

        +
        long getLastLogNumber()
+                      throws RepositoryException
        +
        Can be called after a backup has been performed to find the last log file + that has been backed up.
        +
        Returns:
        the file number of the last file in the current backup set. + This number is required to perform incremental backups.
        +
        Throws:
        +
        java.lang.IllegalStateException - if getFiles() was not called
        +
        RepositoryException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html new file mode 100644 index 0000000..a3632c0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html @@ -0,0 +1,333 @@ + + + + + + +HotBackupCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.sleepycat
+

Interface HotBackupCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface HotBackupCapability
+extends Capability
    +
    Capability for performing a backup of an active BDB environment. If in-memory logging is enabled, + backups cannot be performed. To restore from a hot backup, it is + critical that a full recovery be performed. Pass true to setRunFullRecovery to + enable. BDB-JE does not require this, however. + +

    To support incremental backups against the native + BDB product, old log files must be kept. Pass true to setKeepOldLogFiles.

    +
    Since:
    +
    1.2.1
    +
    Author:
    +
    Brian S O'Neill, Olga Kuznetsova
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        startBackup

        +
        HotBackupCapability.Backup startBackup()
+                                       throws RepositoryException
        +
        Starts the backup by disabling log file deletion. Be sure to call + endBackup when done to resume log file cleanup. Concurrent backups are + supported.
        +
        Throws:
        +
        java.lang.IllegalStateException - if configuration doesn't support backups
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        startBackup

        +
        HotBackupCapability.Backup startBackup(boolean deleteOldLogFiles)
+                                       throws RepositoryException
        +
        Starts the backup by disabling log file deletion. Be sure to call + endBackup when done to resume log file cleanup. Concurrent backups are supported. + +

        Caution should be observed when deleting old log files by force, if + an external process is also performing backups. If a concurrent backup + is issued by this repository instance, log file deletion is suppressed.

        +
        Parameters:
        deleteOldLogFiles - deletes log files that are no longer in use and + have been backed up. False by default.
        +
        Throws:
        +
        java.lang.IllegalStateException - if configuration doesn't support backups
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        startIncrementalBackup

        +
        HotBackupCapability.Backup startIncrementalBackup(long lastLogNumber)
+                                                  throws RepositoryException
        +
        Starts an incremental backup. Log files that are newer than the + lastLogNumber will be copied during the backup. Should only be run after + performing a full backup.
        +
        Parameters:
        lastLogNumber - number of the last log file that was copied in a previous backup
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if lastLogNumber is negative
        +
        java.lang.IllegalStateException - if configuration doesn't support backups
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        startIncrementalBackup

        +
        HotBackupCapability.Backup startIncrementalBackup(long lastLogNumber,
+                                                boolean deleteOldLogFiles)
+                                                  throws RepositoryException
        +
        Starts an incremental backup. Log files that are newer than the lastLogNumber will be copied + during the backup. Can only be run after performing a full backup. + +

        Caution should be observed when deleting old log files by force, if + an external process is also performing backups. If a concurrent backup + is issued by this repository instance, log file deletion is suppressed.

        +
        Parameters:
        lastLogNumber - number of the last log file that was copied in a previous backup.
        deleteOldLogFiles - deletes log files that are no longer in use and + have been backed up. False by default.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if lastLogNumber is negative
        +
        java.lang.IllegalStateException - if configuration doesn't support backups
        +
        RepositoryException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html b/apidocs/com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html new file mode 100644 index 0000000..dbd7d87 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html @@ -0,0 +1,537 @@ + + + + + + +StoredDatabaseInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.repo.sleepycat
+

Class StoredDatabaseInfo

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Unevolvable, Unindexed, Storable
    +
    +
    +
    +
    @PrimaryKey(value="databaseName")
+@Independent
+@Alias(value="CARBONADO_DATABASE_INFO")
+public abstract class StoredDatabaseInfo
+extends java.lang.Object
+implements Storable, Unevolvable, Unindexed
    +
    Stores basic information about the BDB databases managed by BDBRepository. + +

    Note: This storable cannot have indexes defined, since it is used to + discover information about indexes. It would create a cyclic dependency.

    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        EVOLUTION_NONE

        +
        public static final int EVOLUTION_NONE
        +
        Evolution strategy code
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        EVOLUTION_STANDARD

        +
        public static final int EVOLUTION_STANDARD
        +
        Evolution strategy code
        +
        See Also:
        Constant Field Values
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StoredDatabaseInfo

        +
        public StoredDatabaseInfo()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDatabaseName

        +
        public abstract java.lang.String getDatabaseName()
        +
        • +
      + + + +
        +
      • +

        setDatabaseName

        +
        public abstract void setDatabaseName(java.lang.String name)
        +
        • +
      + + + +
        +
      • +

        getIndexNameDescriptor

        +
        @Nullable
+public abstract java.lang.String getIndexNameDescriptor()
        +
        Returns the index name descriptor for the keys of this database. This + descriptor is defined by StorableIndex, and + it does not contain type information.
        +
        • +
      + + + +
        +
      • +

        setIndexNameDescriptor

        +
        public abstract void setIndexNameDescriptor(java.lang.String descriptor)
        +
        • +
      + + + +
        +
      • +

        getIndexTypeDescriptor

        +
        @Nullable
+public abstract java.lang.String getIndexTypeDescriptor()
        +
        Returns the types of the index properties. This descriptor is defined by + StorableIndex.
        +
        • +
      + + + +
        +
      • +

        setIndexTypeDescriptor

        +
        public abstract void setIndexTypeDescriptor(java.lang.String descriptor)
        +
        • +
      + + + +
        +
      • +

        getEvolutionStrategy

        +
        public abstract int getEvolutionStrategy()
        +
        Returns EVOLUTION_NONE if evolution of records is not supported.
        +
        • +
      + + + +
        +
      • +

        setEvolutionStrategy

        +
        public abstract void setEvolutionStrategy(int strategy)
        +
        • +
      + + + +
        +
      • +

        getCreationTimestamp

        +
        public abstract long getCreationTimestamp()
        +
        Returns the milliseconds from 1970-01-01T00:00:00Z when this record was + created.
        +
        • +
      + + + +
        +
      • +

        setCreationTimestamp

        +
        public abstract void setCreationTimestamp(long timestamp)
        +
        • +
      + + + +
        +
      • +

        getVersionNumber

        +
        @Version
+public abstract int getVersionNumber()
        +
        Record version number for this StoredDatabaseInfo instance. Some + encoding strategies require a version number.
        +
        • +
      + + + +
        +
      • +

        setVersionNumber

        +
        public abstract void setVersionNumber(int version)
        +
        • +
      + + + +
        +
      • +

        getExtraData

        +
        @Nullable
+public abstract byte[] getExtraData()
        +
        Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records. This record cannot evolve + because an evolution strategy likely depends on this interface remaining + stable, avoiding a cyclic dependency.
        +
        • +
      + + + +
        +
      • +

        setExtraData

        +
        public abstract void setExtraData(byte[] data)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBPanicHandler.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBPanicHandler.html new file mode 100644 index 0000000..37bc176 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBPanicHandler.html @@ -0,0 +1,177 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.sleepycat.BDBPanicHandler (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.sleepycat.BDBPanicHandler

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBProduct.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBProduct.html new file mode 100644 index 0000000..62c74c4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBProduct.html @@ -0,0 +1,198 @@ + + + + + + +Uses of Class com.amazon.carbonado.repo.sleepycat.BDBProduct (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.repo.sleepycat.BDBProduct

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.DatabaseHook.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.DatabaseHook.html new file mode 100644 index 0000000..80663c5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.DatabaseHook.html @@ -0,0 +1,177 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder.DatabaseHook (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder.DatabaseHook

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.html new file mode 100644 index 0000000..80aede2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder

+
+
No usage of com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CheckpointCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CheckpointCapability.html new file mode 100644 index 0000000..445c753 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CheckpointCapability.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.sleepycat.CheckpointCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.sleepycat.CheckpointCapability

+
+
No usage of com.amazon.carbonado.repo.sleepycat.CheckpointCapability
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.Result.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.Result.html new file mode 100644 index 0000000..d3ab8dc --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.Result.html @@ -0,0 +1,162 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.sleepycat.CompactionCapability.Result (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.sleepycat.CompactionCapability.Result

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.html new file mode 100644 index 0000000..f810a9f --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.sleepycat.CompactionCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.sleepycat.CompactionCapability

+
+
No usage of com.amazon.carbonado.repo.sleepycat.CompactionCapability
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/EnvironmentCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/EnvironmentCapability.html new file mode 100644 index 0000000..9a62e14 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/EnvironmentCapability.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.sleepycat.EnvironmentCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.sleepycat.EnvironmentCapability

+
+
No usage of com.amazon.carbonado.repo.sleepycat.EnvironmentCapability
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.Backup.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.Backup.html new file mode 100644 index 0000000..e2700fe --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.Backup.html @@ -0,0 +1,181 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.sleepycat.HotBackupCapability.Backup (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.sleepycat.HotBackupCapability.Backup

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.html new file mode 100644 index 0000000..30aef75 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.repo.sleepycat.HotBackupCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.repo.sleepycat.HotBackupCapability

+
+
No usage of com.amazon.carbonado.repo.sleepycat.HotBackupCapability
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/StoredDatabaseInfo.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/StoredDatabaseInfo.html new file mode 100644 index 0000000..4edaf72 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/StoredDatabaseInfo.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo

+
+
No usage of com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/package-frame.html b/apidocs/com/amazon/carbonado/repo/sleepycat/package-frame.html new file mode 100644 index 0000000..2c7c7b6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/package-frame.html @@ -0,0 +1,36 @@ + + + + + + +com.amazon.carbonado.repo.sleepycat (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.repo.sleepycat

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/package-summary.html b/apidocs/com/amazon/carbonado/repo/sleepycat/package-summary.html new file mode 100644 index 0000000..37f4909 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/package-summary.html @@ -0,0 +1,228 @@ + + + + + + +com.amazon.carbonado.repo.sleepycat (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.repo.sleepycat

+
+
Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.repo.sleepycat Description

+
Repository implementation backed by a Sleepycat (BDB, Berkeley) + database. Data is encoded in a specialized format, and so this repository + should not be used to open arbitrary Berkeley databases. BDBRepository has + total schema ownership, and so it updates type definitions in the storage + layer automatically.
+
See Also:
BDBRepositoryBuilder
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/package-tree.html b/apidocs/com/amazon/carbonado/repo/sleepycat/package-tree.html new file mode 100644 index 0000000..bb0eaa6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/package-tree.html @@ -0,0 +1,162 @@ + + + + + + +com.amazon.carbonado.repo.sleepycat Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.repo.sleepycat

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/package-use.html b/apidocs/com/amazon/carbonado/repo/sleepycat/package-use.html new file mode 100644 index 0000000..f403231 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/package-use.html @@ -0,0 +1,169 @@ + + + + + + +Uses of Package com.amazon.carbonado.repo.sleepycat (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.repo.sleepycat

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html b/apidocs/com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html new file mode 100644 index 0000000..eb8eeb8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html @@ -0,0 +1,363 @@ + + + + + + +AbstractSequenceValueProducer (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.sequence
+

Class AbstractSequenceValueProducer

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringnextDecimalValue() +
      Returns the next decimal string value from the sequence, which remains + positive.
      +
      intnextIntValue() +
      Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted.
      +
      java.lang.StringnextNumericalValue(int radix, + int minLength) +
      Returns the next numerical string value from the sequence, which remains + positive.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AbstractSequenceValueProducer

        +
        protected AbstractSequenceValueProducer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        nextIntValue

        +
        public int nextIntValue()
+                 throws PersistException
        +
        Description copied from interface: SequenceValueProducer
        +
        Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted. When sequence wraps back to initial + value, the sequence is fully exhausted, and an exception is thrown to + indicate this. + +

        Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.

        +
        +
        Specified by:
        +
        nextIntValue in interface SequenceValueProducer
        +
        Throws:
        +
        PersistException - for fetch/persist failure or if sequence is + exhausted for int values.
        +
        • +
      + + + +
        +
      • +

        nextDecimalValue

        +
        public java.lang.String nextDecimalValue()
+                                  throws PersistException
        +
        Description copied from interface: SequenceValueProducer
        +
        Returns the next decimal string value from the sequence, which remains + positive. When sequence wraps back to initial value, the sequence is + fully exhausted, and an exception is thrown to indicate this. + +

        Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.

        +
        +
        Specified by:
        +
        nextDecimalValue in interface SequenceValueProducer
        +
        Throws:
        +
        PersistException - for fetch/persist failure or if sequence is exhausted.
        +
        • +
      + + + +
        +
      • +

        nextNumericalValue

        +
        public java.lang.String nextNumericalValue(int radix,
+                                  int minLength)
+                                    throws PersistException
        +
        Description copied from interface: SequenceValueProducer
        +
        Returns the next numerical string value from the sequence, which remains + positive. When sequence wraps back to initial value, the sequence is + fully exhausted, and an exception is thrown to indicate this. + +

        Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.

        +
        +
        Specified by:
        +
        nextNumericalValue in interface SequenceValueProducer
        +
        Parameters:
        radix - use 2 for binary, 10 for decimal, 16 for hex. Max is 36.
        minLength - ensure string is at least this long (padded with zeros if + necessary) to ensure proper string sort
        +
        Throws:
        +
        PersistException - for fetch/persist failure or if sequence is exhausted.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/sequence/SequenceCapability.html b/apidocs/com/amazon/carbonado/sequence/SequenceCapability.html new file mode 100644 index 0000000..8da69eb --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/SequenceCapability.html @@ -0,0 +1,229 @@ + + + + + + +SequenceCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.sequence
+

Interface SequenceCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    All Known Implementing Classes:
    +
    AbstractRepository
    +
    +
    +
    +
    public interface SequenceCapability
+extends Capability
    +
    Capability to use sequences.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    bcastill
    +
    • +
+
+
+
    +
  • + + +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/sequence/SequenceValueGenerator.html b/apidocs/com/amazon/carbonado/sequence/SequenceValueGenerator.html new file mode 100644 index 0000000..d4dd7a4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/SequenceValueGenerator.html @@ -0,0 +1,512 @@ + + + + + + +SequenceValueGenerator (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.sequence
+

Class SequenceValueGenerator

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      SequenceValueGenerator(Repository repo, + java.lang.String name) +
      Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist.
      +
      SequenceValueGenerator(Repository repo, + java.lang.String name, + long initialValue, + int increment) +
      Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist.
      +
      SequenceValueGenerator(Repository repo, + java.lang.String name, + long initialValue, + int increment, + int reserveAmount) +
      Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      intnextIntValue() +
      Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted.
      +
      longnextLongValue() +
      Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted.
      +
      voidreset(int initialValue) +
      Reset the sequence.
      +
      booleanreturnReservedValues() +
      Allow any unused reserved values to be returned for re-use.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SequenceValueGenerator

        +
        public SequenceValueGenerator(Repository repo,
+                      java.lang.String name)
+                       throws RepositoryException
        +
        Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist. The initial sequence value is one, + and the increment is one.
        +
        Parameters:
        repo - repository to persist sequence data
        name - name of sequence
        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        SequenceValueGenerator

        +
        public SequenceValueGenerator(Repository repo,
+                      java.lang.String name,
+                      long initialValue,
+                      int increment)
+                       throws RepositoryException
        +
        Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist.
        +
        Parameters:
        repo - repository to persist sequence data
        name - name of sequence
        initialValue - initial sequence value, if sequence needs to be created
        increment - amount to increment sequence by
        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        SequenceValueGenerator

        +
        public SequenceValueGenerator(Repository repo,
+                      java.lang.String name,
+                      long initialValue,
+                      int increment,
+                      int reserveAmount)
+                       throws RepositoryException
        +
        Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist.
        +
        Parameters:
        repo - repository to persist sequence data
        name - name of sequence
        initialValue - initial sequence value, if sequence needs to be created
        increment - amount to increment sequence by
        reserveAmount - amount of sequence values to reserve
        +
        Throws:
        +
        RepositoryException
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        nextLongValue

        +
        public long nextLongValue()
+                   throws PersistException
        +
        Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted. When sequence wraps back to initial + value, the sequence is fully exhausted, and an exception is thrown to + indicate this. + +

        Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.

        +
        Throws:
        +
        PersistException - for fetch/persist failure or if sequence is exhausted.
        +
        • +
      + + + +
        +
      • +

        nextIntValue

        +
        public int nextIntValue()
+                 throws PersistException
        +
        Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted. When sequence wraps back to initial + value, the sequence is fully exhausted, and an exception is thrown to + indicate this. + +

        Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.

        +
        +
        Specified by:
        +
        nextIntValue in interface SequenceValueProducer
        +
        Overrides:
        +
        nextIntValue in class AbstractSequenceValueProducer
        +
        Throws:
        +
        PersistException - for fetch/persist failure or if sequence is + exhausted for int values.
        +
        • +
      + + + +
        +
      • +

        returnReservedValues

        +
        public boolean returnReservedValues()
+                             throws FetchException,
+                                    PersistException
        +
        Allow any unused reserved values to be returned for re-use. If the + repository is shared by other processes, then reserved values might not + be returnable. + +

        This method should be called during the shutdown process of a + repository, although calling it does not invalidate this + SequenceValueGenerator. If getNextValue is called again, it will reserve + values again.

        +
        Returns:
        true if reserved values were returned
        +
        Throws:
        +
        FetchException
        +
        PersistException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/sequence/SequenceValueProducer.html b/apidocs/com/amazon/carbonado/sequence/SequenceValueProducer.html new file mode 100644 index 0000000..44213bb --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/SequenceValueProducer.html @@ -0,0 +1,345 @@ + + + + + + +SequenceValueProducer (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.sequence
+

Interface SequenceValueProducer

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringnextDecimalValue() +
      Returns the next decimal string value from the sequence, which remains + positive.
      +
      intnextIntValue() +
      Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted.
      +
      longnextLongValue() +
      Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted.
      +
      java.lang.StringnextNumericalValue(int radix, + int minLength) +
      Returns the next numerical string value from the sequence, which remains + positive.
      +
      booleanreturnReservedValues() +
      Allow any unused reserved values to be returned for re-use.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        nextLongValue

        +
        long nextLongValue()
+                   throws PersistException
        +
        Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted. When sequence wraps back to initial + value, the sequence is fully exhausted, and an exception is thrown to + indicate this. + +

        Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.

        +
        Throws:
        +
        PersistException - for fetch/persist failure or if sequence is exhausted.
        +
        • +
      + + + +
        +
      • +

        nextIntValue

        +
        int nextIntValue()
+                 throws PersistException
        +
        Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted. When sequence wraps back to initial + value, the sequence is fully exhausted, and an exception is thrown to + indicate this. + +

        Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.

        +
        Throws:
        +
        PersistException - for fetch/persist failure or if sequence is + exhausted for int values.
        +
        • +
      + + + +
        +
      • +

        nextDecimalValue

        +
        java.lang.String nextDecimalValue()
+                                  throws PersistException
        +
        Returns the next decimal string value from the sequence, which remains + positive. When sequence wraps back to initial value, the sequence is + fully exhausted, and an exception is thrown to indicate this. + +

        Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.

        +
        Throws:
        +
        PersistException - for fetch/persist failure or if sequence is exhausted.
        +
        • +
      + + + +
        +
      • +

        nextNumericalValue

        +
        java.lang.String nextNumericalValue(int radix,
+                                  int minLength)
+                                    throws PersistException
        +
        Returns the next numerical string value from the sequence, which remains + positive. When sequence wraps back to initial value, the sequence is + fully exhausted, and an exception is thrown to indicate this. + +

        Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.

        +
        Parameters:
        radix - use 2 for binary, 10 for decimal, 16 for hex. Max is 36.
        minLength - ensure string is at least this long (padded with zeros if + necessary) to ensure proper string sort
        +
        Throws:
        +
        PersistException - for fetch/persist failure or if sequence is exhausted.
        +
        • +
      + + + +
        +
      • +

        returnReservedValues

        +
        boolean returnReservedValues()
+                             throws FetchException,
+                                    PersistException
        +
        Allow any unused reserved values to be returned for re-use. If the + repository is shared by other processes, then reserved values might not + be returnable. + +

        This method should be called during the shutdown process of a + repository, although calling it does not invalidate this + SequenceValueGenerator. If getNextValue is called again, it will reserve + values again.

        +
        Returns:
        true if reserved values were returned
        +
        Throws:
        +
        FetchException
        +
        PersistException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/sequence/SequenceValueProducerPool.html b/apidocs/com/amazon/carbonado/sequence/SequenceValueProducerPool.html new file mode 100644 index 0000000..175ff58 --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/SequenceValueProducerPool.html @@ -0,0 +1,347 @@ + + + + + + +SequenceValueProducerPool (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.sequence
+

Class SequenceValueProducerPool

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/sequence/StoredSequence.html b/apidocs/com/amazon/carbonado/sequence/StoredSequence.html new file mode 100644 index 0000000..c507bda --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/StoredSequence.html @@ -0,0 +1,343 @@ + + + + + + +StoredSequence (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.sequence
+

Interface StoredSequence

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Storable<StoredSequence>
    +
    +
    +
    +
    @PrimaryKey(value="name")
+@Authoritative
+@Independent
+@Alias(value={"CARBONADO_SEQUENCE","Carbonado_Sequence","carbonado_sequence","CarbonadoSequence","carbonadoSequence"})
+public interface StoredSequence
+extends Storable<StoredSequence>
    +
    Stores data for SequenceValueGenerator. To use with JDBC repository, + create a table like so: + + 
    + CREATE TABLE CARBONADO_SEQUENCE (
+     NAME           VARCHAR(100) PRIMARY KEY,
+     INITIAL_VALUE  BIGINT       NOT NULL,
+     NEXT_VALUE     BIGINT       NOT NULL,
+     VERSION        INT          NOT NULL
+ )
+
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        @Alias(value={"NAME","Name","name"})
+java.lang.String getName()
        +
        • +
      + + + +
        +
      • +

        setName

        +
        void setName(java.lang.String name)
        +
        • +
      + + + +
        +
      • +

        getInitialValue

        +
        @Alias(value={"INITIAL_VALUE","Initial_Value","initial_value","InitialValue","initialValue"})
+long getInitialValue()
        +
        Returns the initial value for the sequence.
        +
        • +
      + + + +
        +
      • +

        setInitialValue

        +
        void setInitialValue(long value)
        +
        • +
      + + + +
        +
      • +

        getNextValue

        +
        @Alias(value={"NEXT_VALUE","Next_Value","next_value","NextValue","nextValue"})
+long getNextValue()
        +
        Returns the pre-adjusted next value of the sequence. This value is + initially Long.MIN_VALUE, and it increments up to Long.MAX_VALUE. The actual + next value for the sequence is: (getNextValue() + Long.MIN_VALUE + getInitialValue()).
        +
        • +
      + + + +
        +
      • +

        setNextValue

        +
        void setNextValue(long value)
        +
        • +
      + + + + + + + +
        +
      • +

        setVersion

        +
        void setVersion(int version)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/sequence/class-use/AbstractSequenceValueProducer.html b/apidocs/com/amazon/carbonado/sequence/class-use/AbstractSequenceValueProducer.html new file mode 100644 index 0000000..b8b2ec5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/class-use/AbstractSequenceValueProducer.html @@ -0,0 +1,162 @@ + + + + + + +Uses of Class com.amazon.carbonado.sequence.AbstractSequenceValueProducer (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.sequence.AbstractSequenceValueProducer

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/sequence/class-use/SequenceCapability.html b/apidocs/com/amazon/carbonado/sequence/class-use/SequenceCapability.html new file mode 100644 index 0000000..6e45c69 --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/class-use/SequenceCapability.html @@ -0,0 +1,161 @@ + + + + + + +Uses of Interface com.amazon.carbonado.sequence.SequenceCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.sequence.SequenceCapability

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/sequence/class-use/SequenceValueGenerator.html b/apidocs/com/amazon/carbonado/sequence/class-use/SequenceValueGenerator.html new file mode 100644 index 0000000..0884b62 --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/class-use/SequenceValueGenerator.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.sequence.SequenceValueGenerator (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.sequence.SequenceValueGenerator

+
+
No usage of com.amazon.carbonado.sequence.SequenceValueGenerator
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/sequence/class-use/SequenceValueProducer.html b/apidocs/com/amazon/carbonado/sequence/class-use/SequenceValueProducer.html new file mode 100644 index 0000000..889f7fa --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/class-use/SequenceValueProducer.html @@ -0,0 +1,264 @@ + + + + + + +Uses of Interface com.amazon.carbonado.sequence.SequenceValueProducer (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.sequence.SequenceValueProducer

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/sequence/class-use/SequenceValueProducerPool.html b/apidocs/com/amazon/carbonado/sequence/class-use/SequenceValueProducerPool.html new file mode 100644 index 0000000..5577303 --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/class-use/SequenceValueProducerPool.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.sequence.SequenceValueProducerPool (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.sequence.SequenceValueProducerPool

+
+
No usage of com.amazon.carbonado.sequence.SequenceValueProducerPool
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/sequence/class-use/StoredSequence.html b/apidocs/com/amazon/carbonado/sequence/class-use/StoredSequence.html new file mode 100644 index 0000000..144e436 --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/class-use/StoredSequence.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.sequence.StoredSequence (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.sequence.StoredSequence

+
+
No usage of com.amazon.carbonado.sequence.StoredSequence
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/sequence/package-frame.html b/apidocs/com/amazon/carbonado/sequence/package-frame.html new file mode 100644 index 0000000..fb8fb71 --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/package-frame.html @@ -0,0 +1,28 @@ + + + + + + +com.amazon.carbonado.sequence (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.sequence

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/sequence/package-summary.html b/apidocs/com/amazon/carbonado/sequence/package-summary.html new file mode 100644 index 0000000..e7cc83a --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/package-summary.html @@ -0,0 +1,192 @@ + + + + + + +com.amazon.carbonado.sequence (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.sequence

+
+
Support for generating sequences of values, intended for creating surrogate + keys.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.sequence Description

+
Support for generating sequences of values, intended for creating surrogate + keys. Most repository implementations support sequences already, but direct + control over sequences might be desired.
+
Since:
+
1.2
+
See Also:
Sequence
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/sequence/package-tree.html b/apidocs/com/amazon/carbonado/sequence/package-tree.html new file mode 100644 index 0000000..fbb84a4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/package-tree.html @@ -0,0 +1,153 @@ + + + + + + +com.amazon.carbonado.sequence Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.sequence

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/sequence/package-use.html b/apidocs/com/amazon/carbonado/sequence/package-use.html new file mode 100644 index 0000000..2ea8e3a --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/package-use.html @@ -0,0 +1,209 @@ + + + + + + +Uses of Package com.amazon.carbonado.sequence (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.sequence

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/AbstractRepository.html b/apidocs/com/amazon/carbonado/spi/AbstractRepository.html new file mode 100644 index 0000000..1e5daa2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/AbstractRepository.html @@ -0,0 +1,759 @@ + + + + + + +AbstractRepository (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.spi
+

Class AbstractRepository<Txn>

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected AbstractRepository(java.lang.String name) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected java.util.Collection<Storage>allStorage() +
      Returns all available Storage instances.
      +
      voidclose() +
      Closes this repository reference, aborting any current + transactions.
      +
      protected abstract SequenceValueProducercreateSequenceValueProducer(java.lang.String name) +
      Called upon to create a new SequenceValueProducer instance.
      +
      protected abstract <S extends Storable> 
      Storage<S>      		createStorage(java.lang.Class<S> type) +
      Called upon to create a new Storage instance.
      +
      TransactionenterTopTransaction(IsolationLevel level) +
      Causes the current thread to enter a top-level transaction scope + with an explict isolation level.
      +
      TransactionenterTransaction() +
      Causes the current thread to enter a transaction scope.
      +
      TransactionenterTransaction(IsolationLevel level) +
      Causes the current thread to enter a transaction scope with an explict + isolation level.
      +
      <C extends Capability> 
      C      		getCapability(java.lang.Class<C> capabilityType) +
      Default implementation checks if Repository implements Capability + interface, and if so, returns the Repository.
      +
      protected abstract org.apache.commons.logging.LoggetLog() +
      Return the main Log object for this Repository.
      +
      java.lang.StringgetName() +
      Returns the name of this repository.
      +
      SequenceValueProducergetSequenceValueProducer(java.lang.String name) +
      Retrieve and/or generate a SequenceValueProducer for the given name.
      +
      IsolationLevelgetTransactionIsolationLevel() +
      Returns the isolation level of the current transaction, or null if there + is no transaction in the current thread.
      +
      booleanisAutoShutdownEnabled() +
      Returns true if repository has a shutdown hook registered to + automatically call shutdown when the virtual machine exits.
      +
      booleanisClosed() 
      protected abstract TransactionScope<Txn>localTransactionScope() +
      Returns the thread-local TransactionScope, creating it if needed.
      +
      protected voidlockoutShutdown() +
      Call to prevent shutdown hook from running.
      +
      voidsetAutoShutdownEnabled(boolean enabled) +
      Request to enable or disable the automatic shutdown hook.
      +
      voidshutdown() +
      Similar to calling close on a repository, except should only be called + when the virtual machine is in the process of shutting down.
      +
      protected voidshutdownHook() +
      Install custom shutdown logic by overriding this method.
      +
      <S extends Storable> 
      Storage<S>      		storageFor(java.lang.Class<S> type) +
      Returns a Storage instance for the given user defined Storable class or + interface.
      +
      protected abstract TransactionManager<Txn>transactionManager() +
      Returns the repository's TransactionManager.
      +
      protected voidunlockoutShutdown() +
      Only call this to release lockoutShutdown.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AbstractRepository

        +
        protected AbstractRepository(java.lang.String name)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Description copied from interface: Repository
        +
        Returns the name of this repository.
        +
        +
        Specified by:
        +
        getName in interface Repository
        +
        +
        • +
      + + + + + + + +
        +
      • +

        enterTransaction

        +
        public Transaction enterTransaction()
        +
        Description copied from interface: Repository
        +
        Causes the current thread to enter a transaction scope. Call commit + inside the transaction in order for any updates to the repository to be + applied. Be sure to call exit when leaving the scope. +

        + To ensure exit is called, use transactions as follows: + 

        + Transaction txn = repository.enterTransaction();
+ try {
+     // Make updates to storage layer
+     ...
+
+     // Commit the changes up to this point
+     txn.commit();
+
+     // Optionally make more updates
+     ...
+
+     // Commit remaining changes
+     txn.commit();
+ } finally {
+     // Ensure transaction exits, aborting uncommitted changes if an exception was thrown
+     txn.exit();
+ }
+
        +
        +
        Specified by:
        +
        enterTransaction in interface Repository
        +
        +
        • +
      + + + +
        +
      • +

        enterTransaction

        +
        public Transaction enterTransaction(IsolationLevel level)
        +
        Description copied from interface: Repository
        +
        Causes the current thread to enter a transaction scope with an explict + isolation level. The actual isolation level may be higher than + requested, if the repository does not support the exact level. If the + repository does not support a high enough level, it throws an + UnsupportedOperationException.
        +
        +
        Specified by:
        +
        enterTransaction in interface Repository
        +
        Parameters:
        level - minimum desired transaction isolation level -- if null, a + suitable default is selected
        See Also:
        Repository.enterTransaction()
        +
        • +
      + + + +
        +
      • +

        enterTopTransaction

        +
        public Transaction enterTopTransaction(IsolationLevel level)
        +
        Description copied from interface: Repository
        +
        Causes the current thread to enter a top-level transaction scope + with an explict isolation level. The actual isolation level may be + higher than requested, if the repository does not support the exact + level. If the repository does not support a high enough level, it throws + an UnsupportedOperationException. + +

        This method requests a top-level transaction, which means it never + has a parent transaction, but it still can be a parent transaction + itself. This kind of transaction is useful when a commit must absolutely + succeed, even if the current thread is already in a transaction + scope. If there was a parent transaction, then a commit might still be + rolled back by the parent. + +

        Requesting a top-level transaction can be deadlock prone if the + current thread is already in a transaction scope. The top-level + transaction may not be able to obtain locks held by the parent + transaction. An alternative to requesting top-level transactions is to + execute transactions in separate threads.

        +
        +
        Specified by:
        +
        enterTopTransaction in interface Repository
        +
        Parameters:
        level - minimum desired transaction isolation level -- if null, a + suitable default is selected
        See Also:
        Repository.enterTransaction()
        +
        • +
      + + + +
        +
      • +

        getTransactionIsolationLevel

        +
        public IsolationLevel getTransactionIsolationLevel()
        +
        Description copied from interface: Repository
        +
        Returns the isolation level of the current transaction, or null if there + is no transaction in the current thread.
        +
        +
        Specified by:
        +
        getTransactionIsolationLevel in interface Repository
        +
        +
        • +
      + + + +
        +
      • +

        getCapability

        +
        public <C extends Capability> C getCapability(java.lang.Class<C> capabilityType)
        +
        Default implementation checks if Repository implements Capability + interface, and if so, returns the Repository.
        +
        +
        Specified by:
        +
        getCapability in interface Repository
        +
        Parameters:
        capabilityType - type of capability requested
        +
        Returns:
        capability instance or null if not supported
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
        +
        Description copied from interface: Repository
        +
        Closes this repository reference, aborting any current + transactions. Operations on objects returned by this repository will + fail when accessing the storage layer.
        +
        +
        Specified by:
        +
        close in interface Repository
        +
        +
        • +
      + + + +
        +
      • +

        isClosed

        +
        public boolean isClosed()
        +
        • +
      + + + +
        +
      • +

        isAutoShutdownEnabled

        +
        public boolean isAutoShutdownEnabled()
        +
        Description copied from interface: ShutdownCapability
        +
        Returns true if repository has a shutdown hook registered to + automatically call shutdown when the virtual machine exits.
        +
        +
        Specified by:
        +
        isAutoShutdownEnabled in interface ShutdownCapability
        +
        +
        • +
      + + + +
        +
      • +

        setAutoShutdownEnabled

        +
        public void setAutoShutdownEnabled(boolean enabled)
        +
        Description copied from interface: ShutdownCapability
        +
        Request to enable or disable the automatic shutdown hook. Repository may + ignore this request if shutdown is in progress.
        +
        +
        Specified by:
        +
        setAutoShutdownEnabled in interface ShutdownCapability
        +
        +
        • +
      + + + +
        +
      • +

        shutdown

        +
        public void shutdown()
        +
        Description copied from interface: ShutdownCapability
        +
        Similar to calling close on a repository, except should only be called + when the virtual machine is in the process of shutting down. Calling + close may cause spurious exceptions to be thrown by other threads which + may be interacting with the repository. Shutdown tries to reduce these + exceptions from being thrown by effectively suspending any + threads which continue to interact with this repository. For this + reason, this method should only ever be called during a virtual machine + shutdown. + +

        Repositories may choose to implement this method by simply calling + close. There is no guarantee that shutdown will reduce exceptions, and + it might not suspend any threads. Also, repositories that require proper + shutdown should automatically register runtime hooks, and so this method + usually doesn't need to be called manually.

        +
        +
        Specified by:
        +
        shutdown in interface ShutdownCapability
        +
        +
        • +
      + + + + + + + +
        +
      • +

        transactionManager

        +
        protected abstract TransactionManager<Txn> transactionManager()
        +
        Returns the repository's TransactionManager.
        +
        • +
      + + + +
        +
      • +

        localTransactionScope

        +
        protected abstract TransactionScope<Txn> localTransactionScope()
        +
        Returns the thread-local TransactionScope, creating it if needed.
        +
        • +
      + + + +
        +
      • +

        lockoutShutdown

        +
        protected void lockoutShutdown()
        +
        Call to prevent shutdown hook from running. Be sure to call + unlockoutShutdown afterwards.
        +
        • +
      + + + +
        +
      • +

        unlockoutShutdown

        +
        protected void unlockoutShutdown()
        +
        Only call this to release lockoutShutdown.
        +
        • +
      + + + +
        +
      • +

        allStorage

        +
        protected java.util.Collection<Storage> allStorage()
        +
        Returns all available Storage instances.
        +
        • +
      + + + +
        +
      • +

        shutdownHook

        +
        protected void shutdownHook()
        +
        Install custom shutdown logic by overriding this method. By default it + does nothing.
        +
        • +
      + + + +
        +
      • +

        getLog

        +
        protected abstract org.apache.commons.logging.Log getLog()
        +
        Return the main Log object for this Repository. If none provided, then + no messages are logged by AbstractRepository.
        +
        • +
      + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/AbstractRepositoryBuilder.html b/apidocs/com/amazon/carbonado/spi/AbstractRepositoryBuilder.html new file mode 100644 index 0000000..80d38d6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/AbstractRepositoryBuilder.html @@ -0,0 +1,405 @@ + + + + + + +AbstractRepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.spi
+

Class AbstractRepositoryBuilder

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanaddTriggerFactory(TriggerFactory factory) +
      Optionally add a TriggerFactory which will be called upon to create an + initial trigger for each Storable type that the Repository supports.
      +
      voidassertReady() +
      Throw a configuration exception if the configuration is not filled out + sufficiently and correctly such that a repository could be instantiated + from it.
      +
      Repositorybuild() +
      Builds a repository instance.
      +
      voiderrorCheck(java.util.Collection<java.lang.String> messages) +
      This method is called by assertReady, and subclasses must override to + perform custom checks.
      +
      java.lang.Iterable<TriggerFactory>getTriggerFactories() +
      Returns all the TriggerFactories which were added.
      +
      booleanremoveTriggerFactory(TriggerFactory factory) +
      Remove a TriggerFactory which was added earlier.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AbstractRepositoryBuilder

        +
        protected AbstractRepositoryBuilder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        addTriggerFactory

        +
        public boolean addTriggerFactory(TriggerFactory factory)
        +
        Description copied from interface: RepositoryBuilder
        +
        Optionally add a TriggerFactory which will be called upon to create an + initial trigger for each Storable type that the Repository supports. The + primary purpose of this method is to allow decorator repositories the + opportunity to register custom persistence code for each Storable.
        +
        +
        Specified by:
        +
        addTriggerFactory in interface RepositoryBuilder
        +
        Returns:
        true if TriggerFactory was added, false if TriggerFactory was + not added because an equal TriggerFactory is already registered
        +
        • +
      + + + +
        +
      • +

        removeTriggerFactory

        +
        public boolean removeTriggerFactory(TriggerFactory factory)
        +
        Description copied from interface: RepositoryBuilder
        +
        Remove a TriggerFactory which was added earlier.
        +
        +
        Specified by:
        +
        removeTriggerFactory in interface RepositoryBuilder
        +
        Returns:
        true if TriggerFactory instance was removed, false if not added
        +
        • +
      + + + + + + + +
        +
      • +

        assertReady

        +
        public final void assertReady()
+                       throws ConfigurationException
        +
        Throw a configuration exception if the configuration is not filled out + sufficiently and correctly such that a repository could be instantiated + from it.
        +
        Throws:
        +
        ConfigurationException
        +
        • +
      + + + +
        +
      • +

        errorCheck

        +
        public void errorCheck(java.util.Collection<java.lang.String> messages)
+                throws ConfigurationException
        +
        This method is called by assertReady, and subclasses must override to + perform custom checks. Be sure to call super.errorCheck as well.
        +
        Parameters:
        messages - add any error messages to this list
        +
        Throws:
        +
        ConfigurationException - if error checking indirectly caused + another exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/BelatedRepositoryCreator.html b/apidocs/com/amazon/carbonado/spi/BelatedRepositoryCreator.html new file mode 100644 index 0000000..4849f11 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/BelatedRepositoryCreator.html @@ -0,0 +1,361 @@ + + + + + + +BelatedRepositoryCreator (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.spi
+

Class BelatedRepositoryCreator

+
+
+ +
+
    +
  • +
    +
    +
    public class BelatedRepositoryCreator
+extends BelatedCreator<Repository,SupportException>
    +
    Generic one-shot Repository builder which supports late object creation. If + the Repository building results in an exception or is taking too long, the + Repository produced instead is a bogus one. Many operations result in an + IllegalStateException. After retrying, if the real Repository is created, + then the bogus Repository turns into a wrapper to the real Repository.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    BelatedStorageCreator
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected RepositorycreateBogus() +
      Create instance of bogus object.
      +
      protected RepositorycreateReal() +
      Create instance of real object.
      +
      protected voidtimedOutNotification(long timedOutMillis) +
      Notification that createReal is taking too long.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BelatedRepositoryCreator

        +
        public BelatedRepositoryCreator(org.apache.commons.logging.Log log,
+                        RepositoryBuilder builder,
+                        int minRetryDelayMillis)
        +
        Parameters:
        log - error reporting log
        builder - builds real Repository
        minRetryDelayMillis - minimum milliseconds to wait before retrying + to create object after failure; if negative, never retry
        +
        • +
      + + + +
        +
      • +

        BelatedRepositoryCreator

        +
        public BelatedRepositoryCreator(org.apache.commons.logging.Log log,
+                        RepositoryBuilder builder,
+                        java.util.concurrent.atomic.AtomicReference<Repository> rootRef,
+                        int minRetryDelayMillis)
        +
        Parameters:
        log - error reporting log
        builder - builds real Repository
        rootRef - reference to root repository
        minRetryDelayMillis - minimum milliseconds to wait before retrying + to create object after failure; if negative, never retry
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/BelatedStorageCreator.html b/apidocs/com/amazon/carbonado/spi/BelatedStorageCreator.html new file mode 100644 index 0000000..8981984 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/BelatedStorageCreator.html @@ -0,0 +1,343 @@ + + + + + + +BelatedStorageCreator (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.spi
+

Class BelatedStorageCreator<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public class BelatedStorageCreator<S extends Storable>
+extends BelatedCreator<Storage<S>,SupportException>
    +
    Generic one-shot Storage creator which supports late object creation. If + getting the Storage results in an exception or is taking too long, the + Storage produced instead is a bogus one. Many operations result in an + IllegalStateException. After retrying, if the real Storage is accessed, then + the bogus Storage turns into a wrapper to the real Storage.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    BelatedRepositoryCreator
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      BelatedStorageCreator(org.apache.commons.logging.Log log, + Repository repo, + java.lang.Class<S> storableType, + int minRetryDelayMillis) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected Storage<S>createBogus() +
      Create instance of bogus object.
      +
      protected Storage<S>createReal() +
      Create instance of real object.
      +
      protected voidtimedOutNotification(long timedOutMillis) +
      Notification that createReal is taking too long.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BelatedStorageCreator

        +
        public BelatedStorageCreator(org.apache.commons.logging.Log log,
+                     Repository repo,
+                     java.lang.Class<S> storableType,
+                     int minRetryDelayMillis)
        +
        Parameters:
        log - error reporting log
        repo - Repository to get Storage from
        storableType - type of Storable to get Storage for
        minRetryDelayMillis - minimum milliseconds to wait before retrying + to create object after failure; if negative, never retry
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/ExceptionTransformer.html b/apidocs/com/amazon/carbonado/spi/ExceptionTransformer.html new file mode 100644 index 0000000..c1966eb --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/ExceptionTransformer.html @@ -0,0 +1,387 @@ + + + + + + +ExceptionTransformer (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.spi
+

Class ExceptionTransformer

+
+
+ +
+
    +
  • +
    +
    +
    public class ExceptionTransformer
+extends java.lang.Object
    +
    Supports transforming arbitrary exceptions into appropriate repository + exceptions. Repositories will likely extend this class, providing custom + transformation rules.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ExceptionTransformer

        +
        public ExceptionTransformer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getInstance

        +
        public static ExceptionTransformer getInstance()
        +
        Returns a generic instance.
        +
        • +
      + + + +
        +
      • +

        toFetchException

        +
        public FetchException toFetchException(java.lang.Throwable e)
        +
        Transforms the given throwable into an appropriate fetch exception. If + it already is a fetch exception, it is simply casted.
        +
        Parameters:
        e - required exception to transform
        +
        Returns:
        FetchException, never null
        +
        • +
      + + + +
        +
      • +

        toPersistException

        +
        public PersistException toPersistException(java.lang.Throwable e)
        +
        Transforms the given throwable into an appropriate persist exception. If + it already is a persist exception, it is simply casted.
        +
        Parameters:
        e - required exception to transform
        +
        Returns:
        PersistException, never null
        +
        • +
      + + + +
        +
      • +

        toRepositoryException

        +
        public RepositoryException toRepositoryException(java.lang.Throwable e)
        +
        Transforms the given throwable into an appropriate repository + exception. If it already is a repository exception, it is simply casted.
        +
        Parameters:
        e - required exception to transform
        +
        Returns:
        RepositoryException, never null
        +
        • +
      + + + +
        +
      • +

        transformIntoFetchException

        +
        protected FetchException transformIntoFetchException(java.lang.Throwable e)
        +
        Override to support custom transformations, returning null if none is + applicable. Be sure to call super first. If it returns non-null, return + that result.
        +
        Parameters:
        e - required exception to transform
        +
        Returns:
        FetchException, or null if no applicable transform
        +
        • +
      + + + +
        +
      • +

        transformIntoPersistException

        +
        protected PersistException transformIntoPersistException(java.lang.Throwable e)
        +
        Override to support custom transformations, returning null if none is + applicable. Be sure to call super first. If it returns non-null, return + that result.
        +
        Parameters:
        e - required exception to transform
        +
        Returns:
        PersistException, or null if no applicable transform
        +
        • +
      + + + +
        +
      • +

        transformIntoRepositoryException

        +
        protected RepositoryException transformIntoRepositoryException(java.lang.Throwable e)
        +
        Override to support custom transformations, returning null if none is + applicable. Be sure to call super first. If it returns non-null, return + that result.
        +
        Parameters:
        e - required exception to transform
        +
        Returns:
        RepositoryException, or null if no applicable transform
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/IndexInfoImpl.html b/apidocs/com/amazon/carbonado/spi/IndexInfoImpl.html new file mode 100644 index 0000000..3e9f79a --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/IndexInfoImpl.html @@ -0,0 +1,393 @@ + + + + + + +IndexInfoImpl (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.spi
+

Class IndexInfoImpl

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IndexInfo
    +
    +
    +
    +
    public class IndexInfoImpl
+extends java.lang.Object
+implements IndexInfo
    +
    Basic implementation of an IndexInfo.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      IndexInfoImpl(java.lang.String name, + boolean unique, + boolean clustered, + java.lang.String[] propertyNames, + Direction[] propertyDirections) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetName() +
      Returns the name of this index, or null if not applicable.
      +
      Direction[]getPropertyDirections() +
      Returns the directions of all the properties in this index.
      +
      java.lang.String[]getPropertyNames() +
      Returns the properties in this index.
      +
      booleanisClustered() +
      Returns true if index is clustered, which means it defines the physical + ordering of storables.
      +
      booleanisUnique() +
      Returns true if index entries are unique.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        IndexInfoImpl

        +
        public IndexInfoImpl(java.lang.String name,
+             boolean unique,
+             boolean clustered,
+             java.lang.String[] propertyNames,
+             Direction[] propertyDirections)
        +
        Parameters:
        name - optional name for index
        unique - true if index requires unique values
        propertyNames - required list of property names, must have at least + one name
        propertyDirections - optional property directions, may be null or + same length as property names array
        +
        Throws:
        +
        java.lang.IllegalArgumentException
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Description copied from interface: IndexInfo
        +
        Returns the name of this index, or null if not applicable.
        +
        +
        Specified by:
        +
        getName in interface IndexInfo
        +
        +
        • +
      + + + +
        +
      • +

        isUnique

        +
        public boolean isUnique()
        +
        Description copied from interface: IndexInfo
        +
        Returns true if index entries are unique.
        +
        +
        Specified by:
        +
        isUnique in interface IndexInfo
        +
        +
        • +
      + + + +
        +
      • +

        isClustered

        +
        public boolean isClustered()
        +
        Description copied from interface: IndexInfo
        +
        Returns true if index is clustered, which means it defines the physical + ordering of storables.
        +
        +
        Specified by:
        +
        isClustered in interface IndexInfo
        +
        +
        • +
      + + + +
        +
      • +

        getPropertyNames

        +
        public java.lang.String[] getPropertyNames()
        +
        Description copied from interface: IndexInfo
        +
        Returns the properties in this index. The array might be empty, but it + is never null. The array is a copy, and so it may be safely modified.
        +
        +
        Specified by:
        +
        getPropertyNames in interface IndexInfo
        +
        +
        • +
      + + + +
        +
      • +

        getPropertyDirections

        +
        public Direction[] getPropertyDirections()
        +
        Description copied from interface: IndexInfo
        +
        Returns the directions of all the properties in this index. The length + of the array matches the length returned by IndexInfo.getPropertyNames(). The array is a copy, and so it may be safely + modified.
        +
        +
        Specified by:
        +
        getPropertyDirections in interface IndexInfo
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/LobEngine.html b/apidocs/com/amazon/carbonado/spi/LobEngine.html new file mode 100644 index 0000000..c9dd1af --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/LobEngine.html @@ -0,0 +1,560 @@ + + + + + + +LobEngine (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.spi
+

Class LobEngine

+
+
+ +
+
    +
  • +
    +
    +
    public class LobEngine
+extends java.lang.Object
    +
    Complete Lob support for repositories, although repository is responsible + for binding Lob properties to this engine. Lobs are referenced by locators, + which are non-zero long integers. A zero locator is equivalent to null.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    getSupportTrigger(Class, int)
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      BlobcreateNewBlob(int blockSize) +
      Returns a new Blob whose length is zero.
      +
      ClobcreateNewClob(int blockSize) +
      Returns a new Clob whose length is zero.
      +
      voiddeleteLob(Lob lob) +
      Deletes Lob data, freeing up all space consumed by it.
      +
      voiddeleteLob(long locator) +
      Deletes Lob data, freeing up all space consumed by it.
      +
      BlobgetBlobValue(long locator) +
      Loads a Blob value, without checking if it exists or not.
      +
      ClobgetClobValue(long locator) +
      Loads a Clob value, without checking if it exists or not.
      +
      longgetLocator(Lob lob) +
      Returns the locator for the given Lob, or zero if null.
      +
      <S extends Storable> 
      Trigger<S>      		getSupportTrigger(java.lang.Class<S> type, + int blockSize) +
      Returns a Trigger for binding to this LobEngine.
      +
      static <S extends Storable> 
      boolean      		hasLobs(java.lang.Class<S> type) 
      voidsetBlobValue(long locator, + Blob data) +
      Stores a value into a Blob, replacing anything that was there + before.
      +
      voidsetBlobValue(long locator, + java.io.InputStream data) +
      Stores a value into a Blob, replacing anything that was there + before.
      +
      voidsetClobValue(long locator, + Clob data) +
      Stores a value into a Clob, replacing anything that was there + before.
      +
      voidsetClobValue(long locator, + java.io.Reader data) +
      Stores a value into a Clob, replacing anything that was there + before.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        hasLobs

        +
        public static <S extends Storable> boolean hasLobs(java.lang.Class<S> type)
        +
        • +
      + + + +
        +
      • +

        createNewBlob

        +
        public Blob createNewBlob(int blockSize)
+                   throws PersistException
        +
        Returns a new Blob whose length is zero.
        +
        Parameters:
        blockSize - block size (in bytes) to use
        +
        Returns:
        new empty Blob
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        createNewClob

        +
        public Clob createNewClob(int blockSize)
+                   throws PersistException
        +
        Returns a new Clob whose length is zero.
        +
        Parameters:
        blockSize - block size (in bytes) to use
        +
        Returns:
        new empty Clob
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        getLocator

        +
        public long getLocator(Lob lob)
        +
        Returns the locator for the given Lob, or zero if null.
        +
        Throws:
        +
        java.lang.ClassCastException - if Lob is unrecognized
        +
        • +
      + + + +
        +
      • +

        deleteLob

        +
        public void deleteLob(long locator)
+               throws PersistException
        +
        Deletes Lob data, freeing up all space consumed by it.
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + + + +
        +
      • +

        getBlobValue

        +
        public Blob getBlobValue(long locator)
        +
        Loads a Blob value, without checking if it exists or not.
        +
        Parameters:
        locator - lob locator as returned by getLocator
        +
        Returns:
        Blob value or null
        +
        • +
      + + + +
        +
      • +

        getClobValue

        +
        public Clob getClobValue(long locator)
        +
        Loads a Clob value, without checking if it exists or not.
        +
        Parameters:
        locator - lob locator as returned by getLocator
        +
        Returns:
        Clob value or null
        +
        • +
      + + + +
        +
      • +

        setBlobValue

        +
        public void setBlobValue(long locator,
+                Blob data)
+                  throws PersistException,
+                         java.io.IOException
        +
        Stores a value into a Blob, replacing anything that was there + before. Passing null deletes the Blob, which is a convenience for + auto-generated code that may call this method.
        +
        Parameters:
        locator - lob locator as created by createNewBlob
        data - source of data for Blob, which may be null to delete
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if locator is zero
        +
        PersistException
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        setBlobValue

        +
        public void setBlobValue(long locator,
+                java.io.InputStream data)
+                  throws PersistException,
+                         java.io.IOException
        +
        Stores a value into a Blob, replacing anything that was there + before. Passing null deletes the Blob, which is a convenience for + auto-generated code that may call this method.
        +
        Parameters:
        locator - lob locator as created by createNewBlob
        data - source of data for Blob, which may be null to delete
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if locator is zero
        +
        PersistException
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        setClobValue

        +
        public void setClobValue(long locator,
+                Clob data)
+                  throws PersistException,
+                         java.io.IOException
        +
        Stores a value into a Clob, replacing anything that was there + before. Passing null deletes the Clob, which is a convenience for + auto-generated code that may call this method.
        +
        Parameters:
        locator - lob locator as created by createNewClob
        data - source of data for Clob, which may be null to delete
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if locator is zero
        +
        PersistException
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        setClobValue

        +
        public void setClobValue(long locator,
+                java.io.Reader data)
+                  throws PersistException,
+                         java.io.IOException
        +
        Stores a value into a Clob, replacing anything that was there + before. Passing null deletes the Clob, which is a convenience for + auto-generated code that may call this method.
        +
        Parameters:
        locator - lob locator as created by createNewClob
        data - source of data for Clob, which may be null to delete
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if locator is zero
        +
        PersistException
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        getSupportTrigger

        +
        public <S extends Storable> Trigger<S> getSupportTrigger(java.lang.Class<S> type,
+                                                int blockSize)
        +
        Returns a Trigger for binding to this LobEngine. Storage implementations + which use LobEngine must install this Trigger. Trigger instances are + cached, so subsequent calls for the same trigger return the same + instance.
        +
        Parameters:
        type - type of Storable to create trigger for
        blockSize - block size to use
        +
        Returns:
        support trigger or null if storable type has no lob properties
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/RAFInputStream.html b/apidocs/com/amazon/carbonado/spi/RAFInputStream.html new file mode 100644 index 0000000..915be7b --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/RAFInputStream.html @@ -0,0 +1,370 @@ + + + + + + +RAFInputStream (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.spi
+

Class RAFInputStream

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Closeable, java.lang.AutoCloseable
    +
    +
    +
    +
    public class RAFInputStream
+extends java.io.InputStream
    +
    InputStream that wraps a RandomAccessFile. A stream can be obtained for a + RandomAccessFile by getting the file descriptor and creating a + FileInputStream on it. Problem is that FileInputStream has a finalizer that + closes the RandomAccessFile.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      RAFInputStream(java.io.RandomAccessFile raf) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() 
      intread() 
      intread(byte[] b) 
      intread(byte[] b, + int offset, + int length) 
      longskip(long n) 
      +
        +
      • + + +

        Methods inherited from class java.io.InputStream

        +available, mark, markSupported, reset
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RAFInputStream

        +
        public RAFInputStream(java.io.RandomAccessFile raf)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        read

        +
        public int read()
+         throws java.io.IOException
        +
        +
        Specified by:
        +
        read in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        read

        +
        public int read(byte[] b)
+         throws java.io.IOException
        +
        +
        Overrides:
        +
        read in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        read

        +
        public int read(byte[] b,
+       int offset,
+       int length)
+         throws java.io.IOException
        +
        +
        Overrides:
        +
        read in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        skip

        +
        public long skip(long n)
+          throws java.io.IOException
        +
        +
        Overrides:
        +
        skip in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws java.io.IOException
        +
        +
        Specified by:
        +
        close in interface java.io.Closeable
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Overrides:
        +
        close in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/RAFOutputStream.html b/apidocs/com/amazon/carbonado/spi/RAFOutputStream.html new file mode 100644 index 0000000..a23245e --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/RAFOutputStream.html @@ -0,0 +1,351 @@ + + + + + + +RAFOutputStream (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.spi
+

Class RAFOutputStream

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable
    +
    +
    +
    +
    public class RAFOutputStream
+extends java.io.OutputStream
    +
    OutputStream that wraps a RandomAccessFile. A stream can be obtained for a + RandomAccessFile by getting the file descriptor and creating a + FileOutputStream on it. Problem is that FileOutputStream has a finalizer + that closes the RandomAccessFile.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      RAFOutputStream(java.io.RandomAccessFile raf) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() 
      voidwrite(byte[] b) 
      voidwrite(byte[] b, + int offset, + int length) 
      voidwrite(int b) 
      +
        +
      • + + +

        Methods inherited from class java.io.OutputStream

        +flush
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RAFOutputStream

        +
        public RAFOutputStream(java.io.RandomAccessFile raf)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        write

        +
        public void write(int b)
+           throws java.io.IOException
        +
        +
        Specified by:
        +
        write in class java.io.OutputStream
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        write

        +
        public void write(byte[] b)
+           throws java.io.IOException
        +
        +
        Overrides:
        +
        write in class java.io.OutputStream
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        write

        +
        public void write(byte[] b,
+         int offset,
+         int length)
+           throws java.io.IOException
        +
        +
        Overrides:
        +
        write in class java.io.OutputStream
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws java.io.IOException
        +
        +
        Specified by:
        +
        close in interface java.io.Closeable
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Overrides:
        +
        close in class java.io.OutputStream
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/RepairExecutor.html b/apidocs/com/amazon/carbonado/spi/RepairExecutor.html new file mode 100644 index 0000000..ed413da --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/RepairExecutor.html @@ -0,0 +1,271 @@ + + + + + + +RepairExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.spi
+

Class RepairExecutor

+
+
+ +
+
    +
  • +
    +
    +
    public class RepairExecutor
+extends java.lang.Object
    +
    A convenience class for repositories to run dynamic repairs in separate + threads. When a repository detects a consistency error during a user + operation, it should not perform the repair in the same thread. + +

    If the repair was initiated by an exception, but the original exception + is re-thrown, a transaction exit will rollback the repair! Executing the + repair in a separate thread allows it to wait until the transaction has + exited. + +

    Other kinds of inconsistencies might be detected during cursor + iteration. The repair will need to acquire write locks, but the open cursor + might not allow that, resulting in deadlock. Executing the repair in a + separate thread allows it to wait until the cursor has released locks. + +

    This class keeps thread-local references to single-threaded executors. In + other words, each user thread has at most one associated repair thread. Each + repair thread has a fixed size queue, and they exit when they are idle. If + the queue is full, newly added repair tasks are silently discarded. + +

    The following system properties are supported: + +

      +
    • com.amazon.carbonado.spi.RepairExecutor.keepAliveSeconds (default is 10) +
    • com.amazon.carbonado.spi.RepairExecutor.queueSize (default is 10000) +
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidexecute(java.lang.Runnable repair) 
      static booleanwaitForRepairsToFinish(long timeoutMillis) +
      Waits for repairs that were executed from the current thread to finish.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        execute

        +
        public static void execute(java.lang.Runnable repair)
        +
        • +
      + + + +
        +
      • +

        waitForRepairsToFinish

        +
        public static boolean waitForRepairsToFinish(long timeoutMillis)
+                                      throws java.lang.InterruptedException
        +
        Waits for repairs that were executed from the current thread to finish.
        +
        Returns:
        true if all repairs are finished
        +
        Throws:
        +
        java.lang.InterruptedException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/StoragePool.html b/apidocs/com/amazon/carbonado/spi/StoragePool.html new file mode 100644 index 0000000..67a4167 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/StoragePool.html @@ -0,0 +1,333 @@ + + + + + + +StoragePool (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.spi
+

Class StoragePool

+
+
+ +
+
    +
  • +
    +
    +
    public abstract class StoragePool
+extends AbstractPool<java.lang.Class,Storage,RepositoryException>
    +
    A concurrent pool of strongly referenced Storage instances mapped by + Storable type. Storage instances are lazily created and pooled.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      StoragePool() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected Storagecreate(java.lang.Class type) +
      Return a new value instance.
      +
      protected abstract <S extends Storable> 
      Storage<S>      		createStorage(java.lang.Class<S> type) 
      <S extends Storable> 
      Storage<S>      		getStorage(java.lang.Class<S> type) +
      Returns a Storage instance for the given Storable type, which is lazily + created and pooled.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/StoredLob.Block.html b/apidocs/com/amazon/carbonado/spi/StoredLob.Block.html new file mode 100644 index 0000000..3a20d54 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/StoredLob.Block.html @@ -0,0 +1,373 @@ + + + + + + +StoredLob.Block (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.spi
+

Class StoredLob.Block

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StoredLob.Block

        +
        public StoredLob.Block()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getLocator

        +
        public abstract long getLocator()
        +
        • +
      + + + +
        +
      • +

        setLocator

        +
        public abstract void setLocator(long locator)
        +
        • +
      + + + +
        +
      • +

        getBlockNumber

        +
        public abstract int getBlockNumber()
        +
        First block number is logically zero, but subtract 0x80000000 to get + actual number. This effectively makes the block number unsigned.
        +
        • +
      + + + +
        +
      • +

        setBlockNumber

        +
        public abstract void setBlockNumber(int number)
        +
        • +
      + + + +
        +
      • +

        getData

        +
        public abstract byte[] getData()
        +
        • +
      + + + +
        +
      • +

        setData

        +
        public abstract void setData(byte[] data)
        +
        • +
      + + + +
        +
      • +

        getVersion

        +
        @Version
+public abstract int getVersion()
        +
        • +
      + + + +
        +
      • +

        setVersion

        +
        public abstract void setVersion(int version)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/StoredLob.html b/apidocs/com/amazon/carbonado/spi/StoredLob.html new file mode 100644 index 0000000..a42dc2c --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/StoredLob.html @@ -0,0 +1,425 @@ + + + + + + +StoredLob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.spi
+

Class StoredLob

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StoredLob

        +
        public StoredLob()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getLocator

        +
        public abstract long getLocator()
        +
        • +
      + + + +
        +
      • +

        setLocator

        +
        public abstract void setLocator(long locator)
        +
        • +
      + + + +
        +
      • +

        getBlockSize

        +
        public abstract int getBlockSize()
        +
        • +
      + + + + + + + +
        +
      • +

        getLength

        +
        public abstract long getLength()
        +
        • +
      + + + + + + + +
        +
      • +

        getVersion

        +
        @Version
+public abstract int getVersion()
        +
        • +
      + + + +
        +
      • +

        setVersion

        +
        public abstract void setVersion(int version)
        +
        • +
      + + + +
        +
      • +

        getBlockCount

        +
        public long getBlockCount()
        +
        Returns number of blocks required to store Lob.
        +
        • +
      + + + +
        +
      • +

        getLastBlockLength

        +
        public int getLastBlockLength()
        +
        Returns expected length of last block. If zero, last block should be + full, unless the total length of Lob is zero.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/StoredSequence.html b/apidocs/com/amazon/carbonado/spi/StoredSequence.html new file mode 100644 index 0000000..3100bf1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/StoredSequence.html @@ -0,0 +1,320 @@ + + + + + + +StoredSequence (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.spi
+

Interface StoredSequence

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        java.lang.String getName()
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        setName

        +
        void setName(java.lang.String name)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        getInitialValue

        +
        long getInitialValue()
        +
        Deprecated. 
        +
        Returns the initial value for the sequence.
        +
        • +
      + + + +
        +
      • +

        setInitialValue

        +
        void setInitialValue(long value)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        getNextValue

        +
        long getNextValue()
        +
        Deprecated. 
        +
        Returns the pre-adjusted next value of the sequence. This value is + initially Long.MIN_VALUE, and it increments up to Long.MAX_VALUE. The actual + next value for the sequence is: (getNextValue() + Long.MIN_VALUE + getInitialValue()).
        +
        • +
      + + + +
        +
      • +

        setNextValue

        +
        void setNextValue(long value)
        +
        Deprecated. 
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/TriggerManager.html b/apidocs/com/amazon/carbonado/spi/TriggerManager.html new file mode 100644 index 0000000..747f969 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/TriggerManager.html @@ -0,0 +1,1324 @@ + + + + + + +TriggerManager (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.spi
+

Class TriggerManager<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public class TriggerManager<S extends Storable>
+extends Trigger<S>
    +
    Used by Storage implementations to manage triggers and consolidate them into + single logical triggers. This class is thread-safe and ensures that changes + to the trigger set do not affect transactions in progress.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + + + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanaddTrigger(Trigger<? super S> trigger) 
      voidaddTriggers(java.lang.Class<S> type, + java.lang.Iterable<TriggerFactory> triggerFactories) 
      voidafterDelete(S storable, + java.lang.Object state) +
      Called right after a storable has been successfully deleted.
      +
      voidafterInsert(S storable, + java.lang.Object state) +
      Called right after a storable has been successfully inserted.
      +
      voidafterLoad(S storable) +
      Called right after a storable has been successfully loaded or + fetched.
      +
      voidafterTryDelete(S storable, + java.lang.Object state) +
      Called right after a storable has been successfully deleted via + tryDelete.
      +
      voidafterTryInsert(S storable, + java.lang.Object state) +
      Called right after a storable has been successfully inserted via + tryInsert.
      +
      voidafterTryUpdate(S storable, + java.lang.Object state) +
      Called right after a storable has been successfully updated via + tryUpdate.
      +
      voidafterUpdate(S storable, + java.lang.Object state) +
      Called right after a storable has been successfully updated.
      +
      java.lang.ObjectbeforeDelete(S storable) +
      Called before a storable is to be deleted.
      +
      java.lang.ObjectbeforeDelete(Transaction txn, + S storable) +
      Called before a storable is to be deleted.
      +
      java.lang.ObjectbeforeInsert(S storable) +
      Called before a storable is to be inserted.
      +
      java.lang.ObjectbeforeInsert(Transaction txn, + S storable) +
      Called before a storable is to be inserted.
      +
      java.lang.ObjectbeforeTryDelete(S storable) +
      Called before a storable is to be deleted via tryDelete.
      +
      java.lang.ObjectbeforeTryDelete(Transaction txn, + S storable) +
      Called before a storable is to be deleted via tryDelete.
      +
      java.lang.ObjectbeforeTryInsert(S storable) +
      Called before a storable is to be inserted via tryInsert.
      +
      java.lang.ObjectbeforeTryInsert(Transaction txn, + S storable) +
      Called before a storable is to be inserted via tryInsert.
      +
      java.lang.ObjectbeforeTryUpdate(S storable) +
      Called before a storable is to be updated via tryUpdate.
      +
      java.lang.ObjectbeforeTryUpdate(Transaction txn, + S storable) +
      Called before a storable is to be updated via tryUpdate.
      +
      java.lang.ObjectbeforeUpdate(S storable) +
      Called before a storable is to be updated.
      +
      java.lang.ObjectbeforeUpdate(Transaction txn, + S storable) +
      Called before a storable is to be updated.
      +
      voidfailedDelete(S storable, + java.lang.Object state) +
      Called when an delete operation failed because the record was missing or + an exception was thrown.
      +
      voidfailedInsert(S storable, + java.lang.Object state) +
      Called when an insert operation failed due to a unique constraint + violation or an exception was thrown.
      +
      voidfailedUpdate(S storable, + java.lang.Object state) +
      Called when an update operation failed because the record was missing or + an exception was thrown.
      +
      Trigger<? super S>getDeleteTrigger() +
      Returns a consolidated trigger to call for delete operations, or null if + none.
      +
      Trigger<? super S>getInsertTrigger() +
      Returns a consolidated trigger to call for insert operations, or null if + none.
      +
      Trigger<? super S>getLoadTrigger() +
      Returns a consolidated trigger to call for load operations, or null if + none.
      +
      Trigger<? super S>getUpdateTrigger() +
      Returns a consolidated trigger to call for update operations, or null if + none.
      +
      voidlocallyDisableDelete() +
      Disables execution of all managed delete triggers for the current + thread.
      +
      voidlocallyDisableInsert() +
      Disables execution of all managed insert triggers for the current + thread.
      +
      voidlocallyDisableLoad() +
      Disables execution of all managed load triggers for the current + thread.
      +
      voidlocallyDisableUpdate() +
      Disables execution of all managed update triggers for the current + thread.
      +
      voidlocallyEnableDelete() +
      Enables execution of all managed delete triggers for the current thread, + if they had been disabled before.
      +
      voidlocallyEnableInsert() +
      Enables execution of all managed insert triggers for the current thread, + if they had been disabled before.
      +
      voidlocallyEnableLoad() +
      Enables execution of all managed load triggers for the current thread, + if they had been disabled before.
      +
      voidlocallyEnableUpdate() +
      Enables execution of all managed update triggers for the current thread, + if they had been disabled before.
      +
      booleanremoveTrigger(Trigger<? super S> trigger) 
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TriggerManager

        +
        public TriggerManager()
        +
        • +
      + + + +
        +
      • +

        TriggerManager

        +
        public TriggerManager(java.lang.Class<S> type,
+              java.lang.Iterable<TriggerFactory> triggerFactories)
+               throws RepositoryException
        +
        Parameters:
        triggerFactories - TriggerFactories which will be called upon to + optionally return a trigger to initially register
        +
        Throws:
        +
        RepositoryException
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getInsertTrigger

        +
        public Trigger<? super S> getInsertTrigger()
        +
        Returns a consolidated trigger to call for insert operations, or null if + none. If not null, the consolidated trigger is not a snapshot -- it will + change as the set of triggers in this manager changes.
        +
        • +
      + + + +
        +
      • +

        getUpdateTrigger

        +
        public Trigger<? super S> getUpdateTrigger()
        +
        Returns a consolidated trigger to call for update operations, or null if + none. If not null, the consolidated trigger is not a snapshot -- it will + change as the set of triggers in this manager changes.
        +
        • +
      + + + +
        +
      • +

        getDeleteTrigger

        +
        public Trigger<? super S> getDeleteTrigger()
        +
        Returns a consolidated trigger to call for delete operations, or null if + none. If not null, the consolidated trigger is not a snapshot -- it will + change as the set of triggers in this manager changes.
        +
        • +
      + + + +
        +
      • +

        getLoadTrigger

        +
        public Trigger<? super S> getLoadTrigger()
        +
        Returns a consolidated trigger to call for load operations, or null if + none. If not null, the consolidated trigger is not a snapshot -- it will + change as the set of triggers in this manager changes.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        addTrigger

        +
        public boolean addTrigger(Trigger<? super S> trigger)
        +
        • +
      + + + +
        +
      • +

        removeTrigger

        +
        public boolean removeTrigger(Trigger<? super S> trigger)
        +
        • +
      + + + + + + + +
        +
      • +

        locallyDisableInsert

        +
        public void locallyDisableInsert()
        +
        Disables execution of all managed insert triggers for the current + thread. Call locallyEnableInsert to enable again. This call can be made + multiple times, but be sure to call locallyEnableInsert the same number of + times to fully enable.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        locallyEnableInsert

        +
        public void locallyEnableInsert()
        +
        Enables execution of all managed insert triggers for the current thread, + if they had been disabled before.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        locallyDisableUpdate

        +
        public void locallyDisableUpdate()
        +
        Disables execution of all managed update triggers for the current + thread. Call locallyEnableUpdate to enable again. This call can be made + multiple times, but be sure to call locallyEnableUpdate the same number of + times to fully enable.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        locallyEnableUpdate

        +
        public void locallyEnableUpdate()
        +
        Enables execution of all managed update triggers for the current thread, + if they had been disabled before.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        locallyDisableDelete

        +
        public void locallyDisableDelete()
        +
        Disables execution of all managed delete triggers for the current + thread. Call locallyEnableDelete to enable again. This call can be made + multiple times, but be sure to call locallyEnableDelete the same number of + times to fully enable.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        locallyEnableDelete

        +
        public void locallyEnableDelete()
        +
        Enables execution of all managed delete triggers for the current thread, + if they had been disabled before.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        locallyDisableLoad

        +
        public void locallyDisableLoad()
        +
        Disables execution of all managed load triggers for the current + thread. Call locallyEnableLoad to enable again. This call can be made + multiple times, but be sure to call locallyEnableLoad the same number of + times to fully enable.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        locallyEnableLoad

        +
        public void locallyEnableLoad()
        +
        Enables execution of all managed load triggers for the current thread, + if they had been disabled before.
        +
        Since:
        +
        1.2
        +
        • +
      + + + + + +
        +
      • +

        beforeInsert

        +
        public java.lang.Object beforeInsert(S storable)
+                              throws PersistException
        +
        Description copied from class: Trigger
        +
        Called before a storable is to be inserted. The default implementation + does nothing. + +

        Any exception thrown by this method will cause the insert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the insert method.

        +
        +
        Overrides:
        +
        beforeInsert in class Trigger<S extends Storable>
        +
        Parameters:
        storable - storable before being inserted
        +
        Returns:
        arbitrary state object, passed to afterInsert or failedInsert method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        beforeInsert

        +
        public java.lang.Object beforeInsert(Transaction txn,
+                            S storable)
+                              throws PersistException
        +
        Description copied from class: Trigger
        +
        Called before a storable is to be inserted. The default implementation + simply calls Trigger.beforeInsert(Object). Only override if access to + the transaction is required. + +

        Any exception thrown by this method will cause the insert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the insert method.

        +
        +
        Overrides:
        +
        beforeInsert in class Trigger<S extends Storable>
        +
        Parameters:
        txn - nested transaction which trigger runs in
        storable - storable before being inserted
        +
        Returns:
        arbitrary state object, passed to afterInsert or failedInsert method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        beforeTryInsert

        +
        public java.lang.Object beforeTryInsert(S storable)
+                                 throws PersistException
        +
        Description copied from class: Trigger
        +
        Called before a storable is to be inserted via tryInsert. The default + implementation simply calls Trigger.beforeInsert(Object). Only override + if trigger needs to distinguish between different insert variants. + +

        Any exception thrown by this method will cause the tryInsert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryInsert method.

        +
        +
        Overrides:
        +
        beforeTryInsert in class Trigger<S extends Storable>
        +
        Parameters:
        storable - storable before being inserted
        +
        Returns:
        arbitrary state object, passed to afterTryInsert or failedInsert method
        +
        Throws:
        +
        PersistException
        See Also:
        Trigger.abortTry()
        +
        • +
      + + + + + +
        +
      • +

        beforeTryInsert

        +
        public java.lang.Object beforeTryInsert(Transaction txn,
+                               S storable)
+                                 throws PersistException
        +
        Description copied from class: Trigger
        +
        Called before a storable is to be inserted via tryInsert. The default + implementation simply calls Trigger.beforeTryInsert(Object). Only + override if trigger needs access to the transaction and to distinguish + between different insert variants. + +

        Any exception thrown by this method will cause the tryInsert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryInsert method.

        +
        +
        Overrides:
        +
        beforeTryInsert in class Trigger<S extends Storable>
        +
        Parameters:
        txn - nested transaction which trigger runs in
        storable - storable before being inserted
        +
        Returns:
        arbitrary state object, passed to afterTryInsert or failedInsert method
        +
        Throws:
        +
        PersistException
        See Also:
        Trigger.abortTry()
        +
        • +
      + + + + + +
        +
      • +

        afterInsert

        +
        public void afterInsert(S storable,
+               java.lang.Object state)
+                 throws PersistException
        +
        Description copied from class: Trigger
        +
        Called right after a storable has been successfully inserted. The + default implementation does nothing. + +

        Any exception thrown by this method will cause the insert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the insert method.

        +
        +
        Overrides:
        +
        afterInsert in class Trigger<S extends Storable>
        +
        Parameters:
        storable - storable after being inserted
        state - object returned by beforeInsert method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        afterTryInsert

        +
        public void afterTryInsert(S storable,
+                  java.lang.Object state)
+                    throws PersistException
        +
        Description copied from class: Trigger
        +
        Called right after a storable has been successfully inserted via + tryInsert. The default implementation simply calls Trigger.afterInsert(S, java.lang.Object). + Only override if trigger needs to distinguish between different insert + variants. + +

        Any exception thrown by this method will cause the tryInsert + operation to rollback and all remaining triggers to not run. The + exception is ultimately passed to the caller of the tryInsert method.

        +
        +
        Overrides:
        +
        afterTryInsert in class Trigger<S extends Storable>
        +
        Parameters:
        storable - storable after being inserted
        state - object returned by beforeTryInsert method
        +
        Throws:
        +
        PersistException
        See Also:
        Trigger.abortTry()
        +
        • +
      + + + + + +
        +
      • +

        failedInsert

        +
        public void failedInsert(S storable,
+                java.lang.Object state)
        +
        Description copied from class: Trigger
        +
        Called when an insert operation failed due to a unique constraint + violation or an exception was thrown. The main purpose of this method is + to allow any necessary clean-up to occur on the optional state object. + +

        Any exception thrown by this method will be passed to the current + thread's uncaught exception handler.

        +
        +
        Overrides:
        +
        failedInsert in class Trigger<S extends Storable>
        +
        Parameters:
        storable - storable which failed to be inserted
        state - object returned by beforeInsert method, but it may be null
        +
        • +
      + + + + + +
        +
      • +

        beforeUpdate

        +
        public java.lang.Object beforeUpdate(S storable)
+                              throws PersistException
        +
        Description copied from class: Trigger
        +
        Called before a storable is to be updated. The default implementation + does nothing. + +

        Any exception thrown by this method will cause the update operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the update method.

        +
        +
        Overrides:
        +
        beforeUpdate in class Trigger<S extends Storable>
        +
        Parameters:
        storable - storable before being updated
        +
        Returns:
        arbitrary state object, passed to afterUpdate or failedUpdate method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        beforeUpdate

        +
        public java.lang.Object beforeUpdate(Transaction txn,
+                            S storable)
+                              throws PersistException
        +
        Description copied from class: Trigger
        +
        Called before a storable is to be updated. The default implementation + simply calls Trigger.beforeUpdate(Object). Only override if access to + the transaction is required. + +

        Any exception thrown by this method will cause the update operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the update method.

        +
        +
        Overrides:
        +
        beforeUpdate in class Trigger<S extends Storable>
        +
        Parameters:
        txn - nested transaction which trigger runs in
        storable - storable before being updated
        +
        Returns:
        arbitrary state object, passed to afterUpdate or failedUpdate method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        beforeTryUpdate

        +
        public java.lang.Object beforeTryUpdate(S storable)
+                                 throws PersistException
        +
        Description copied from class: Trigger
        +
        Called before a storable is to be updated via tryUpdate. The default + implementation simply calls Trigger.beforeUpdate(Object). Only override + if trigger needs to distinguish between different update variants. + +

        Any exception thrown by this method will cause the tryUpdate operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryUpdate method.

        +
        +
        Overrides:
        +
        beforeTryUpdate in class Trigger<S extends Storable>
        +
        Parameters:
        storable - storable before being updated
        +
        Returns:
        arbitrary state object, passed to afterTryUpdate or failedUpdate method
        +
        Throws:
        +
        PersistException
        See Also:
        Trigger.abortTry()
        +
        • +
      + + + + + +
        +
      • +

        beforeTryUpdate

        +
        public java.lang.Object beforeTryUpdate(Transaction txn,
+                               S storable)
+                                 throws PersistException
        +
        Description copied from class: Trigger
        +
        Called before a storable is to be updated via tryUpdate. The default + implementation simply calls Trigger.beforeTryUpdate(Object). Only + override if trigger needs access to the transaction and to distinguish + between different update variants. + +

        Any exception thrown by this method will cause the tryUpdate operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryUpdate method.

        +
        +
        Overrides:
        +
        beforeTryUpdate in class Trigger<S extends Storable>
        +
        Parameters:
        txn - nested transaction which trigger runs in
        storable - storable before being updated
        +
        Returns:
        arbitrary state object, passed to afterTryUpdate or failedUpdate method
        +
        Throws:
        +
        PersistException
        See Also:
        Trigger.abortTry()
        +
        • +
      + + + + + +
        +
      • +

        afterUpdate

        +
        public void afterUpdate(S storable,
+               java.lang.Object state)
+                 throws PersistException
        +
        Description copied from class: Trigger
        +
        Called right after a storable has been successfully updated. The default + implementation does nothing. + +

        Any exception thrown by this method will cause the update operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the update method.

        +
        +
        Overrides:
        +
        afterUpdate in class Trigger<S extends Storable>
        +
        Parameters:
        storable - storable after being updated
        state - optional object returned by beforeUpdate method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        afterTryUpdate

        +
        public void afterTryUpdate(S storable,
+                  java.lang.Object state)
+                    throws PersistException
        +
        Description copied from class: Trigger
        +
        Called right after a storable has been successfully updated via + tryUpdate. The default implementation simply calls Trigger.afterUpdate(S, java.lang.Object). + Only override if trigger needs to distinguish between different update + variants. + +

        Any exception thrown by this method will cause the tryUpdate + operation to rollback and all remaining triggers to not run. The + exception is ultimately passed to the caller of the tryUpdate method.

        +
        +
        Overrides:
        +
        afterTryUpdate in class Trigger<S extends Storable>
        +
        Parameters:
        storable - storable after being updated
        state - object returned by beforeTryUpdate method
        +
        Throws:
        +
        PersistException
        See Also:
        Trigger.abortTry()
        +
        • +
      + + + + + +
        +
      • +

        failedUpdate

        +
        public void failedUpdate(S storable,
+                java.lang.Object state)
        +
        Description copied from class: Trigger
        +
        Called when an update operation failed because the record was missing or + an exception was thrown. The main purpose of this method is to allow any + necessary clean-up to occur on the optional state object. + +

        Any exception thrown by this method will be passed to the current + thread's uncaught exception handler.

        +
        +
        Overrides:
        +
        failedUpdate in class Trigger<S extends Storable>
        +
        Parameters:
        storable - storable which failed to be updated
        state - optional object returned by beforeUpdate + method, but it may be null
        +
        • +
      + + + + + +
        +
      • +

        beforeDelete

        +
        public java.lang.Object beforeDelete(S storable)
+                              throws PersistException
        +
        Description copied from class: Trigger
        +
        Called before a storable is to be deleted. The default implementation + does nothing. + +

        Any exception thrown by this method will cause the delete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the delete method.

        +
        +
        Overrides:
        +
        beforeDelete in class Trigger<S extends Storable>
        +
        Parameters:
        storable - storable before being deleted
        +
        Returns:
        arbitrary state object, passed to afterDelete or failedDelete method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        beforeDelete

        +
        public java.lang.Object beforeDelete(Transaction txn,
+                            S storable)
+                              throws PersistException
        +
        Description copied from class: Trigger
        +
        Called before a storable is to be deleted. The default implementation + simply calls Trigger.beforeDelete(Object). Only override if access to + the transaction is required. + +

        Any exception thrown by this method will cause the delete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the delete method.

        +
        +
        Overrides:
        +
        beforeDelete in class Trigger<S extends Storable>
        +
        Parameters:
        txn - nested transaction which trigger runs in
        storable - storable before being deleted
        +
        Returns:
        arbitrary state object, passed to afterDelete or failedDelete method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        beforeTryDelete

        +
        public java.lang.Object beforeTryDelete(S storable)
+                                 throws PersistException
        +
        Description copied from class: Trigger
        +
        Called before a storable is to be deleted via tryDelete. The default + implementation simply calls Trigger.beforeDelete(Object). Only override + if trigger needs to distinguish between different delete variants. + +

        Any exception thrown by this method will cause the tryDelete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryDelete method.

        +
        +
        Overrides:
        +
        beforeTryDelete in class Trigger<S extends Storable>
        +
        Parameters:
        storable - storable before being deleted
        +
        Returns:
        arbitrary state object, passed to afterTryDelete or failedDelete method
        +
        Throws:
        +
        PersistException
        See Also:
        Trigger.abortTry()
        +
        • +
      + + + + + +
        +
      • +

        beforeTryDelete

        +
        public java.lang.Object beforeTryDelete(Transaction txn,
+                               S storable)
+                                 throws PersistException
        +
        Description copied from class: Trigger
        +
        Called before a storable is to be deleted via tryDelete. The default + implementation simply calls Trigger.beforeTryDelete(Object). Only + override if trigger needs access to the transaction and to distinguish + between different delete variants. + +

        Any exception thrown by this method will cause the tryDelete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryDelete method.

        +
        +
        Overrides:
        +
        beforeTryDelete in class Trigger<S extends Storable>
        +
        Parameters:
        txn - nested transaction which trigger runs in
        storable - storable before being deleted
        +
        Returns:
        arbitrary state object, passed to afterTryDelete or failedDelete method
        +
        Throws:
        +
        PersistException
        See Also:
        Trigger.abortTry()
        +
        • +
      + + + + + +
        +
      • +

        afterDelete

        +
        public void afterDelete(S storable,
+               java.lang.Object state)
+                 throws PersistException
        +
        Description copied from class: Trigger
        +
        Called right after a storable has been successfully deleted. The default + implementation does nothing. + +

        Any exception thrown by this method will cause the delete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the delete method.

        +
        +
        Overrides:
        +
        afterDelete in class Trigger<S extends Storable>
        +
        Parameters:
        storable - storable after being deleted
        state - optional object returned by beforeDelete method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        afterTryDelete

        +
        public void afterTryDelete(S storable,
+                  java.lang.Object state)
+                    throws PersistException
        +
        Description copied from class: Trigger
        +
        Called right after a storable has been successfully deleted via + tryDelete. The default implementation simply calls Trigger.afterDelete(S, java.lang.Object). + Only override if trigger needs to distinguish between different delete + variants. + +

        Any exception thrown by this method will cause the tryDelete + operation to rollback and all remaining triggers to not run. The + exception is ultimately passed to the caller of the tryDelete method.

        +
        +
        Overrides:
        +
        afterTryDelete in class Trigger<S extends Storable>
        +
        Parameters:
        storable - storable after being deleted
        state - object returned by beforeTryDelete method
        +
        Throws:
        +
        PersistException
        See Also:
        Trigger.abortTry()
        +
        • +
      + + + + + +
        +
      • +

        failedDelete

        +
        public void failedDelete(S storable,
+                java.lang.Object state)
        +
        Description copied from class: Trigger
        +
        Called when an delete operation failed because the record was missing or + an exception was thrown. The main purpose of this method is to allow any + necessary clean-up to occur on the optional state object. + +

        Any exception thrown by this method will be passed to the current + thread's uncaught exception handler.

        +
        +
        Overrides:
        +
        failedDelete in class Trigger<S extends Storable>
        +
        Parameters:
        storable - storable which failed to be deleted
        state - optional object returned by beforeDelete + method, but it may be null
        +
        • +
      + + + + + +
        +
      • +

        afterLoad

        +
        public void afterLoad(S storable)
+               throws FetchException
        +
        Description copied from class: Trigger
        +
        Called right after a storable has been successfully loaded or + fetched. The default implementation does nothing.
        +
        +
        Overrides:
        +
        afterLoad in class Trigger<S extends Storable>
        +
        Parameters:
        storable - storable after being loaded or fetched
        +
        Throws:
        +
        FetchException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/TriggerManagerCapability.html b/apidocs/com/amazon/carbonado/spi/TriggerManagerCapability.html new file mode 100644 index 0000000..c47f68b --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/TriggerManagerCapability.html @@ -0,0 +1,222 @@ + + + + + + +TriggerManagerCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.spi
+

Interface TriggerManagerCapability

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/class-use/AbstractRepository.html b/apidocs/com/amazon/carbonado/spi/class-use/AbstractRepository.html new file mode 100644 index 0000000..7326c96 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/AbstractRepository.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.spi.AbstractRepository (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.spi.AbstractRepository

+
+
No usage of com.amazon.carbonado.spi.AbstractRepository
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html b/apidocs/com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html new file mode 100644 index 0000000..1fe8cc9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html @@ -0,0 +1,295 @@ + + + + + + +Uses of Class com.amazon.carbonado.spi.AbstractRepositoryBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.spi.AbstractRepositoryBuilder

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/class-use/BelatedRepositoryCreator.html b/apidocs/com/amazon/carbonado/spi/class-use/BelatedRepositoryCreator.html new file mode 100644 index 0000000..9eaa0b0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/BelatedRepositoryCreator.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.spi.BelatedRepositoryCreator (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.spi.BelatedRepositoryCreator

+
+
No usage of com.amazon.carbonado.spi.BelatedRepositoryCreator
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/class-use/BelatedStorageCreator.html b/apidocs/com/amazon/carbonado/spi/class-use/BelatedStorageCreator.html new file mode 100644 index 0000000..4f07f2e --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/BelatedStorageCreator.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.spi.BelatedStorageCreator (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.spi.BelatedStorageCreator

+
+
No usage of com.amazon.carbonado.spi.BelatedStorageCreator
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/class-use/ExceptionTransformer.html b/apidocs/com/amazon/carbonado/spi/class-use/ExceptionTransformer.html new file mode 100644 index 0000000..05b0c88 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/ExceptionTransformer.html @@ -0,0 +1,161 @@ + + + + + + +Uses of Class com.amazon.carbonado.spi.ExceptionTransformer (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.spi.ExceptionTransformer

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/class-use/IndexInfoImpl.html b/apidocs/com/amazon/carbonado/spi/class-use/IndexInfoImpl.html new file mode 100644 index 0000000..4a0d79d --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/IndexInfoImpl.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.spi.IndexInfoImpl (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.spi.IndexInfoImpl

+
+
No usage of com.amazon.carbonado.spi.IndexInfoImpl
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/class-use/LobEngine.html b/apidocs/com/amazon/carbonado/spi/class-use/LobEngine.html new file mode 100644 index 0000000..6f6ee1d --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/LobEngine.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.spi.LobEngine (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.spi.LobEngine

+
+
No usage of com.amazon.carbonado.spi.LobEngine
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/class-use/RAFInputStream.html b/apidocs/com/amazon/carbonado/spi/class-use/RAFInputStream.html new file mode 100644 index 0000000..a03e900 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/RAFInputStream.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.spi.RAFInputStream (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.spi.RAFInputStream

+
+
No usage of com.amazon.carbonado.spi.RAFInputStream
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/class-use/RAFOutputStream.html b/apidocs/com/amazon/carbonado/spi/class-use/RAFOutputStream.html new file mode 100644 index 0000000..d966568 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/RAFOutputStream.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.spi.RAFOutputStream (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.spi.RAFOutputStream

+
+
No usage of com.amazon.carbonado.spi.RAFOutputStream
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/class-use/RepairExecutor.html b/apidocs/com/amazon/carbonado/spi/class-use/RepairExecutor.html new file mode 100644 index 0000000..3c1030b --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/RepairExecutor.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.spi.RepairExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.spi.RepairExecutor

+
+
No usage of com.amazon.carbonado.spi.RepairExecutor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/class-use/StoragePool.html b/apidocs/com/amazon/carbonado/spi/class-use/StoragePool.html new file mode 100644 index 0000000..d1978d4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/StoragePool.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.spi.StoragePool (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.spi.StoragePool

+
+
No usage of com.amazon.carbonado.spi.StoragePool
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/class-use/StoredLob.Block.html b/apidocs/com/amazon/carbonado/spi/class-use/StoredLob.Block.html new file mode 100644 index 0000000..5546179 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/StoredLob.Block.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.spi.StoredLob.Block (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.spi.StoredLob.Block

+
+
No usage of com.amazon.carbonado.spi.StoredLob.Block
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/class-use/StoredLob.html b/apidocs/com/amazon/carbonado/spi/class-use/StoredLob.html new file mode 100644 index 0000000..d1c031c --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/StoredLob.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.spi.StoredLob (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.spi.StoredLob

+
+
No usage of com.amazon.carbonado.spi.StoredLob
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/class-use/StoredSequence.html b/apidocs/com/amazon/carbonado/spi/class-use/StoredSequence.html new file mode 100644 index 0000000..360ae87 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/StoredSequence.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.spi.StoredSequence (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.spi.StoredSequence

+
+
No usage of com.amazon.carbonado.spi.StoredSequence
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/class-use/TriggerManager.html b/apidocs/com/amazon/carbonado/spi/class-use/TriggerManager.html new file mode 100644 index 0000000..d94488c --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/TriggerManager.html @@ -0,0 +1,161 @@ + + + + + + +Uses of Class com.amazon.carbonado.spi.TriggerManager (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.spi.TriggerManager

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/class-use/TriggerManagerCapability.html b/apidocs/com/amazon/carbonado/spi/class-use/TriggerManagerCapability.html new file mode 100644 index 0000000..7292f09 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/TriggerManagerCapability.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.spi.TriggerManagerCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.spi.TriggerManagerCapability

+
+
No usage of com.amazon.carbonado.spi.TriggerManagerCapability
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/package-frame.html b/apidocs/com/amazon/carbonado/spi/package-frame.html new file mode 100644 index 0000000..53b98ae --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/package-frame.html @@ -0,0 +1,38 @@ + + + + + + +com.amazon.carbonado.spi (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.spi

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/spi/package-summary.html b/apidocs/com/amazon/carbonado/spi/package-summary.html new file mode 100644 index 0000000..f7a106c --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/package-summary.html @@ -0,0 +1,254 @@ + + + + + + +com.amazon.carbonado.spi (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.spi

+
+
Service Provider Interface for Carbonado.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.spi Description

+
Service Provider Interface for Carbonado. Repositories are free to use this + package to aid in their implementation. User-level applications have no need + to use this package.
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/package-tree.html b/apidocs/com/amazon/carbonado/spi/package-tree.html new file mode 100644 index 0000000..b74945f --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/package-tree.html @@ -0,0 +1,176 @@ + + + + + + +com.amazon.carbonado.spi Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.spi

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/spi/package-use.html b/apidocs/com/amazon/carbonado/spi/package-use.html new file mode 100644 index 0000000..bcc5806 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/package-use.html @@ -0,0 +1,303 @@ + + + + + + +Uses of Package com.amazon.carbonado.spi (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.spi

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/ClassFileBuilder.html b/apidocs/com/amazon/carbonado/synthetic/ClassFileBuilder.html new file mode 100644 index 0000000..4ca888b --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/ClassFileBuilder.html @@ -0,0 +1,347 @@ + + + + + + +ClassFileBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.synthetic
+

Class ClassFileBuilder

+
+
+ +
+
    +
  • +
    +
    +
    public abstract class ClassFileBuilder
+extends java.lang.Object
    +
    Simple interface representing a partially filled class and injector pair. + +

    This is abstract because it provides no mechanism for defining the + classfile or injector; subclasses must provide them.

    +
    Author:
    +
    Don Schneider
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      protected org.cojen.classfile.ClassFilemClassFile +
      Partially hydrogenated class operators
      +
      protected org.cojen.util.ClassInjectormInjector 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ClassFileBuilder() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.Classbuild() +
      Defines the class for this generator
      +
      org.cojen.classfile.ClassFilegetClassFile() 
      org.cojen.util.ClassInjectorgetInjector() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        mClassFile

        +
        protected org.cojen.classfile.ClassFile mClassFile
        +
        Partially hydrogenated class operators
        +
        • +
      + + + +
        +
      • +

        mInjector

        +
        protected org.cojen.util.ClassInjector mInjector
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ClassFileBuilder

        +
        public ClassFileBuilder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getClassFile

        +
        public org.cojen.classfile.ClassFile getClassFile()
        +
        Returns:
        Returns the classFile.
        +
        • +
      + + + +
        +
      • +

        getInjector

        +
        public org.cojen.util.ClassInjector getInjector()
        +
        Returns:
        Returns the injector.
        +
        • +
      + + + +
        +
      • +

        build

        +
        public java.lang.Class build()
        +
        Defines the class for this generator
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html b/apidocs/com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html new file mode 100644 index 0000000..4e9a6cf --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html @@ -0,0 +1,233 @@ + + + + + + +SyntheticBuilder.ClassNameProvider (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.synthetic
+

Interface SyntheticBuilder.ClassNameProvider

+
+
+
+
    +
  • +
    +
    Enclosing interface:
    +
    SyntheticBuilder
    +
    +
    +
    +
    public static interface SyntheticBuilder.ClassNameProvider
    +
    Interface used to get the name for the class to generate. This allows the + client to apply different rules for classname generation.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetName() 
      booleanisExplicit() +
      SyntheticBuilder may choose to alter the class name to prevent a + class name collision.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        java.lang.String getName()
        +
        • +
      + + + +
        +
      • +

        isExplicit

        +
        boolean isExplicit()
        +
        SyntheticBuilder may choose to alter the class name to prevent a + class name collision. When explicit is true, the class name must not + be altered.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/SyntheticBuilder.html b/apidocs/com/amazon/carbonado/synthetic/SyntheticBuilder.html new file mode 100644 index 0000000..139651a --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/SyntheticBuilder.html @@ -0,0 +1,413 @@ + + + + + + +SyntheticBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.synthetic
+

Interface SyntheticBuilder

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    SyntheticStorableBuilder, SyntheticStorableReferenceBuilder
    +
    +
    +
    +
    public interface SyntheticBuilder
    +
    A synthetic builder provides a mechanism for creating a user storable from scratch. + The client creates the builder, decorates with properties and indexes on those + properties, then builds. + + If additional, ad hoc decoration is desired, the partially constructed classfile + can be retrieved and operated on directly via the ClassFileBuilder + returned by prepare().
    +
    Author:
    +
    Don Schneider, David Rosenstrauch
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getStorableClass

        +
        java.lang.Class<? extends Storable> getStorableClass()
+                                                     throws java.lang.IllegalStateException
        +
        Returns:
        the generated class file for this builder. Note that + proper operation requires that prepare() already have been called + prior to calling this method.
        +
        Throws:
        +
        java.lang.IllegalStateException - if build has not yet been called.
        +
        • +
      + + + +
        +
      • +

        build

        +
        java.lang.Class<? extends Storable> build()
+                                          throws SupportException
        +
        Convenience method to generate the class. + Build will always call prepare() and return the result of + generating the class from that classfile. If the caller does not + wish to regenerate the class from scratch, use getStorableClass() instead.
        +
        Throws:
        +
        SupportException
        +
        • +
      + + + +
        +
      • +

        addProperty

        +
        SyntheticProperty addProperty(java.lang.String name,
+                            java.lang.Class type)
        +
        Add a property to the set managed by this builder.
        +
        Parameters:
        name - of the property
        type - of the property
        +
        Returns:
        property specification which can be further refined
        +
        • +
      + + + +
        +
      • +

        addProperty

        +
        SyntheticProperty addProperty(SyntheticProperty prop)
        +
        Add an externally defined synthetic property to the list
        +
        Parameters:
        prop - to add
        +
        Returns:
        original synthetic property as a convenience
        +
        • +
      + + + +
        +
      • +

        hasProperty

        +
        boolean hasProperty(java.lang.String name)
        +
        Check to see if a particular property has already been added to the list of + properties to generate
        +
        Parameters:
        name -
        +
        • +
      + + + +
        +
      • +

        addPrimaryKey

        +
        SyntheticKey addPrimaryKey()
        +
        Add a primary key to be built.
        +
        Returns:
        key to be decorated with property values defining the primary key
        +
        • +
      + + + +
        +
      • +

        addAlternateKey

        +
        SyntheticKey addAlternateKey()
        +
        Add an alternate key to be built.
        +
        Returns:
        key to be decorated with property values defining the alternate key
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        addIndex

        +
        SyntheticIndex addIndex()
        +
        Add an index to the set managed by this builder. All indexes added this + way will be in addition to the primary and alternate key indexes.
        +
        Returns:
        index to be decorated with property values defining the index
        +
        • +
      + + + +
        +
      • +

        isVersioned

        +
        boolean isVersioned()
        +
        Returns true if a property with the version attribute has been addded
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/SyntheticIndex.html b/apidocs/com/amazon/carbonado/synthetic/SyntheticIndex.html new file mode 100644 index 0000000..cc93898 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/SyntheticIndex.html @@ -0,0 +1,206 @@ + + + + + + +SyntheticIndex (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.synthetic
+

Class SyntheticIndex

+
+
+ +
+
    +
  • +
    +
    +
    public class SyntheticIndex
+extends SyntheticPropertyList
    +
    Specification of a collection of properties which will participate in an index. Each + property has its own direction specification.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/SyntheticKey.html b/apidocs/com/amazon/carbonado/synthetic/SyntheticKey.html new file mode 100644 index 0000000..27720d9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/SyntheticKey.html @@ -0,0 +1,206 @@ + + + + + + +SyntheticKey (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.synthetic
+

Class SyntheticKey

+
+
+ +
+
    +
  • +
    +
    +
    public class SyntheticKey
+extends SyntheticPropertyList
    +
    Specification of a collection of properties which will participate in a key. Each + property has its own direction specification.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/SyntheticProperty.html b/apidocs/com/amazon/carbonado/synthetic/SyntheticProperty.html new file mode 100644 index 0000000..a50f3cf --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/SyntheticProperty.html @@ -0,0 +1,570 @@ + + + + + + +SyntheticProperty (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.synthetic
+

Class SyntheticProperty

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Comparable<SyntheticProperty>
    +
    +
    +
    +
    public class SyntheticProperty
+extends java.lang.Object
+implements java.lang.Comparable<SyntheticProperty>
    +
    Minimal specification of a storable property for use with a SyntheticStorableBuilder. + Synthetic storables can be used to generate user storables.
    +
    Author:
    +
    Don Schneider, Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      SyntheticProperty(java.lang.String name, + java.lang.Class type) +
      Every property requires minimally a name and a type
      +
      SyntheticProperty(java.lang.String name, + java.lang.Class type, + boolean isNullable, + boolean isVersion) 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SyntheticProperty

        +
        public SyntheticProperty(java.lang.String name,
+                 java.lang.Class type)
        +
        Every property requires minimally a name and a type
        +
        Parameters:
        name - for the property
        type - of the data it contains
        +
        • +
      + + + +
        +
      • +

        SyntheticProperty

        +
        public SyntheticProperty(java.lang.String name,
+                 java.lang.Class type,
+                 boolean isNullable,
+                 boolean isVersion)
        +
        Parameters:
        name - property name
        type - property type
        isNullable - true if this property can be null (default false)
        isVersion - true if this property is a version number (default false)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        makeReadMethodName

        +
        public static java.lang.String makeReadMethodName(java.lang.String name,
+                                  java.lang.Class type)
        +
        Generate a name for a bean "get" method ("is" method, for booleans).
        +
        Parameters:
        name - of the property
        type - return type of the property
        See Also:
        getReadMethodName()
        +
        • +
      + + + +
        +
      • +

        makeWriteMethodName

        +
        public static java.lang.String makeWriteMethodName(java.lang.String name)
        +
        Generate a name for a bean "set" method
        +
        Parameters:
        name - of the property
        See Also:
        getWriteMethodName()
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Returns:
        Name of the property
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public java.lang.Class getType()
        +
        Returns:
        type of the property
        +
        • +
      + + + +
        +
      • +

        isNullable

        +
        public boolean isNullable()
        +
        Returns:
        true if the property can be null
        +
        • +
      + + + +
        +
      • +

        setIsNullable

        +
        public void setIsNullable(boolean isNullable)
        +
        Parameters:
        isNullable - true if the property can be null
        +
        • +
      + + + +
        +
      • +

        isVersion

        +
        public boolean isVersion()
        +
        Returns:
        true if the property contains the versioning information for the storable. Note that + at most one property can be the version property for a given storable
        +
        • +
      + + + +
        +
      • +

        setIsVersion

        +
        public void setIsVersion(boolean isVersion)
        +
        Parameters:
        isVersion - true if the property should contain the versioning information for the + storable
        +
        • +
      + + + +
        +
      • +

        getReadMethodName

        +
        public java.lang.String getReadMethodName()
        +
        Returns the name of the read method.
        +
        • +
      + + + +
        +
      • +

        getWriteMethodName

        +
        public java.lang.String getWriteMethodName()
        +
        Returns the name of the write method.
        +
        • +
      + + + + + + + +
        +
      • +

        setAdapter

        +
        public void setAdapter(StorablePropertyAdapter adapter)
        +
        Storables cannot currently have more than one adapter per property.
        +
        Parameters:
        adapter - The adapter to set.
        +
        • +
      + + + +
        +
      • +

        addAccessorAnnotationDescriptor

        +
        public void addAccessorAnnotationDescriptor(java.lang.String annotationDesc)
        +
        Add an arbitrary annotation to the property accessor method, as + specified by a descriptor.
        +
        See Also:
        AnnotationDescPrinter
        +
        • +
      + + + +
        +
      • +

        getAccessorAnnotationDescriptors

        +
        public java.util.List<java.lang.String> getAccessorAnnotationDescriptors()
        +
        Returns all the added accessor annotation descriptors in an unmodifiable list.
        +
        • +
      + + + +
        +
      • +

        compareTo

        +
        public int compareTo(SyntheticProperty otherProp)
        +
        Comparable implementation.
        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<SyntheticProperty>
        +
        Parameters:
        otherProp -
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/SyntheticPropertyList.html b/apidocs/com/amazon/carbonado/synthetic/SyntheticPropertyList.html new file mode 100644 index 0000000..ddf1aa0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/SyntheticPropertyList.html @@ -0,0 +1,289 @@ + + + + + + +SyntheticPropertyList (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.synthetic
+

Class SyntheticPropertyList

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    SyntheticIndex, SyntheticKey
    +
    +
    +
    +
    public abstract class SyntheticPropertyList
+extends java.lang.Object
    +
    Specification of a collection of properties which will participate in a key + or index. Each property has its own direction specification.
    +
    Author:
    +
    Brian S O'Neill, Don Schneider
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidaddProperty(java.lang.String propertyName) +
      Adds a property to this index, with an unspecified direction.
      +
      voidaddProperty(java.lang.String propertyName, + Direction direction) +
      Adds a property to this index, with the specified direction.
      +
      java.util.Iterator<java.lang.String>getProperties() +
      Returns all the properties in this index, optionally prefixed with a '+' + or '-' to indicate direction.
      +
      intgetPropertyCount() +
      Returns the count of properties in this index.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addProperty

        +
        public void addProperty(java.lang.String propertyName)
        +
        Adds a property to this index, with an unspecified direction.
        +
        Parameters:
        propertyName - name of property to add to index
        +
        • +
      + + + +
        +
      • +

        addProperty

        +
        public void addProperty(java.lang.String propertyName,
+               Direction direction)
        +
        Adds a property to this index, with the specified direction.
        +
        Parameters:
        propertyName - name of property to add to index
        direction - optional direction of property
        +
        • +
      + + + +
        +
      • +

        getPropertyCount

        +
        public int getPropertyCount()
        +
        Returns the count of properties in this index.
        +
        • +
      + + + +
        +
      • +

        getProperties

        +
        public java.util.Iterator<java.lang.String> getProperties()
        +
        Returns all the properties in this index, optionally prefixed with a '+' + or '-' to indicate direction.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html b/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html new file mode 100644 index 0000000..4e65bfc --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html @@ -0,0 +1,621 @@ + + + + + + +SyntheticStorableBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.synthetic
+

Class SyntheticStorableBuilder

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    SyntheticBuilder
    +
    +
    +
    +
    public class SyntheticStorableBuilder
+extends java.lang.Object
+implements SyntheticBuilder
    +
    Allows the definition of very simple synthetic storables. Only a primary key + index can be defined; at least one property must be a primary key property. A + property can be nullable and can be specified as the version property. + + This class acts both as builder factory and as builder.
    +
    Author:
    +
    Don Schneider, Brian S O'Neill, David Rosenstrauch
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SyntheticStorableBuilder

        +
        public SyntheticStorableBuilder(java.lang.String name,
+                        java.lang.ClassLoader loader)
        +
        Parameters:
        name - base name for the generated class. This is usually a fully qualified + name, a la "com.amazon.carbonado.storables.happy.synthetic.storable"
        loader - ClassLoader to use for the generated class
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getStorableClass

        +
        public java.lang.Class<? extends Storable> getStorableClass()
        +
        +
        Specified by:
        +
        getStorableClass in interface SyntheticBuilder
        +
        Returns:
        the generated class file for this builder. Note that + proper operation requires that SyntheticBuilder.prepare() already have been called + prior to calling this method.
        +
        • +
      + + + + + + + +
        +
      • +

        addProperty

        +
        public SyntheticProperty addProperty(java.lang.String name,
+                            java.lang.Class type)
        +
        Description copied from interface: SyntheticBuilder
        +
        Add a property to the set managed by this builder.
        +
        +
        Specified by:
        +
        addProperty in interface SyntheticBuilder
        +
        Parameters:
        name - of the property
        type - of the property
        +
        Returns:
        property specification which can be further refined
        +
        • +
      + + + + + + + +
        +
      • +

        hasProperty

        +
        public boolean hasProperty(java.lang.String name)
        +
        Description copied from interface: SyntheticBuilder
        +
        Check to see if a particular property has already been added to the list of + properties to generate
        +
        +
        Specified by:
        +
        hasProperty in interface SyntheticBuilder
        +
        +
        • +
      + + + +
        +
      • +

        addPrimaryKey

        +
        public SyntheticKey addPrimaryKey()
        +
        Description copied from interface: SyntheticBuilder
        +
        Add a primary key to be built.
        +
        +
        Specified by:
        +
        addPrimaryKey in interface SyntheticBuilder
        +
        Returns:
        key to be decorated with property values defining the primary key
        +
        • +
      + + + +
        +
      • +

        addAlternateKey

        +
        public SyntheticKey addAlternateKey()
        +
        Description copied from interface: SyntheticBuilder
        +
        Add an alternate key to be built.
        +
        +
        Specified by:
        +
        addAlternateKey in interface SyntheticBuilder
        +
        Returns:
        key to be decorated with property values defining the alternate key
        +
        • +
      + + + +
        +
      • +

        addIndex

        +
        public SyntheticIndex addIndex()
        +
        Description copied from interface: SyntheticBuilder
        +
        Add an index to the set managed by this builder. All indexes added this + way will be in addition to the primary and alternate key indexes.
        +
        +
        Specified by:
        +
        addIndex in interface SyntheticBuilder
        +
        Returns:
        index to be decorated with property values defining the index
        +
        • +
      + + + +
        +
      • +

        isVersioned

        +
        public boolean isVersioned()
        +
        Description copied from interface: SyntheticBuilder
        +
        Returns true if a property with the version attribute has been addded
        +
        +
        Specified by:
        +
        isVersioned in interface SyntheticBuilder
        +
        +
        • +
      + + + + + + + +
        +
      • +

        setClassNameProvider

        +
        public void setClassNameProvider(SyntheticBuilder.ClassNameProvider classNameProvider)
        +
        Parameters:
        classNameProvider - The classNameProvider to set.
        +
        • +
      + + + +
        +
      • +

        setEvolvable

        +
        public void setEvolvable(boolean evolvable)
        +
        By default, generated storable implements the Unevolvable marker + interface, which can affect how it is encoded. It usually does not make + sense to support storable evolution new versions can be (and often will + be) given different names. + +

        Pass in true to change from the default behavior, and not implement + Unevolvable. When doing so, a ClassNameProvider should also be provided + to ensure consistent naming which does not include property names.

        +
        • +
      + + + +
        +
      • +

        definePropertyBeanMethods

        +
        protected boolean definePropertyBeanMethods(org.cojen.classfile.ClassFile cf,
+                                SyntheticProperty property)
        +
        Add the get & set methods for this property
        +
        Returns:
        true if version property was added
        +
        • +
      + + + +
        +
      • +

        getName

        +
        protected java.lang.String getName()
        +
        Frequently used by the SyntheticBuilder.ClassNameProvider as a + basis for the generated classname
        +
        Returns:
        builder name
        +
        • +
      + + + + + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html b/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html new file mode 100644 index 0000000..9b834f5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html @@ -0,0 +1,346 @@ + + + + + + +SyntheticStorableReferenceAccess (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.synthetic
+

Class SyntheticStorableReferenceAccess<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public class SyntheticStorableReferenceAccess<S extends Storable>
+extends java.lang.Object
    +
    Provides access to the generated storable reference class and utility + methods.
    +
    Since:
    +
    1.2.1
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    SyntheticStorableReferenceBuilder
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidcopyFromMaster(Storable reference, + S master) +
      Sets all the properties of the given reference, using the applicable + properties of the given master.
      +
      voidcopyToMasterPrimaryKey(Storable reference, + S master) +
      Sets all the primary key properties of the given master, using the + applicable properties of the given reference.
      +
      java.util.Comparator<? extends Storable>getComparator() +
      Returns a comparator for ordering storable reference instances.
      +
      java.lang.Class<S>getMasterClass() +
      Returns the storable class which is referenced.
      +
      java.lang.Class<? extends Storable>getReferenceClass() +
      Returns the generated storable reference class.
      +
      booleanisConsistent(Storable reference, + S master) +
      Returns true if the properties of the given reference match those + contained in the master, excluding any version property.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getMasterClass

        +
        public java.lang.Class<S> getMasterClass()
        +
        Returns the storable class which is referenced.
        +
        • +
      + + + +
        +
      • +

        getReferenceClass

        +
        public java.lang.Class<? extends Storable> getReferenceClass()
        +
        Returns the generated storable reference class.
        +
        • +
      + + + +
        +
      • +

        getComparator

        +
        public java.util.Comparator<? extends Storable> getComparator()
        +
        Returns a comparator for ordering storable reference instances. This + order matches the primary key of the master storable.
        +
        • +
      + + + + + +
        +
      • +

        copyToMasterPrimaryKey

        +
        public void copyToMasterPrimaryKey(Storable reference,
+                          S master)
+                            throws FetchException
        +
        Sets all the primary key properties of the given master, using the + applicable properties of the given reference.
        +
        Parameters:
        reference - source of property values
        master - master whose primary key properties will be set
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + + + +
        +
      • +

        copyFromMaster

        +
        public void copyFromMaster(Storable reference,
+                  S master)
+                    throws FetchException
        +
        Sets all the properties of the given reference, using the applicable + properties of the given master.
        +
        Parameters:
        reference - reference whose properties will be set
        master - source of property values
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + + + +
        +
      • +

        isConsistent

        +
        public boolean isConsistent(Storable reference,
+                   S master)
+                     throws FetchException
        +
        Returns true if the properties of the given reference match those + contained in the master, excluding any version property. This will + always return true after a call to copyFromMaster.
        +
        Parameters:
        reference - reference whose properties will be tested
        master - source of property values
        +
        Throws:
        +
        FetchException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html b/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html new file mode 100644 index 0000000..75ec3d5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html @@ -0,0 +1,727 @@ + + + + + + +SyntheticStorableReferenceBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.synthetic
+

Class SyntheticStorableReferenceBuilder<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    SyntheticBuilder
    +
    +
    +
    +
    public class SyntheticStorableReferenceBuilder<S extends Storable>
+extends java.lang.Object
+implements SyntheticBuilder
    +
    A SyntheticStorableReference defines new kinds of Storables from an existing + master storable. This is used in situations when additional information about + a storable needs to be tracked -- eg, for an index, or for caching. The + storable may optionally have completely new, synthetic properties added. + +

    + All primary key properties of the master storable will also be provided by the + derived storable. Three special methods will be provided: +

      +
    • getMaster - retrieves the original storable
      • +
    • setAllProperties - sets the properties the syntheticReference has in + common with the master to the values of the master instance
      • +
    • isConsistent - verifies that the properties the syntheticReference has + in common with the master are consistent with an instance of the master, + meaning that they are in the same state and, if set, equal.
      • +
    +
    Author:
    +
    Brian S O'Neill, Don Schneider, David Rosenstrauch
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SyntheticStorableReferenceBuilder

        +
        public SyntheticStorableReferenceBuilder(java.lang.Class<S> storableClass,
+                                 boolean isUnique)
        +
        Parameters:
        storableClass - class of the storable that will be referenced by this + synthetic. The name for the synthetic storable will be based + on this class's name, decorated with the properties which + participate in the primary key for the synthetic storable.
        +
        • +
      + + + +
        +
      • +

        SyntheticStorableReferenceBuilder

        +
        public SyntheticStorableReferenceBuilder(java.lang.Class<S> storableClass,
+                                 java.lang.String baseName,
+                                 boolean isUnique)
        +
        Parameters:
        storableClass - class of the storable that will be referenced by this + synthetic
        baseName - of the generated synthetic. Note that for some repositories + this name will be visible across the entire repository, so it + is good practice to include namespace information to guarantee + uniqueness.
        isUnique - true if the properties that are explicitly identified as primary + key properites are sufficient to uniquely identify the index object.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getReferenceAccess

        +
        public SyntheticStorableReferenceAccess<S> getReferenceAccess()
        +
        Build and return access to the generated storable reference class.
        +
        Since:
        +
        1.2.1
        +
        • +
      + + + +
        +
      • +

        getStorableClass

        +
        public java.lang.Class<? extends Storable> getStorableClass()
+                                                     throws java.lang.IllegalStateException
        +
        +
        Specified by:
        +
        getStorableClass in interface SyntheticBuilder
        +
        Returns:
        the generated class file for this builder. Note that + proper operation requires that SyntheticBuilder.prepare() already have been called + prior to calling this method.
        +
        Throws:
        +
        java.lang.IllegalStateException - if build has not yet been called.
        +
        • +
      + + + + + + + +
        +
      • +

        addKeyProperty

        +
        public SyntheticProperty 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.
        +
        Parameters:
        name -
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        hasProperty

        +
        public boolean hasProperty(java.lang.String name)
        +
        Description copied from interface: SyntheticBuilder
        +
        Check to see if a particular property has already been added to the list of + properties to generate
        +
        +
        Specified by:
        +
        hasProperty in interface SyntheticBuilder
        +
        +
        • +
      + + + +
        +
      • +

        getUserProps

        +
        public java.util.List<SyntheticProperty> getUserProps()
        +
        Returns:
        Returns the indexProps.
        +
        • +
      + + + +
        +
      • +

        addPrimaryKey

        +
        public SyntheticKey addPrimaryKey()
        +
        Description copied from interface: SyntheticBuilder
        +
        Add a primary key to be built.
        +
        +
        Specified by:
        +
        addPrimaryKey in interface SyntheticBuilder
        +
        Returns:
        key to be decorated with property values defining the primary key
        +
        • +
      + + + +
        +
      • +

        addAlternateKey

        +
        public SyntheticKey addAlternateKey()
        +
        Description copied from interface: SyntheticBuilder
        +
        Add an alternate key to be built.
        +
        +
        Specified by:
        +
        addAlternateKey in interface SyntheticBuilder
        +
        Returns:
        key to be decorated with property values defining the alternate key
        +
        • +
      + + + +
        +
      • +

        addIndex

        +
        public SyntheticIndex addIndex()
        +
        Description copied from interface: SyntheticBuilder
        +
        Add an index to the set managed by this builder. All indexes added this + way will be in addition to the primary and alternate key indexes.
        +
        +
        Specified by:
        +
        addIndex in interface SyntheticBuilder
        +
        Returns:
        index to be decorated with property values defining the index
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.Object getName()
        +
        • +
      + + + +
        +
      • +

        isUnique

        +
        public boolean isUnique()
        +
        True if the generated derived class should be considered unique. If + non-unique, all properties are added to the primary key so there will be + no conflicts between various derived classes derived from the same base + storable.
        +
        • +
      + + + +
        +
      • +

        isVersioned

        +
        public boolean isVersioned()
        +
        Description copied from interface: SyntheticBuilder
        +
        Returns true if a property with the version attribute has been addded
        +
        +
        Specified by:
        +
        isVersioned in interface SyntheticBuilder
        +
        +
        • +
      + + + + + +
        +
      • +

        copyToMasterPrimaryKey

        +
        @Deprecated
+public void copyToMasterPrimaryKey(Storable indexEntry,
+                                     S master)
+                            throws FetchException
        +
        Deprecated. call getReferenceAccess
        +
        Sets all the primary key properties of the given master, using the + applicable properties of the given index entry.
        +
        Parameters:
        indexEntry - source of property values
        master - master whose primary key properties will be set
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + + + +
        +
      • +

        copyFromMaster

        +
        @Deprecated
+public void copyFromMaster(Storable indexEntry,
+                             S master)
+                    throws FetchException
        +
        Deprecated. call getReferenceAccess
        +
        Sets all the properties of the given index entry, using the applicable + properties of the given master.
        +
        Parameters:
        indexEntry - index entry whose properties will be set
        master - source of property values
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + + + +
        +
      • +

        isConsistent

        +
        @Deprecated
+public boolean isConsistent(Storable indexEntry,
+                              S master)
+                     throws FetchException
        +
        Deprecated. call getReferenceAccess
        +
        Returns true if the properties of the given index entry match those + contained in the master, excluding any version property. This will + always return true after a call to copyFromMaster.
        +
        Parameters:
        indexEntry - index entry whose properties will be tested
        master - source of property values
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        getComparator

        +
        @Deprecated
+public java.util.Comparator<? extends Storable> getComparator()
        +
        Deprecated. call getReferenceAccess
        +
        Returns a comparator for ordering index entries.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/ClassFileBuilder.html b/apidocs/com/amazon/carbonado/synthetic/class-use/ClassFileBuilder.html new file mode 100644 index 0000000..8336989 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/ClassFileBuilder.html @@ -0,0 +1,168 @@ + + + + + + +Uses of Class com.amazon.carbonado.synthetic.ClassFileBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.synthetic.ClassFileBuilder

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.ClassNameProvider.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.ClassNameProvider.html new file mode 100644 index 0000000..ed6d885 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.ClassNameProvider.html @@ -0,0 +1,173 @@ + + + + + + +Uses of Interface com.amazon.carbonado.synthetic.SyntheticBuilder.ClassNameProvider (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.synthetic.SyntheticBuilder.ClassNameProvider

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.html new file mode 100644 index 0000000..718e671 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.html @@ -0,0 +1,169 @@ + + + + + + +Uses of Interface com.amazon.carbonado.synthetic.SyntheticBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.synthetic.SyntheticBuilder

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticIndex.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticIndex.html new file mode 100644 index 0000000..d7d38a1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticIndex.html @@ -0,0 +1,170 @@ + + + + + + +Uses of Class com.amazon.carbonado.synthetic.SyntheticIndex (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.synthetic.SyntheticIndex

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticKey.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticKey.html new file mode 100644 index 0000000..c8a9bbd --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticKey.html @@ -0,0 +1,184 @@ + + + + + + +Uses of Class com.amazon.carbonado.synthetic.SyntheticKey (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.synthetic.SyntheticKey

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticProperty.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticProperty.html new file mode 100644 index 0000000..502d77f --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticProperty.html @@ -0,0 +1,251 @@ + + + + + + +Uses of Class com.amazon.carbonado.synthetic.SyntheticProperty (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.synthetic.SyntheticProperty

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticPropertyList.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticPropertyList.html new file mode 100644 index 0000000..bb6edb3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticPropertyList.html @@ -0,0 +1,168 @@ + + + + + + +Uses of Class com.amazon.carbonado.synthetic.SyntheticPropertyList (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.synthetic.SyntheticPropertyList

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableBuilder.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableBuilder.html new file mode 100644 index 0000000..0709686 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableBuilder.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.synthetic.SyntheticStorableBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.synthetic.SyntheticStorableBuilder

+
+
No usage of com.amazon.carbonado.synthetic.SyntheticStorableBuilder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceAccess.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceAccess.html new file mode 100644 index 0000000..1a5915e --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceAccess.html @@ -0,0 +1,162 @@ + + + + + + +Uses of Class com.amazon.carbonado.synthetic.SyntheticStorableReferenceAccess (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.synthetic.SyntheticStorableReferenceAccess

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceBuilder.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceBuilder.html new file mode 100644 index 0000000..91c893c --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceBuilder.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder

+
+
No usage of com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/package-frame.html b/apidocs/com/amazon/carbonado/synthetic/package-frame.html new file mode 100644 index 0000000..1b07fca --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +com.amazon.carbonado.synthetic (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.synthetic

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/package-summary.html b/apidocs/com/amazon/carbonado/synthetic/package-summary.html new file mode 100644 index 0000000..df0ae0f --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/package-summary.html @@ -0,0 +1,216 @@ + + + + + + +com.amazon.carbonado.synthetic (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.synthetic

+
+
Support for dynamic creation of storables, intended for internal use by + repository implementations.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.synthetic Description

+
Support for dynamic creation of storables, intended for internal use by + repository implementations.
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/package-tree.html b/apidocs/com/amazon/carbonado/synthetic/package-tree.html new file mode 100644 index 0000000..c03631f --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/package-tree.html @@ -0,0 +1,145 @@ + + + + + + +com.amazon.carbonado.synthetic Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.synthetic

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/synthetic/package-use.html b/apidocs/com/amazon/carbonado/synthetic/package-use.html new file mode 100644 index 0000000..088e697 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/package-use.html @@ -0,0 +1,192 @@ + + + + + + +Uses of Package com.amazon.carbonado.synthetic (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.synthetic

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/txn/TransactionManager.html b/apidocs/com/amazon/carbonado/txn/TransactionManager.html new file mode 100644 index 0000000..eae85dc --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/TransactionManager.html @@ -0,0 +1,573 @@ + + + + + + +TransactionManager (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.txn
+

Class TransactionManager<Txn>

+
+
+ +
+
    +
  • +
    Type Parameters:
    Txn - Transaction implementation
    +
    +
    +
    public abstract class TransactionManager<Txn>
+extends java.lang.Object
    +
    Generic transaction manager for repositories.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected abstract voidabortTxn(Txn txn) +
      Aborts and closes the given internal transaction.
      +
      protected voidattachNotification(Txn txn) +
      Called to notify internal method that transaction is attached.
      +
      voidclose(boolean suspend) +
      Closes all transaction scopes.
      +
      protected abstract booleancommitTxn(Txn txn) +
      Commits and closes the given internal transaction.
      +
      protected abstract TxncreateTxn(Txn parent, + IsolationLevel level) +
      Creates an internal transaction representation, with the optional parent + transaction.
      +
      protected TxncreateTxn(Txn parent, + IsolationLevel level, + int timeout, + java.util.concurrent.TimeUnit unit) +
      Creates an internal transaction representation, with the optional parent + transaction.
      +
      TransactionScope<Txn>detachLocalScope() +
      Detaches the thread-local TransactionScope from the current thread.
      +
      protected voiddetachNotification(Txn txn) +
      Called to notify internal method that transaction is detached.
      +
      booleanisClosed() 
      TransactionScope<Txn>localScope() +
      Returns the thread-local TransactionScope, creating it if needed.
      +
      protected voidreuseTxn(Txn txn) +
      Called when a transaction is about to be reused.
      +
      protected abstract IsolationLevelselectIsolationLevel(Transaction parent, + IsolationLevel level) +
      Returns supported isolation level, which may be higher.
      +
      protected voidsetForUpdate(Txn txn, + boolean forUpdate) +
      Called when the Transaction.setForUpdate method is called.
      +
      protected abstract booleansupportsForUpdate() +
      Return true if transactions support "for update" mode.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TransactionManager

        +
        public TransactionManager()
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        localScope

        +
        public TransactionScope<Txn> localScope()
        +
        Returns the thread-local TransactionScope, creating it if needed.
        +
        • +
      + + + +
        +
      • +

        detachLocalScope

        +
        public TransactionScope<Txn> detachLocalScope()
        +
        Detaches the thread-local TransactionScope from the current thread. It + can be attached later, and to any thread + which does not currently have a TransactionScope.
        +
        Returns:
        detached thread-local TransactionScope or null if none
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close(boolean suspend)
+           throws RepositoryException
        +
        Closes all transaction scopes. Should be called only when repository is + closed.
        +
        Parameters:
        suspend - when true, indefinitely suspend all threads interacting + with transactions
        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        isClosed

        +
        public boolean isClosed()
        +
        • +
      + + + +
        +
      • +

        selectIsolationLevel

        +
        protected abstract IsolationLevel selectIsolationLevel(Transaction parent,
+                                  IsolationLevel level)
        +
        Returns supported isolation level, which may be higher. If isolation + level cannot go higher (or lower than parent) then return null.
        +
        Parameters:
        parent - optional parent transaction
        level - desired isolation level (may be null)
        +
        • +
      + + + +
        +
      • +

        supportsForUpdate

        +
        protected abstract boolean supportsForUpdate()
        +
        Return true if transactions support "for update" mode.
        +
        Since:
        +
        1.2
        +
        • +
      + + + + + +
        +
      • +

        createTxn

        +
        protected abstract Txn createTxn(Txn parent,
+            IsolationLevel level)
+                          throws java.lang.Exception
        +
        Creates an internal transaction representation, with the optional parent + transaction. If parent is not null and real nested transactions are not + supported, simply return parent transaction for supporting fake nested + transactions.
        +
        Parameters:
        parent - optional parent transaction
        level - required isolation level
        +
        Returns:
        new transaction, parent transaction, or possibly null if required + isolation level is none
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + + + +
        +
      • +

        createTxn

        +
        protected Txn createTxn(Txn parent,
+            IsolationLevel level,
+            int timeout,
+            java.util.concurrent.TimeUnit unit)
+                 throws java.lang.Exception
        +
        Creates an internal transaction representation, with the optional parent + transaction. If parent is not null and real nested transactions are not + supported, simply return parent transaction for supporting fake nested + transactions. + +

        The default implementation of this method just calls the regular + createTxn method, ignoring the timeout parameter.

        +
        Parameters:
        parent - optional parent transaction
        level - required isolation level
        timeout - desired timeout for lock acquisition, never negative
        unit - timeout unit, never null
        +
        Returns:
        new transaction, parent transaction, or possibly null if required + isolation level is none
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + + + +
        +
      • +

        reuseTxn

        +
        protected void reuseTxn(Txn txn)
+                 throws java.lang.Exception
        +
        Called when a transaction is about to be reused. The default + implementation of this method does nothing. Override if any preparation + is required to ready a transaction for reuse.
        +
        Parameters:
        txn - transaction to reuse, never null
        +
        Throws:
        +
        java.lang.Exception
        Since:
        +
        1.1.3
        +
        • +
      + + + + + +
        +
      • +

        setForUpdate

        +
        protected void setForUpdate(Txn txn,
+                boolean forUpdate)
        +
        Called when the Transaction.setForUpdate method is called. The default + implementation of this method does nothing. Override if internal + transaction needs to switch modes.
        +
        Since:
        +
        1.2.1
        +
        • +
      + + + + + +
        +
      • +

        attachNotification

        +
        protected void attachNotification(Txn txn)
        +
        Called to notify internal method that transaction is attached. + The default implementation of this method does nothing. Override if + using remote transactions.
        +
        Parameters:
        txn - transaction that is attached, could be null if none exists
        Since:
        +
        1.2.2
        +
        • +
      + + + + + +
        +
      • +

        detachNotification

        +
        protected void detachNotification(Txn txn)
        +
        Called to notify internal method that transaction is detached. + The default implementation of this method does nothing. Override if + using remote transactions.
        +
        Parameters:
        txn - transaction that is dettached, could be null if none exists
        Since:
        +
        1.2.2
        +
        • +
      + + + + + +
        +
      • +

        commitTxn

        +
        protected abstract boolean commitTxn(Txn txn)
+                              throws PersistException
        +
        Commits and closes the given internal transaction.
        +
        Returns:
        true if transaction object is still valid
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/txn/TransactionMonitor.html b/apidocs/com/amazon/carbonado/txn/TransactionMonitor.html new file mode 100644 index 0000000..95d017e --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/TransactionMonitor.html @@ -0,0 +1,239 @@ + + + + + + +TransactionMonitor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.txn
+

Interface TransactionMonitor

+
+
+
+
    +
  • +
    +
    +
    public interface TransactionMonitor
    +
    Is notified as transactions enter and exit. Implementation must be thread-safe.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    TransactionManager
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidentered(Transaction entered, + Transaction parent) +
      Called by a thread which has just entered a transaction.
      +
      voidexited(Transaction exited, + Transaction active) +
      Called by a thread which has just exited a transaction.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        entered

        +
        void entered(Transaction entered,
+           Transaction parent)
        +
        Called by a thread which has just entered a transaction.
        +
        Parameters:
        entered - transaction just entered
        parent - optional parent of transaction; is null for top level transactions
        +
        • +
      + + + +
        +
      • +

        exited

        +
        void exited(Transaction exited,
+          Transaction active)
        +
        Called by a thread which has just exited a transaction. Only the first + invocation of the exit method is passed to this monitor.
        +
        Parameters:
        exited - transaction just exited
        active - optional transaction which is now active; is null if the + outermost transaction scope exited
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/txn/TransactionPair.html b/apidocs/com/amazon/carbonado/txn/TransactionPair.html new file mode 100644 index 0000000..37080e6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/TransactionPair.html @@ -0,0 +1,502 @@ + + + + + + +TransactionPair (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.txn
+

Class TransactionPair

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Transaction
    +
    +
    +
    +
    public class TransactionPair
+extends java.lang.Object
+implements Transaction
    +
    Pairs two transaction together into one. The transaction cannot be atomic, + however. Inconsistencies can result if the primary transaction succeeds in + committing, but the secondary fails. Therefore, the designated primary + transaction should be the one that is more likely to fail. For example, the + primary transaction might rely on the network, but the secondary operates + locally.
    +
    Author:
    +
    Don Schneider, Brian S O'Neill
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidattach() +
      Attaches this transaction to the current thread, if it has been + detached.
      +
      voidcommit() +
      If currently in a transaction, commits all changes to the storage layer + since the last commit within the transaction.
      +
      voiddetach() +
      Detaches this transaction from the current thread.
      +
      voidexit() +
      Closes the current transaction, aborting all changes since the last + commit.
      +
      IsolationLevelgetIsolationLevel() +
      Returns the isolation level of this transaction.
      +
      booleanisForUpdate() +
      Returns true if this transaction is in update mode, which is adjusted by + calling Transaction.setForUpdate(boolean).
      +
      booleanpreCommit() +
      Calling this method commits all nested child transactions, closes all + scoped cursors, and locks out some interactions from other threads.
      +
      voidsetDesiredLockTimeout(int timeout, + java.util.concurrent.TimeUnit unit) +
      Specify a desired timeout for aquiring locks within this + transaction.
      +
      voidsetForUpdate(boolean forUpdate) +
      Set to true to force all read operations within this transaction to + acquire upgradable or write locks.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TransactionPair

        +
        public TransactionPair(Transaction primaryTransaction,
+               Transaction secondaryTransaction)
        +
        Parameters:
        primaryTransaction - is committed first, exited last
        secondaryTransaction - is exited first, commited last
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        commit

        +
        public void commit()
+            throws PersistException
        +
        Description copied from interface: Transaction
        +
        If currently in a transaction, commits all changes to the storage layer + since the last commit within the transaction.
        +
        +
        Specified by:
        +
        commit in interface Transaction
        +
        Throws:
        +
        PersistException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        exit

        +
        public void exit()
+          throws PersistException
        +
        Description copied from interface: Transaction
        +
        Closes the current transaction, aborting all changes since the last + commit.
        +
        +
        Specified by:
        +
        exit in interface Transaction
        +
        Throws:
        +
        PersistException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        setForUpdate

        +
        public void setForUpdate(boolean forUpdate)
        +
        Description copied from interface: Transaction
        +
        Set to true to force all read operations within this transaction to + acquire upgradable or write locks. This option eliminates deadlocks that + may occur when updating records, except it may increase contention.
        +
        +
        Specified by:
        +
        setForUpdate in interface Transaction
        +
        +
        • +
      + + + + + + + +
        +
      • +

        setDesiredLockTimeout

        +
        public void setDesiredLockTimeout(int timeout,
+                         java.util.concurrent.TimeUnit unit)
        +
        Description copied from interface: Transaction
        +
        Specify a desired timeout for aquiring locks within this + transaction. Calling this method may have have no effect at all, if the + repository does not support this feature. In addition, the lock timeout + might not be alterable if the transaction contains uncommitted data. + +

        Also, the range of lock timeout values supported might be small. For + example, only a timeout value of zero might be supported. In that case, + the transaction is configured to not wait at all when trying to acquire + locks. Expect immediate timeout exceptions when locks cannot be + granted. + +

        Nested transactions inherit the desired lock timeout of their + parent. Top transactions always begin with the default lock timeout.

        +
        +
        Specified by:
        +
        setDesiredLockTimeout in interface Transaction
        +
        Parameters:
        timeout - Desired lock timeout. If negative, revert lock timeout to + default value.
        unit - Time unit for timeout. If null, revert lock timeout to + default value.
        +
        • +
      + + + + + + + +
        +
      • +

        detach

        +
        public void detach()
        +
        Description copied from interface: Transaction
        +
        Detaches this transaction from the current thread. It can be attached + later, and to any thread which currently has no thread-local + transaction. + +

        Detaching a transaction also detaches any parent and nested child + transactions. Attaching any of them achieves the same result as + attaching this transaction.

        +
        +
        Specified by:
        +
        detach in interface Transaction
        +
        +
        • +
      + + + +
        +
      • +

        attach

        +
        public void attach()
        +
        Description copied from interface: Transaction
        +
        Attaches this transaction to the current thread, if it has been + detached. Attaching a transaction also attaches any parent and nested + child transactions.
        +
        +
        Specified by:
        +
        attach in interface Transaction
        +
        +
        • +
      + + + +
        +
      • +

        preCommit

        +
        public boolean preCommit()
+                  throws PersistException
        +
        Description copied from interface: Transaction
        +
        Calling this method commits all nested child transactions, closes all + scoped cursors, and locks out some interactions from other threads. The + commit method must still be called to finish the commit. Most applications + have no use for pre-commit and should only ever call commit. + +

        The intent of this method is to complete as many operations as + possible leading up to the actual commit. If pre-commit succeeds, then + commit will most likely succeed as well. While in a pre-commit state, the + transaction can still be used by the current thread. Calling pre-commit + again ensures that child transactions and cursors are closed.

        +
        +
        Specified by:
        +
        preCommit in interface Transaction
        +
        Returns:
        false if transaction has exited
        +
        Throws:
        +
        PersistException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/txn/TransactionScope.html b/apidocs/com/amazon/carbonado/txn/TransactionScope.html new file mode 100644 index 0000000..20f215b --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/TransactionScope.html @@ -0,0 +1,392 @@ + + + + + + +TransactionScope (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.txn
+

Class TransactionScope<Txn>

+
+
+ +
+
    +
  • +
    Type Parameters:
    Txn - Transaction implementation
    +
    +
    +
    public class TransactionScope<Txn>
+extends java.lang.Object
    +
    Container of thread local, scoped transactions.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    TransactionManager
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidattach() +
      Attach this scope to the current thread, if it has been detached.
      +
      Transactionenter(IsolationLevel level) +
      Enters a new transaction scope which becomes the active transaction.
      +
      TransactionenterTop(IsolationLevel level) +
      Enters a new top-level transaction scope which becomes the active + transaction.
      +
      IsolationLevelgetIsolationLevel() +
      Returns the isolation level of the active transaction, or null if there + is no active transaction.
      +
      java.util.concurrent.locks.LockgetLock() +
      Returns lock used by TransactionScope.
      +
      TxngetTxn() +
      Returns the implementation for the active transaction, or null if there + is no active transaction.
      +
      booleanisForUpdate() +
      Returns true if an active transaction exists and it is for update.
      +
      <S extends Storable> 
      void      		register(java.lang.Class<S> type, + Cursor<S> cursor) +
      Registers the given cursor against the active transaction, allowing it + to be closed on transaction exit or transaction manager close.
      +
      <S extends Storable> 
      void      		unregister(java.lang.Class<S> type, + Cursor<S> cursor) +
      Unregisters a previously registered cursor.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        enter

        +
        public Transaction enter(IsolationLevel level)
        +
        Enters a new transaction scope which becomes the active transaction.
        +
        Parameters:
        level - desired isolation level (may be null)
        +
        Throws:
        +
        java.lang.UnsupportedOperationException - if isolation level higher than + supported by repository
        +
        • +
      + + + +
        +
      • +

        enterTop

        +
        public Transaction enterTop(IsolationLevel level)
        +
        Enters a new top-level transaction scope which becomes the active + transaction.
        +
        Parameters:
        level - desired isolation level (may be null)
        +
        Throws:
        +
        java.lang.UnsupportedOperationException - if isolation level higher than + supported by repository
        +
        • +
      + + + +
        +
      • +

        register

        +
        public <S extends Storable> void register(java.lang.Class<S> type,
+                                 Cursor<S> cursor)
        +
        Registers the given cursor against the active transaction, allowing it + to be closed on transaction exit or transaction manager close. If there + is no active transaction in scope, the cursor is registered as not part + of a transaction. Cursors should register when created.
        +
        • +
      + + + +
        +
      • +

        unregister

        +
        public <S extends Storable> void unregister(java.lang.Class<S> type,
+                                   Cursor<S> cursor)
        +
        Unregisters a previously registered cursor. Cursors should unregister + when closed.
        +
        • +
      + + + +
        +
      • +

        getLock

        +
        public java.util.concurrent.locks.Lock getLock()
        +
        Returns lock used by TransactionScope. While holding lock, operations + are suspended.
        +
        • +
      + + + +
        +
      • +

        getTxn

        +
        public Txn getTxn()
+           throws java.lang.Exception
        +
        Returns the implementation for the active transaction, or null if there + is no active transaction.
        +
        Throws:
        +
        java.lang.Exception - thrown by createTxn or reuseTxn
        +
        • +
      + + + +
        +
      • +

        isForUpdate

        +
        public boolean isForUpdate()
        +
        Returns true if an active transaction exists and it is for update.
        +
        • +
      + + + +
        +
      • +

        getIsolationLevel

        +
        public IsolationLevel getIsolationLevel()
        +
        Returns the isolation level of the active transaction, or null if there + is no active transaction.
        +
        • +
      + + + +
        +
      • +

        attach

        +
        public void attach()
        +
        Attach this scope to the current thread, if it has been detached.
        +
        Throws:
        +
        java.lang.IllegalStateException - if current thread has a different + transaction already attached
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/txn/class-use/TransactionManager.html b/apidocs/com/amazon/carbonado/txn/class-use/TransactionManager.html new file mode 100644 index 0000000..5b68ce4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/class-use/TransactionManager.html @@ -0,0 +1,161 @@ + + + + + + +Uses of Class com.amazon.carbonado.txn.TransactionManager (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.txn.TransactionManager

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/txn/class-use/TransactionMonitor.html b/apidocs/com/amazon/carbonado/txn/class-use/TransactionMonitor.html new file mode 100644 index 0000000..b573164 --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/class-use/TransactionMonitor.html @@ -0,0 +1,157 @@ + + + + + + +Uses of Interface com.amazon.carbonado.txn.TransactionMonitor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.txn.TransactionMonitor

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/txn/class-use/TransactionPair.html b/apidocs/com/amazon/carbonado/txn/class-use/TransactionPair.html new file mode 100644 index 0000000..742eea7 --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/class-use/TransactionPair.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.txn.TransactionPair (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.txn.TransactionPair

+
+
No usage of com.amazon.carbonado.txn.TransactionPair
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/txn/class-use/TransactionScope.html b/apidocs/com/amazon/carbonado/txn/class-use/TransactionScope.html new file mode 100644 index 0000000..65c8f0a --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/class-use/TransactionScope.html @@ -0,0 +1,193 @@ + + + + + + +Uses of Class com.amazon.carbonado.txn.TransactionScope (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.txn.TransactionScope

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/txn/package-frame.html b/apidocs/com/amazon/carbonado/txn/package-frame.html new file mode 100644 index 0000000..afb6b1a --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/package-frame.html @@ -0,0 +1,26 @@ + + + + + + +com.amazon.carbonado.txn (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.txn

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/txn/package-summary.html b/apidocs/com/amazon/carbonado/txn/package-summary.html new file mode 100644 index 0000000..8ffb693 --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/package-summary.html @@ -0,0 +1,175 @@ + + + + + + +com.amazon.carbonado.txn (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.txn

+
+
Provides support for managing transactions.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.txn Description

+
Provides support for managing transactions.
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/txn/package-tree.html b/apidocs/com/amazon/carbonado/txn/package-tree.html new file mode 100644 index 0000000..47040ec --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/package-tree.html @@ -0,0 +1,136 @@ + + + + + + +com.amazon.carbonado.txn Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.txn

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/txn/package-use.html b/apidocs/com/amazon/carbonado/txn/package-use.html new file mode 100644 index 0000000..eaf68b1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/package-use.html @@ -0,0 +1,187 @@ + + + + + + +Uses of Package com.amazon.carbonado.txn (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.txn

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/AbstractPool.html b/apidocs/com/amazon/carbonado/util/AbstractPool.html new file mode 100644 index 0000000..55e0910 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/AbstractPool.html @@ -0,0 +1,348 @@ + + + + + + +AbstractPool (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.util
+

Class AbstractPool<K,V,E extends java.lang.Exception>

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    SequenceValueProducerPool, StoragePool
    +
    +
    +
    +
    public abstract class AbstractPool<K,V,E extends java.lang.Exception>
+extends java.lang.Object
    +
    A concurrent pool of strongly referenced values mapped by key. Values are + lazily created and pooled.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected AbstractPool() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclear() 
      protected abstract Vcreate(K key) +
      Return a new value instance.
      +
      Vget(K key) +
      Returns a value for the given key, which is lazily created and + pooled.
      +
      Vremove(java.lang.Object key) +
      Remove a value, returning the old value.
      +
      java.util.Collection<V>values() +
      Returns the pool values, which may be concurrently modified.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AbstractPool

        +
        protected AbstractPool()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        get

        +
        public V get(K key)
+      throws E extends java.lang.Exception
        +
        Returns a value for the given key, which is lazily created and + pooled. If multiple threads are requesting upon the same key + concurrently, at most one thread attempts to lazily create the + value. The others wait for it to become available.
        +
        Throws:
        +
        E extends java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public V remove(java.lang.Object key)
        +
        Remove a value, returning the old value.
        +
        • +
      + + + +
        +
      • +

        values

        +
        public java.util.Collection<V> values()
        +
        Returns the pool values, which may be concurrently modified.
        +
        • +
      + + + +
        +
      • +

        clear

        +
        public void clear()
        +
        • +
      + + + + + +
        +
      • +

        create

        +
        protected abstract V create(K key)
+                     throws E extends java.lang.Exception
        +
        Return a new value instance.
        +
        Throws:
        +
        E extends java.lang.Exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/AnnotationBuilder.html b/apidocs/com/amazon/carbonado/util/AnnotationBuilder.html new file mode 100644 index 0000000..7f6d3c8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/AnnotationBuilder.html @@ -0,0 +1,934 @@ + + + + + + +AnnotationBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.util
+

Class AnnotationBuilder

+
+
+ +
+
    +
  • +
    +
    +
    public class AnnotationBuilder
+extends AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
    +
    Builds all Annotation properties to a Cojen Annotation definition.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      AnnotationBuilder() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.annotation.Annotation[] value, + org.cojen.classfile.attribute.Annotation ann) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.annotation.Annotation value, + org.cojen.classfile.attribute.Annotation ann) +
      Visits an annotation by breaking it down into its components and calling + various other visit methods.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + boolean[] value, + org.cojen.classfile.attribute.Annotation ann) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + boolean value, + org.cojen.classfile.attribute.Annotation ann) +
      Override to visit booleans.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + byte[] value, + org.cojen.classfile.attribute.Annotation ann) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + byte value, + org.cojen.classfile.attribute.Annotation ann) +
      Override to visit bytes.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + char[] value, + org.cojen.classfile.attribute.Annotation ann) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + char value, + org.cojen.classfile.attribute.Annotation ann) +
      Override to visit chars.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.Class[] value, + org.cojen.classfile.attribute.Annotation ann) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.Class value, + org.cojen.classfile.attribute.Annotation ann) +
      Override to visit Classes.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + double[] value, + org.cojen.classfile.attribute.Annotation ann) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + double value, + org.cojen.classfile.attribute.Annotation ann) +
      Override to visit doubles.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.Enum[] value, + org.cojen.classfile.attribute.Annotation ann) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.Enum value, + org.cojen.classfile.attribute.Annotation ann) +
      Override to visit Enums.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + float[] value, + org.cojen.classfile.attribute.Annotation ann) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + float value, + org.cojen.classfile.attribute.Annotation ann) +
      Override to visit floats.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + int[] value, + org.cojen.classfile.attribute.Annotation ann) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + int value, + org.cojen.classfile.attribute.Annotation ann) +
      Override to visit ints.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + long[] value, + org.cojen.classfile.attribute.Annotation ann) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + long value, + org.cojen.classfile.attribute.Annotation ann) +
      Override to visit longs.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + short[] value, + org.cojen.classfile.attribute.Annotation ann) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + short value, + org.cojen.classfile.attribute.Annotation ann) +
      Override to visit shorts.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.String[] value, + org.cojen.classfile.attribute.Annotation ann) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.String value, + org.cojen.classfile.attribute.Annotation ann) +
      Override to visit Strings.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AnnotationBuilder

        +
        public AnnotationBuilder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.annotation.Annotation value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits an annotation by breaking it down into its components and calling + various other visit methods.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member or not part of an annotation
        pos - position of member in list or array
        value - Annotation visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     int value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit ints.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - int visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     long value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit longs.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - long visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     float value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit floats.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - float visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     double value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit doubles.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - double visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     boolean value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit booleans.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - boolean visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     byte value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit bytes.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - byte visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     short value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit shorts.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - short visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     char value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit chars.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - char visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.String value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit Strings.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - String visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.Class value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit Classes.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - Class visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.Enum value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit Enums.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - Enum visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.annotation.Annotation[] value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - Annotation array visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     int[] value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - int array visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     long[] value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - long array visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     float[] value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - float array visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     double[] value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - double array visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     boolean[] value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - boolean array visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     byte[] value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - byte array visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     short[] value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - short array visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     char[] value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - char array visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.String[] value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - String array visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.Class[] value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - Class array visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.Enum[] value,
+                     org.cojen.classfile.attribute.Annotation ann)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,org.cojen.classfile.attribute.Annotation>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - Enum array visited
        ann - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/AnnotationDescParser.html b/apidocs/com/amazon/carbonado/util/AnnotationDescParser.html new file mode 100644 index 0000000..0b55674 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/AnnotationDescParser.html @@ -0,0 +1,291 @@ + + + + + + +AnnotationDescParser (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.util
+

Class AnnotationDescParser

+
+
+ +
+
    +
  • +
    +
    +
    public class AnnotationDescParser
+extends java.lang.Object
    +
    Parses an annotation descriptor String to a Cojen Annotation definition.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    AnnotationDescPrinter
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      AnnotationDescParser(java.lang.String annotationString) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected org.cojen.classfile.attribute.AnnotationbuildRootAnnotation(org.cojen.classfile.TypeDesc rootAnnotationType) +
      Override this method if a root annotation is not provided, as it must be + built after parsing the root annotation type.
      +
      org.cojen.classfile.attribute.Annotationparse(org.cojen.classfile.attribute.Annotation rootAnnotation) +
      Parses the given annotation, returning the root annotation that received + the results.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AnnotationDescParser

        +
        public AnnotationDescParser(java.lang.String annotationString)
        +
        Parameters:
        annotationString - annotation to parse
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        parse

        +
        public org.cojen.classfile.attribute.Annotation parse(org.cojen.classfile.attribute.Annotation rootAnnotation)
        +
        Parses the given annotation, returning the root annotation that received + the results.
        +
        Parameters:
        rootAnnotation - root annotation
        +
        Returns:
        root annotation
        +
        Throws:
        +
        IllegalArgumentExcecption - if annotation is malformed
        +
        • +
      + + + +
        +
      • +

        buildRootAnnotation

        +
        protected org.cojen.classfile.attribute.Annotation buildRootAnnotation(org.cojen.classfile.TypeDesc rootAnnotationType)
        +
        Override this method if a root annotation is not provided, as it must be + built after parsing the root annotation type. By default, this method + throws UnsupportedOperationException.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/AnnotationDescPrinter.html b/apidocs/com/amazon/carbonado/util/AnnotationDescPrinter.html new file mode 100644 index 0000000..2d8670d --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/AnnotationDescPrinter.html @@ -0,0 +1,988 @@ + + + + + + +AnnotationDescPrinter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.util
+

Class AnnotationDescPrinter

+
+
+ +
+
    +
  • +
    +
    +
    public class AnnotationDescPrinter
+extends AnnotationVisitor<java.lang.Object,java.lang.Object>
    +
    Prints machine readable, self-describing, annotation descriptors.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    AnnotationDescParser
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      AnnotationDescPrinter(boolean sort, + java.lang.StringBuilder b) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static java.lang.StringmakePlainDescriptor(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) +
      Returns an annotation descriptor that has no parameters.
      +
      static java.lang.StringmakePlainDescriptor(java.lang.String annotationType) +
      Returns an annotation descriptor that has no parameters.
      +
      java.lang.Objectvisit(java.lang.annotation.Annotation value) +
      Prints the annotation to the builder passed to the constructor.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.annotation.Annotation[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.annotation.Annotation value, + java.lang.Object param) +
      Visits an annotation by breaking it down into its components and calling + various other visit methods.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + boolean[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + boolean value, + java.lang.Object param) +
      Override to visit booleans.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + byte[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + byte value, + java.lang.Object param) +
      Override to visit bytes.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + char[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + char value, + java.lang.Object param) +
      Override to visit chars.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.Class[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.Class value, + java.lang.Object param) +
      Override to visit Classes.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + double[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + double value, + java.lang.Object param) +
      Override to visit doubles.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.Enum[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.Enum value, + java.lang.Object param) +
      Override to visit Enums.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + float[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + float value, + java.lang.Object param) +
      Override to visit floats.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + int[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + int value, + java.lang.Object param) +
      Override to visit ints.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + long[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + long value, + java.lang.Object param) +
      Override to visit longs.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + short[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + short value, + java.lang.Object param) +
      Override to visit shorts.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.String[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.String value, + java.lang.Object param) +
      Override to visit Strings.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AnnotationDescPrinter

        +
        public AnnotationDescPrinter(boolean sort,
+                     java.lang.StringBuilder b)
        +
        Parameters:
        sort - when true, sort annotation members by name (case sensitive)
        b - StringBuilder to get printed results
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        makePlainDescriptor

        +
        public static java.lang.String makePlainDescriptor(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
        +
        Returns an annotation descriptor that has no parameters.
        +
        • +
      + + + +
        +
      • +

        makePlainDescriptor

        +
        public static java.lang.String makePlainDescriptor(java.lang.String annotationType)
        +
        Returns an annotation descriptor that has no parameters.
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.annotation.Annotation value)
        +
        Prints the annotation to the builder passed to the constructor.
        +
        Parameters:
        value - Annotation to visit
        +
        Returns:
        null
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.annotation.Annotation value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits an annotation by breaking it down into its components and calling + various other visit methods.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member or not part of an annotation
        pos - position of member in list or array
        value - Annotation visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     int value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit ints.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - int visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     long value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit longs.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - long visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     float value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit floats.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - float visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     double value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit doubles.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - double visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     boolean value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit booleans.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - boolean visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     byte value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit bytes.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - byte visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     short value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit shorts.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - short visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     char value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit chars.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - char visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.String value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit Strings.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - String visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.Class value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit Classes.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - Class visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.Enum value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit Enums.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - Enum visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.annotation.Annotation[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - Annotation array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     int[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - int array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     long[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - long array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     float[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - float array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     double[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - double array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     boolean[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - boolean array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     byte[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - byte array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     short[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - short array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     char[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - char array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.String[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - String array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.Class[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - Class array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.Enum[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - Enum array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/AnnotationPrinter.html b/apidocs/com/amazon/carbonado/util/AnnotationPrinter.html new file mode 100644 index 0000000..ac856d3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/AnnotationPrinter.html @@ -0,0 +1,956 @@ + + + + + + +AnnotationPrinter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.util
+

Class AnnotationPrinter

+
+
+ +
+
    +
  • +
    +
    +
    public class AnnotationPrinter
+extends AnnotationVisitor<java.lang.Object,java.lang.Object>
    +
    Prints an Annotation into a parseable format, exactly the same as Java + Annotation syntax.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      AnnotationPrinter(boolean sort, + java.lang.StringBuilder b) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.Objectvisit(java.lang.annotation.Annotation value) +
      Prints the annotation to the builder passed to the constructor.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.annotation.Annotation[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.annotation.Annotation value, + java.lang.Object param) +
      Visits an annotation by breaking it down into its components and calling + various other visit methods.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + boolean[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + boolean value, + java.lang.Object param) +
      Override to visit booleans.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + byte[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + byte value, + java.lang.Object param) +
      Override to visit bytes.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + char[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + char value, + java.lang.Object param) +
      Override to visit chars.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.Class[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.Class value, + java.lang.Object param) +
      Override to visit Classes.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + double[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + double value, + java.lang.Object param) +
      Override to visit doubles.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.Enum[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.Enum value, + java.lang.Object param) +
      Override to visit Enums.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + float[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + float value, + java.lang.Object param) +
      Override to visit floats.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + int[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + int value, + java.lang.Object param) +
      Override to visit ints.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + long[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + long value, + java.lang.Object param) +
      Override to visit longs.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + short[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + short value, + java.lang.Object param) +
      Override to visit shorts.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.String[] value, + java.lang.Object param) +
      Visits each array element.
      +
      java.lang.Objectvisit(java.lang.String name, + int pos, + java.lang.String value, + java.lang.Object param) +
      Override to visit Strings.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AnnotationPrinter

        +
        public AnnotationPrinter(boolean sort,
+                 java.lang.StringBuilder b)
        +
        Parameters:
        sort - when true, sort annotation members by name (case sensitive)
        b - StringBuilder to get printed results
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.annotation.Annotation value)
        +
        Prints the annotation to the builder passed to the constructor.
        +
        Parameters:
        value - Annotation to visit
        +
        Returns:
        null
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.annotation.Annotation value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits an annotation by breaking it down into its components and calling + various other visit methods.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member or not part of an annotation
        pos - position of member in list or array
        value - Annotation visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     int value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit ints.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - int visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     long value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit longs.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - long visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     float value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit floats.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - float visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     double value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit doubles.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - double visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     boolean value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit booleans.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - boolean visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     byte value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit bytes.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - byte visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     short value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit shorts.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - short visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     char value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit chars.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - char visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.String value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit Strings.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - String visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.Class value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit Classes.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - Class visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.Enum value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Override to visit Enums.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - Enum visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.annotation.Annotation[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - Annotation array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     int[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - int array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     long[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - long array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     float[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - float array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     double[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - double array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     boolean[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - boolean array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     byte[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - byte array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     short[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - short array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     char[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - char array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.String[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - String array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.Class[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - Class array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + +
        +
      • +

        visit

        +
        public java.lang.Object visit(java.lang.String name,
+                     int pos,
+                     java.lang.Enum[] value,
+                     java.lang.Object param)
        +
        Description copied from class: AnnotationVisitor
        +
        Visits each array element.
        +
        +
        Overrides:
        +
        visit in class AnnotationVisitor<java.lang.Object,java.lang.Object>
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - Enum array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/AnnotationVisitor.html b/apidocs/com/amazon/carbonado/util/AnnotationVisitor.html new file mode 100644 index 0000000..d50805a --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/AnnotationVisitor.html @@ -0,0 +1,903 @@ + + + + + + +AnnotationVisitor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.util
+

Class AnnotationVisitor<R,P>

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      AnnotationVisitor(boolean sort) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      Rvisit(java.lang.annotation.Annotation value, + P param) +
      Visits an annotation by breaking it down into its components and calling + various other visit methods.
      +
      Rvisit(java.lang.String name, + int pos, + java.lang.annotation.Annotation[] value, + P param) +
      Visits each array element.
      +
      Rvisit(java.lang.String name, + int pos, + java.lang.annotation.Annotation value, + P param) +
      Visits an annotation by breaking it down into its components and calling + various other visit methods.
      +
      Rvisit(java.lang.String name, + int pos, + boolean[] value, + P param) +
      Visits each array element.
      +
      Rvisit(java.lang.String name, + int pos, + boolean value, + P param) +
      Override to visit booleans.
      +
      Rvisit(java.lang.String name, + int pos, + byte[] value, + P param) +
      Visits each array element.
      +
      Rvisit(java.lang.String name, + int pos, + byte value, + P param) +
      Override to visit bytes.
      +
      Rvisit(java.lang.String name, + int pos, + char[] value, + P param) +
      Visits each array element.
      +
      Rvisit(java.lang.String name, + int pos, + char value, + P param) +
      Override to visit chars.
      +
      Rvisit(java.lang.String name, + int pos, + java.lang.Class[] value, + P param) +
      Visits each array element.
      +
      Rvisit(java.lang.String name, + int pos, + java.lang.Class value, + P param) +
      Override to visit Classes.
      +
      Rvisit(java.lang.String name, + int pos, + double[] value, + P param) +
      Visits each array element.
      +
      Rvisit(java.lang.String name, + int pos, + double value, + P param) +
      Override to visit doubles.
      +
      Rvisit(java.lang.String name, + int pos, + java.lang.Enum[] value, + P param) +
      Visits each array element.
      +
      Rvisit(java.lang.String name, + int pos, + java.lang.Enum value, + P param) +
      Override to visit Enums.
      +
      Rvisit(java.lang.String name, + int pos, + float[] value, + P param) +
      Visits each array element.
      +
      Rvisit(java.lang.String name, + int pos, + float value, + P param) +
      Override to visit floats.
      +
      Rvisit(java.lang.String name, + int pos, + int[] value, + P param) +
      Visits each array element.
      +
      Rvisit(java.lang.String name, + int pos, + int value, + P param) +
      Override to visit ints.
      +
      Rvisit(java.lang.String name, + int pos, + long[] value, + P param) +
      Visits each array element.
      +
      Rvisit(java.lang.String name, + int pos, + long value, + P param) +
      Override to visit longs.
      +
      Rvisit(java.lang.String name, + int pos, + short[] value, + P param) +
      Visits each array element.
      +
      Rvisit(java.lang.String name, + int pos, + short value, + P param) +
      Override to visit shorts.
      +
      Rvisit(java.lang.String name, + int pos, + java.lang.String[] value, + P param) +
      Visits each array element.
      +
      Rvisit(java.lang.String name, + int pos, + java.lang.String value, + P param) +
      Override to visit Strings.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AnnotationVisitor

        +
        public AnnotationVisitor(boolean sort)
        +
        Parameters:
        sort - when true, sort annotation members by name (case sensitive)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        visit

        +
        public final R visit(java.lang.annotation.Annotation value,
+      P param)
        +
        Visits an annotation by breaking it down into its components and calling + various other visit methods.
        +
        Parameters:
        value - Initial Annotation to visit
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      java.lang.annotation.Annotation value,
+      P param)
        +
        Visits an annotation by breaking it down into its components and calling + various other visit methods.
        +
        Parameters:
        name - member name, or null if array member or not part of an annotation
        pos - position of member in list or array
        value - Annotation visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      int value,
+      P param)
        +
        Override to visit ints.
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - int visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      long value,
+      P param)
        +
        Override to visit longs.
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - long visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      float value,
+      P param)
        +
        Override to visit floats.
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - float visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      double value,
+      P param)
        +
        Override to visit doubles.
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - double visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      boolean value,
+      P param)
        +
        Override to visit booleans.
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - boolean visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      byte value,
+      P param)
        +
        Override to visit bytes.
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - byte visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      short value,
+      P param)
        +
        Override to visit shorts.
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - short visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      char value,
+      P param)
        +
        Override to visit chars.
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - char visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      java.lang.String value,
+      P param)
        +
        Override to visit Strings.
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - String visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      java.lang.Class value,
+      P param)
        +
        Override to visit Classes.
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - Class visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      java.lang.Enum value,
+      P param)
        +
        Override to visit Enums.
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - Enum visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      java.lang.annotation.Annotation[] value,
+      P param)
        +
        Visits each array element.
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - Annotation array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      int[] value,
+      P param)
        +
        Visits each array element.
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - int array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      long[] value,
+      P param)
        +
        Visits each array element.
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - long array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      float[] value,
+      P param)
        +
        Visits each array element.
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - float array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      double[] value,
+      P param)
        +
        Visits each array element.
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - double array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      boolean[] value,
+      P param)
        +
        Visits each array element.
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - boolean array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      byte[] value,
+      P param)
        +
        Visits each array element.
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - byte array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      short[] value,
+      P param)
        +
        Visits each array element.
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - short array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      char[] value,
+      P param)
        +
        Visits each array element.
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - char array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      java.lang.String[] value,
+      P param)
        +
        Visits each array element.
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - String array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      java.lang.Class[] value,
+      P param)
        +
        Visits each array element.
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - Class array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      + + + + + +
        +
      • +

        visit

        +
        public R visit(java.lang.String name,
+      int pos,
+      java.lang.Enum[] value,
+      P param)
        +
        Visits each array element.
        +
        Parameters:
        name - member name, or null if array member
        pos - position of member in list or array
        value - Enum array visited
        param - custom parameter
        +
        Returns:
        custom result, null by default
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/Appender.html b/apidocs/com/amazon/carbonado/util/Appender.html new file mode 100644 index 0000000..0f233d4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/Appender.html @@ -0,0 +1,228 @@ + + + + + + +Appender (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.util
+

Interface Appender

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidappendTo(java.lang.Appendable appendable) +
      Append the string representation of this object to the given Appendable.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        appendTo

        +
        void appendTo(java.lang.Appendable appendable)
+              throws java.io.IOException
        +
        Append the string representation of this object to the given Appendable.
        +
        Parameters:
        appendable - Appendable object to receive string representation
        +
        Throws:
        +
        java.io.IOException - if thrown from given Appendable
        +
        java.lang.NullPointerException - if appendable is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/BelatedCreationException.html b/apidocs/com/amazon/carbonado/util/BelatedCreationException.html new file mode 100644 index 0000000..b6e8fe2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/BelatedCreationException.html @@ -0,0 +1,289 @@ + + + + + + +BelatedCreationException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.util
+

Class BelatedCreationException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class BelatedCreationException
+extends java.lang.IllegalStateException
    +
    Exception throw when attempting to perform an unavailable operation on an + object undergoing belated creation.
    +
    Author:
    +
    Jesse Morgan (morganjm)
    +
    See Also:
    com.amazon.carbonado.util.BelatedCreator;, +Serialized Form
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      BelatedCreationException(java.lang.String message) +
      Create a new exception with the given message.
      +
      BelatedCreationException(java.lang.String message, + java.lang.Throwable cause) +
      Create a new exception with the given message and cause.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BelatedCreationException

        +
        public BelatedCreationException(java.lang.String message)
        +
        Create a new exception with the given message.
        +
        Parameters:
        message - The exception message.
        +
        • +
      + + + +
        +
      • +

        BelatedCreationException

        +
        public BelatedCreationException(java.lang.String message,
+                        java.lang.Throwable cause)
        +
        Create a new exception with the given message and cause.
        +
        Parameters:
        message - The exception message.
        cause - The cause of the exception.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/BelatedCreator.html b/apidocs/com/amazon/carbonado/util/BelatedCreator.html new file mode 100644 index 0000000..c371327 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/BelatedCreator.html @@ -0,0 +1,371 @@ + + + + + + +BelatedCreator (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.util
+

Class BelatedCreator<T,E extends java.lang.Exception>

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    BelatedRepositoryCreator, BelatedStorageCreator
    +
    +
    +
    +
    public abstract class BelatedCreator<T,E extends java.lang.Exception>
+extends java.lang.Object
    +
    Generic one-shot factory which supports late object creation. If the object + creation results in an exception or is taking too long, the object produced + instead is a bogus one. After retrying, if the real object is created, then + the bogus object turns into a wrapper to the real object. + +

    Note: If a bogus object is created, the wrapper cannot always be a drop-in + replacement for the real object. If the wrapper is cloned, it won't have the + same behavior as cloning the real object. Also, synchronizing on the wrapper + will not synchronize the real object.

    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected BelatedCreator(java.lang.Class<T> type, + int minRetryDelayMillis) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected abstract TcreateBogus() +
      Create instance of bogus object.
      +
      protected voidcreatedNotification(T object) +
      Notification that createReal has produced the real object.
      +
      protected abstract TcreateReal() +
      Create instance of real object.
      +
      Tget(int timeoutMillis) +
      Returns real or bogus object.
      +
      protected abstract voidtimedOutNotification(long timedOutMillis) +
      Notification that createReal is taking too long.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BelatedCreator

        +
        protected BelatedCreator(java.lang.Class<T> type,
+              int minRetryDelayMillis)
        +
        Parameters:
        type - type of object created
        minRetryDelayMillis - minimum milliseconds to wait before retrying + to create object after failure; if negative, never retry
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if type is null or is not an interface
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        get

        +
        public T get(int timeoutMillis)
+      throws E extends java.lang.Exception
        +
        Returns real or bogus object. If real object is returned, then future + invocations of this method return the same real object instance. This + method waits for the real object to be created, if it is blocked. If + real object creation fails immediately, then this method will not wait, + returning a bogus object immediately instead.
        +
        Parameters:
        timeoutMillis - maximum time to wait for real object before + returning bogus one; if negative, potentially wait forever
        +
        Throws:
        +
        E - exception thrown from createReal
        +
        E extends java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        createReal

        +
        protected abstract T createReal()
+                         throws E extends java.lang.Exception
        +
        Create instance of real object. If there is a recoverable error creating + the object, return null. Any error logging must be performed by the + implementation of this method. If null is returned, expect this method + to be called again in the future.
        +
        Returns:
        real object, or null if there was a recoverable error
        +
        Throws:
        +
        E - unrecoverable error
        +
        E extends java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        createBogus

        +
        protected abstract T createBogus()
        +
        Create instance of bogus object.
        +
        • +
      + + + +
        +
      • +

        timedOutNotification

        +
        protected abstract void timedOutNotification(long timedOutMillis)
        +
        Notification that createReal is taking too long. This can be used to log + a message.
        +
        Parameters:
        timedOutMillis - milliseconds waited before giving up
        +
        • +
      + + + + + +
        +
      • +

        createdNotification

        +
        protected void createdNotification(T object)
        +
        Notification that createReal has produced the real object. The default + implementation does nothing.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/Comparators.html b/apidocs/com/amazon/carbonado/util/Comparators.html new file mode 100644 index 0000000..0f5122d --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/Comparators.html @@ -0,0 +1,270 @@ + + + + + + +Comparators (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.util
+

Class Comparators

+
+
+ +
+
    +
  • +
    +
    +
    public class Comparators
+extends java.lang.Object
    +
    Collection of utility comparators.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Comparators() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static <T> java.util.Comparator<T>arrayComparator(java.lang.Class<T> arrayType, + boolean unsigned) +
      Returns a comparator which can sort single or multi-dimensional arrays + of primitves or Comparables.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Comparators

        +
        public Comparators()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        arrayComparator

        +
        public static <T> java.util.Comparator<T> arrayComparator(java.lang.Class<T> arrayType,
+                                          boolean unsigned)
        +
        Returns a comparator which can sort single or multi-dimensional arrays + of primitves or Comparables.
        +
        Parameters:
        unsigned - applicable only to arrays of bytes, shorts, ints, or longs
        +
        Returns:
        null if unsupported
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/ConversionComparator.html b/apidocs/com/amazon/carbonado/util/ConversionComparator.html new file mode 100644 index 0000000..372fa56 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/ConversionComparator.html @@ -0,0 +1,302 @@ + + + + + + +ConversionComparator (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.util
+

Class ConversionComparator

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.util.Comparator<java.lang.Class>
    +
    +
    +
    +
    public class ConversionComparator
+extends java.lang.Object
+implements java.util.Comparator<java.lang.Class>
    +
    Compares type conversions, finding the one that is nearest.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ConversionComparator(java.lang.Class fromType) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      intcompare(java.lang.Class toType_a, + java.lang.Class toType_b) +
      Evaluates two types, to see which one is nearest to the from type.
      +
      booleanisConversionPossible(java.lang.Class toType) +
      Returns true if a coversion is possible to the given type.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.Comparator

        +equals
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConversionComparator

        +
        public ConversionComparator(java.lang.Class fromType)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isConversionPossible

        +
        public boolean isConversionPossible(java.lang.Class toType)
        +
        Returns true if a coversion is possible to the given type.
        +
        • +
      + + + +
        +
      • +

        compare

        +
        public int compare(java.lang.Class toType_a,
+          java.lang.Class toType_b)
        +
        Evaluates two types, to see which one is nearest to the from type. + Return <0 if "a" is nearest, 0 if both are equally good, + >0 if "b" is nearest.
        +
        +
        Specified by:
        +
        compare in interface java.util.Comparator<java.lang.Class>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/Converter.html b/apidocs/com/amazon/carbonado/util/Converter.html new file mode 100644 index 0000000..aeb09ee --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/Converter.html @@ -0,0 +1,453 @@ + + + + + + +Converter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.util
+

Class Converter

+
+
+ +
+
    +
  • +
    +
    +
    public abstract class Converter
+extends java.lang.Object
    +
    General purpose type converter. Custom conversions are possible by supplying + an abstract subclass which has public conversion methods whose names begin + with "convert". Each conversion method takes a single argument and returns a + value.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Converter() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static <C extends Converter> 
      C      		build(java.lang.Class<C> converterType) 
      static <C extends Converter> 
      java.lang.Class<? extends C>      		buildClass(java.lang.Class<C> converterType) 
      protected java.lang.IllegalArgumentExceptionconversionNotSupported(java.lang.Object fromValue, + java.lang.Class fromType, + java.lang.Class toType) 
      abstract <T> Tconvert(boolean from, + java.lang.Class<T> toType) 
      abstract <T> Tconvert(byte from, + java.lang.Class<T> toType) 
      abstract <T> Tconvert(char from, + java.lang.Class<T> toType) 
      abstract <T> Tconvert(double from, + java.lang.Class<T> toType) 
      abstract <T> Tconvert(float from, + java.lang.Class<T> toType) 
      abstract <T> Tconvert(int from, + java.lang.Class<T> toType) 
      abstract <T> Tconvert(long from, + java.lang.Class<T> toType) 
      abstract <T> Tconvert(java.lang.Object from, + java.lang.Class<T> toType) 
      abstract <T> Tconvert(short from, + java.lang.Class<T> toType) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Converter

        +
        public Converter()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        build

        +
        public static <C extends Converter> C build(java.lang.Class<C> converterType)
        +
        Parameters:
        converterType - type of converter to generate
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if converter doesn't a no-arg constructor
        +
        • +
      + + + +
        +
      • +

        buildClass

        +
        public static <C extends Converter> java.lang.Class<? extends C> buildClass(java.lang.Class<C> converterType)
        +
        Parameters:
        converterType - type of converter to generate
        +
        • +
      + + + +
        +
      • +

        convert

        +
        public abstract <T> T convert(java.lang.Object from,
+            java.lang.Class<T> toType)
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if conversion is not supported
        +
        • +
      + + + +
        +
      • +

        convert

        +
        public abstract <T> T convert(byte from,
+            java.lang.Class<T> toType)
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if conversion is not supported
        +
        • +
      + + + +
        +
      • +

        convert

        +
        public abstract <T> T convert(short from,
+            java.lang.Class<T> toType)
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if conversion is not supported
        +
        • +
      + + + +
        +
      • +

        convert

        +
        public abstract <T> T convert(int from,
+            java.lang.Class<T> toType)
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if conversion is not supported
        +
        • +
      + + + +
        +
      • +

        convert

        +
        public abstract <T> T convert(long from,
+            java.lang.Class<T> toType)
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if conversion is not supported
        +
        • +
      + + + +
        +
      • +

        convert

        +
        public abstract <T> T convert(float from,
+            java.lang.Class<T> toType)
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if conversion is not supported
        +
        • +
      + + + +
        +
      • +

        convert

        +
        public abstract <T> T convert(double from,
+            java.lang.Class<T> toType)
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if conversion is not supported
        +
        • +
      + + + +
        +
      • +

        convert

        +
        public abstract <T> T convert(boolean from,
+            java.lang.Class<T> toType)
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if conversion is not supported
        +
        • +
      + + + +
        +
      • +

        convert

        +
        public abstract <T> T convert(char from,
+            java.lang.Class<T> toType)
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if conversion is not supported
        +
        • +
      + + + +
        +
      • +

        conversionNotSupported

        +
        protected java.lang.IllegalArgumentException conversionNotSupported(java.lang.Object fromValue,
+                                                        java.lang.Class fromType,
+                                                        java.lang.Class toType)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/QuickConstructorGenerator.html b/apidocs/com/amazon/carbonado/util/QuickConstructorGenerator.html new file mode 100644 index 0000000..5abe8a7 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/QuickConstructorGenerator.html @@ -0,0 +1,314 @@ + + + + + + +QuickConstructorGenerator (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.util
+

Class QuickConstructorGenerator

+
+
+ +
+
    +
  • +
    +
    Deprecated.  +
    use QuickConstructorGenerator
    +
    +
    +
    @Deprecated
+public class QuickConstructorGenerator
+extends java.lang.Object
    +
    Generates code to invoke constructors. This is a replacement for Constructor which is easier to use and performs + better. In one tested situation, overall performance was improved by about + 10%. + +

    QuickConstructorGenerator is not general purpose however, as the + parameters to the constructor must be known, and the constructor must be + public. It is intended to be used for constructing instances of + auto-generated classes. The exact parameters may be known at compile time, + but the actual object type is not.

    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static <F> FgetInstance(java.lang.Class<?> objectType, + java.lang.Class<F> factory) +
      Deprecated. 
      +
      Returns a factory instance for one type of object.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        QuickConstructorGenerator

        +
        public QuickConstructorGenerator()
        +
        Deprecated. 
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getInstance

        +
        public static <F> F getInstance(java.lang.Class<?> objectType,
+                java.lang.Class<F> factory)
        +
        Deprecated. 
        +
        Returns a factory instance for one type of object. Each method in the + interface defines a constructor via its parameters. Any checked + exceptions declared thrown by the constructor must also be declared by + the method. The method return types can be the same type as the + constructed object or a supertype. + +

        Here is a contrived example for constructing strings. In practice, + such a string factory is is useless, since the "new" operator can be + invoked directly. + + 

        + public interface StringFactory {
+     String newEmptyString();
+
+     String newStringFromChars(char[] chars);
+
+     String newStringFromBytes(byte[] bytes, String charsetName)
+         throws UnsupportedEncodingException;
+ }
+
        + + Here's an example of it being used: + + 
        + StringFactory sf = QuickConstructorGenerator.getInstance(String.class, StringFactory.class);
+ ...
+ String str = sf.newStringFromChars(new char[] {'h', 'e', 'l', 'l', 'o'});
+
        +
        Parameters:
        objectType - type of object to construct
        factory - interface defining which objects can be constructed
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if factory type is not an interface or + if it is malformed
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/SoftValuedCache.html b/apidocs/com/amazon/carbonado/util/SoftValuedCache.html new file mode 100644 index 0000000..387df33 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/SoftValuedCache.html @@ -0,0 +1,478 @@ + + + + + + +SoftValuedCache (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.util
+

Class SoftValuedCache<K,V>

+
+
+ +
+
    +
  • +
    +
    Deprecated.  +
    use Cojen Cache interface
    +
    +
    +
    @Deprecated
+public abstract class SoftValuedCache<K,V>
+extends java.lang.Object
    +
    Simple thread-safe cache which evicts entries via a shared background + thread. Cache permits null keys, but not null values.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      SoftValuedCache() +
      Deprecated. 
      + 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      abstract voidclear() +
      Deprecated. 
      + 
      abstract Vget(K key) +
      Deprecated. 
      + 
      abstract booleanisEmpty() +
      Deprecated. 
      + 
      static <K,V> SoftValuedCache<K,V>newCache(int capacity) +
      Deprecated. 
      + 
      abstract Vput(K key, + V value) +
      Deprecated. 
      + 
      abstract VputIfAbsent(K key, + V value) +
      Deprecated. 
      + 
      abstract Vremove(K key) +
      Deprecated. 
      + 
      abstract booleanremove(K key, + V value) +
      Deprecated. 
      + 
      abstract Vreplace(K key, + V value) +
      Deprecated. 
      + 
      abstract booleanreplace(K key, + V oldValue, + V newValue) +
      Deprecated. 
      + 
      abstract intsize() +
      Deprecated. 
      + 
      abstract java.lang.StringtoString() +
      Deprecated. 
      + 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SoftValuedCache

        +
        public SoftValuedCache()
        +
        Deprecated. 
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        newCache

        +
        public static <K,V> SoftValuedCache<K,V> newCache(int capacity)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        size

        +
        public abstract int size()
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public abstract boolean isEmpty()
        +
        Deprecated. 
        +
        • +
      + + + + + +
        +
      • +

        get

        +
        public abstract V get(K key)
        +
        Deprecated. 
        +
        • +
      + + + + + +
        +
      • +

        put

        +
        public abstract V put(K key,
+    V value)
        +
        Deprecated. 
        +
        • +
      + + + + + +
        +
      • +

        putIfAbsent

        +
        public abstract V putIfAbsent(K key,
+            V value)
        +
        Deprecated. 
        +
        • +
      + + + + + +
        +
      • +

        remove

        +
        public abstract V remove(K key)
        +
        Deprecated. 
        +
        • +
      + + + + + +
        +
      • +

        remove

        +
        public abstract boolean remove(K key,
+             V value)
        +
        Deprecated. 
        +
        • +
      + + + + + +
        +
      • +

        replace

        +
        public abstract boolean replace(K key,
+              V oldValue,
+              V newValue)
        +
        Deprecated. 
        +
        • +
      + + + + + +
        +
      • +

        replace

        +
        public abstract V replace(K key,
+        V value)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        clear

        +
        public abstract void clear()
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public abstract java.lang.String toString()
        +
        Deprecated. 
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/TaskQueueThread.html b/apidocs/com/amazon/carbonado/util/TaskQueueThread.html new file mode 100644 index 0000000..441eb60 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/TaskQueueThread.html @@ -0,0 +1,402 @@ + + + + + + +TaskQueueThread (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.util
+

Class TaskQueueThread

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Runnable, java.util.concurrent.Executor
    +
    +
    +
    +
    public class TaskQueueThread
+extends java.lang.Thread
+implements java.util.concurrent.Executor
    +
    Simple generic queue for running tasks from a single thread. Be sure to call + shutdown or interrupt when done using the thread, or else it will never exit.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class java.lang.Thread

        +java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class java.lang.Thread

        +MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      TaskQueueThread(java.lang.String name, + int queueSize) 
      TaskQueueThread(java.lang.String name, + int queueSize, + long timeoutMillis) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidexecute(java.lang.Runnable task) +
      Enqueue a task to run.
      +
      voidexecute(java.lang.Runnable task, + long timeoutMillis) +
      Enqueue a task to run.
      +
      voidrun() 
      voidshutdown() +
      Indicate that this task queue thread should finish running its enqueued + tasks and then exit.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Thread

        +activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TaskQueueThread

        +
        public TaskQueueThread(java.lang.String name,
+               int queueSize)
        +
        Parameters:
        name - name to give this thread
        queueSize - fixed size of queue
        +
        • +
      + + + +
        +
      • +

        TaskQueueThread

        +
        public TaskQueueThread(java.lang.String name,
+               int queueSize,
+               long timeoutMillis)
        +
        Parameters:
        name - name to give this thread
        queueSize - fixed size of queue
        timeoutMillis - default maximum time to wait for queue to have an available slot
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        execute

        +
        public void execute(java.lang.Runnable task)
+             throws java.util.concurrent.RejectedExecutionException
        +
        Enqueue a task to run.
        +
        +
        Specified by:
        +
        execute in interface java.util.concurrent.Executor
        +
        Parameters:
        task - task to enqueue
        +
        Throws:
        +
        java.util.concurrent.RejectedExecutionException - if wait interrupted, timeout expires, + or shutdown has been called
        +
        • +
      + + + +
        +
      • +

        execute

        +
        public void execute(java.lang.Runnable task,
+           long timeoutMillis)
+             throws java.util.concurrent.RejectedExecutionException
        +
        Enqueue a task to run.
        +
        Parameters:
        task - task to enqueue
        timeoutMillis - maximum time to wait for queue to have an available slot
        +
        Throws:
        +
        java.util.concurrent.RejectedExecutionException - if wait interrupted, timeout expires, + or shutdown has been called
        +
        • +
      + + + +
        +
      • +

        shutdown

        +
        public void shutdown()
        +
        Indicate that this task queue thread should finish running its enqueued + tasks and then exit. Enqueueing new tasks will result in a + RejectedExecutionException being thrown. Join on this thread to wait for + it to exit.
        +
        • +
      + + + +
        +
      • +

        run

        +
        public void run()
        +
        +
        Specified by:
        +
        run in interface java.lang.Runnable
        +
        Overrides:
        +
        run in class java.lang.Thread
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/Throttle.html b/apidocs/com/amazon/carbonado/util/Throttle.html new file mode 100644 index 0000000..92bb111 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/Throttle.html @@ -0,0 +1,300 @@ + + + + + + +Throttle (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.util
+

Class Throttle

+
+
+ +
+
    +
  • +
    +
    +
    public class Throttle
+extends java.lang.Object
    +
    General purpose class for throttling work relative to its actual measured + performance. To throttle a task, call the throttle method each time a unit + of work has been performed. It computes a rolling average for the amount of + time it takes to perform some work, and then it sleeps a calculated amount + of time to throttle back. + +

    Instances are intended for use by one thread, and so they are not + thread-safe.

    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Throttle(int windowSize) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidmain(java.lang.String[] args) +
      Test program which exercises the CPU in an infinite loop, throttled by + the amount given in args[0].
      +
      voidthrottle(double desiredSpeed, + long sleepPrecisionMillis) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Throttle

        +
        public Throttle(int windowSize)
        +
        Parameters:
        windowSize - amount of samples to keep in the rolling average
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        throttle

        +
        public void throttle(double desiredSpeed,
+            long sleepPrecisionMillis)
+              throws java.lang.InterruptedException
        +
        Parameters:
        desiredSpeed - 1.0 = perform work at full speed, + 0.5 = perform work at half speed, 0.0 = fully suspend work
        sleepPrecisionMillis - sleep precision, in milliseconds. Typical + value is 10 to 100 milliseconds.
        +
        Throws:
        +
        java.lang.InterruptedException
        +
        • +
      + + + +
        +
      • +

        main

        +
        public static void main(java.lang.String[] args)
+                 throws java.lang.Exception
        +
        Test program which exercises the CPU in an infinite loop, throttled by + the amount given in args[0]. On a machine performing no other work, the + average CPU load should be about the same as the throttled speed.
        +
        Parameters:
        args - args[0] - desired speed, 0.0 to 1.0
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/ThrowUnchecked.html b/apidocs/com/amazon/carbonado/util/ThrowUnchecked.html new file mode 100644 index 0000000..3eb5816 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/ThrowUnchecked.html @@ -0,0 +1,495 @@ + + + + + + +ThrowUnchecked (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.util
+

Class ThrowUnchecked

+
+
+ +
+
    +
  • +
    +
    Deprecated.  +
    use ThrowUnchecked instead
    +
    +
    +
    public abstract class ThrowUnchecked
+extends java.lang.Object
    +
    Allows exceptions to be thrown which aren't declared to be thrown. Use of + this technique can cause confusion since it violates the Java language rules + for undeclared checked exceptions. For this reason, this class should not be + used except under special circumstances such as to work around compiler + bugs. An exception can be made, if calling any of the fireDeclared methods + and the set of declared types matches what the caller is allowed to throw. + +

    Example: + + 

    + public <E extends Throwable> void someMethod(E exception) throws E {
+     ...
+
+     // Apparent compiler bug sometimes disallows this. Doesn't appear to
+     // show up when compiling source files individually.
+
+     //throw exception;
+
+     // Throw it this way instead, and compiler doesn't know.
+     ThrowUnchecked.fire(exception);
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected ThrowUnchecked() +
      Deprecated. 
      + 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected abstract voiddoFire(java.lang.Throwable t) +
      Deprecated. 
      + 
      static voidfire(java.lang.Throwable t) +
      Deprecated. 
      +
      Throws the given exception, even though it may be checked.
      +
      static voidfireCause(java.lang.Throwable t) +
      Deprecated. 
      +
      Throws the cause of the given exception, even though it may be + checked.
      +
      static voidfireDeclared(java.lang.Throwable t, + java.lang.Class... declaredTypes) +
      Deprecated. 
      +
      Throws the given exception if it is unchecked or an instance of any of + the given declared types.
      +
      static voidfireDeclaredCause(java.lang.Throwable t, + java.lang.Class... declaredTypes) +
      Deprecated. 
      +
      Throws the cause of the given exception if it is unchecked or an + instance of any of the given declared types.
      +
      static voidfireDeclaredRootCause(java.lang.Throwable t, + java.lang.Class... declaredTypes) +
      Deprecated. 
      +
      Throws the root cause of the given exception if it is unchecked or an + instance of any of the given declared types.
      +
      static voidfireFirstDeclared(java.lang.Throwable t, + java.lang.Class... declaredTypes) +
      Deprecated. 
      +
      Throws the either the original exception or the first found cause if it + matches one of the given declared types or is unchecked.
      +
      static voidfireFirstDeclaredCause(java.lang.Throwable t, + java.lang.Class... declaredTypes) +
      Deprecated. 
      +
      Throws the first found cause that matches one of the given declared + types or is unchecked.
      +
      static voidfireRootCause(java.lang.Throwable t) +
      Deprecated. 
      +
      Throws the root cause of the given exception, even though it may be + checked.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ThrowUnchecked

        +
        protected ThrowUnchecked()
        +
        Deprecated. 
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        fire

        +
        public static void fire(java.lang.Throwable t)
        +
        Deprecated. 
        +
        Throws the given exception, even though it may be checked. This method + only returns normally if the exception is null.
        +
        Parameters:
        t - exception to throw
        +
        • +
      + + + +
        +
      • +

        fireDeclared

        +
        public static void fireDeclared(java.lang.Throwable t,
+                java.lang.Class... declaredTypes)
        +
        Deprecated. 
        +
        Throws the given exception if it is unchecked or an instance of any of + the given declared types. Otherwise, it is thrown as an + UndeclaredThrowableException. This method only returns normally if the + exception is null.
        +
        Parameters:
        t - exception to throw
        declaredTypes - if exception is checked and is not an instance of + any of these types, then it is thrown as an + UndeclaredThrowableException.
        +
        • +
      + + + +
        +
      • +

        fireFirstDeclared

        +
        public static void fireFirstDeclared(java.lang.Throwable t,
+                     java.lang.Class... declaredTypes)
        +
        Deprecated. 
        +
        Throws the either the original exception or the first found cause if it + matches one of the given declared types or is unchecked. Otherwise, the + original exception is thrown as an UndeclaredThrowableException. This + method only returns normally if the exception is null.
        +
        Parameters:
        t - exception whose cause is to be thrown
        declaredTypes - if exception is checked and is not an instance of + any of these types, then it is thrown as an + UndeclaredThrowableException.
        +
        • +
      + + + +
        +
      • +

        fireCause

        +
        public static void fireCause(java.lang.Throwable t)
        +
        Deprecated. 
        +
        Throws the cause of the given exception, even though it may be + checked. If the cause is null, then the original exception is + thrown. This method only returns normally if the exception is null.
        +
        Parameters:
        t - exception whose cause is to be thrown
        +
        • +
      + + + +
        +
      • +

        fireDeclaredCause

        +
        public static void fireDeclaredCause(java.lang.Throwable t,
+                     java.lang.Class... declaredTypes)
        +
        Deprecated. 
        +
        Throws the cause of the given exception if it is unchecked or an + instance of any of the given declared types. Otherwise, it is thrown as + an UndeclaredThrowableException. If the cause is null, then the original + exception is thrown. This method only returns normally if the exception + is null.
        +
        Parameters:
        t - exception whose cause is to be thrown
        declaredTypes - if exception is checked and is not an instance of + any of these types, then it is thrown as an + UndeclaredThrowableException.
        +
        • +
      + + + +
        +
      • +

        fireFirstDeclaredCause

        +
        public static void fireFirstDeclaredCause(java.lang.Throwable t,
+                          java.lang.Class... declaredTypes)
        +
        Deprecated. 
        +
        Throws the first found cause that matches one of the given declared + types or is unchecked. Otherwise, the immediate cause is thrown as an + UndeclaredThrowableException. If the immediate cause is null, then the + original exception is thrown. This method only returns normally if the + exception is null.
        +
        Parameters:
        t - exception whose cause is to be thrown
        declaredTypes - if exception is checked and is not an instance of + any of these types, then it is thrown as an + UndeclaredThrowableException.
        +
        • +
      + + + +
        +
      • +

        fireRootCause

        +
        public static void fireRootCause(java.lang.Throwable t)
        +
        Deprecated. 
        +
        Throws the root cause of the given exception, even though it may be + checked. If the root cause is null, then the original exception is + thrown. This method only returns normally if the exception is null.
        +
        Parameters:
        t - exception whose root cause is to be thrown
        +
        • +
      + + + +
        +
      • +

        fireDeclaredRootCause

        +
        public static void fireDeclaredRootCause(java.lang.Throwable t,
+                         java.lang.Class... declaredTypes)
        +
        Deprecated. 
        +
        Throws the root cause of the given exception if it is unchecked or an + instance of any of the given declared types. Otherwise, it is thrown as + an UndeclaredThrowableException. If the root cause is null, then the + original exception is thrown. This method only returns normally if the + exception is null.
        +
        Parameters:
        t - exception whose root cause is to be thrown
        declaredTypes - if exception is checked and is not an instance of + any of these types, then it is thrown as an + UndeclaredThrowableException.
        +
        • +
      + + + +
        +
      • +

        doFire

        +
        protected abstract void doFire(java.lang.Throwable t)
        +
        Deprecated. 
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/class-use/AbstractPool.html b/apidocs/com/amazon/carbonado/util/class-use/AbstractPool.html new file mode 100644 index 0000000..1a7cd9d --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/AbstractPool.html @@ -0,0 +1,190 @@ + + + + + + +Uses of Class com.amazon.carbonado.util.AbstractPool (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.util.AbstractPool

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/class-use/AnnotationBuilder.html b/apidocs/com/amazon/carbonado/util/class-use/AnnotationBuilder.html new file mode 100644 index 0000000..d507751 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/AnnotationBuilder.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.util.AnnotationBuilder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.util.AnnotationBuilder

+
+
No usage of com.amazon.carbonado.util.AnnotationBuilder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/class-use/AnnotationDescParser.html b/apidocs/com/amazon/carbonado/util/class-use/AnnotationDescParser.html new file mode 100644 index 0000000..4d87535 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/AnnotationDescParser.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.util.AnnotationDescParser (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.util.AnnotationDescParser

+
+
No usage of com.amazon.carbonado.util.AnnotationDescParser
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/class-use/AnnotationDescPrinter.html b/apidocs/com/amazon/carbonado/util/class-use/AnnotationDescPrinter.html new file mode 100644 index 0000000..66ef665 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/AnnotationDescPrinter.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.util.AnnotationDescPrinter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.util.AnnotationDescPrinter

+
+
No usage of com.amazon.carbonado.util.AnnotationDescPrinter
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/class-use/AnnotationPrinter.html b/apidocs/com/amazon/carbonado/util/class-use/AnnotationPrinter.html new file mode 100644 index 0000000..73c334b --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/AnnotationPrinter.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.util.AnnotationPrinter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.util.AnnotationPrinter

+
+
No usage of com.amazon.carbonado.util.AnnotationPrinter
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/class-use/AnnotationVisitor.html b/apidocs/com/amazon/carbonado/util/class-use/AnnotationVisitor.html new file mode 100644 index 0000000..8adcce4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/AnnotationVisitor.html @@ -0,0 +1,175 @@ + + + + + + +Uses of Class com.amazon.carbonado.util.AnnotationVisitor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.util.AnnotationVisitor

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/class-use/Appender.html b/apidocs/com/amazon/carbonado/util/class-use/Appender.html new file mode 100644 index 0000000..652c5b6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/Appender.html @@ -0,0 +1,335 @@ + + + + + + +Uses of Interface com.amazon.carbonado.util.Appender (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.util.Appender

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/class-use/BelatedCreationException.html b/apidocs/com/amazon/carbonado/util/class-use/BelatedCreationException.html new file mode 100644 index 0000000..12ec4f2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/BelatedCreationException.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.util.BelatedCreationException (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.util.BelatedCreationException

+
+
No usage of com.amazon.carbonado.util.BelatedCreationException
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/class-use/BelatedCreator.html b/apidocs/com/amazon/carbonado/util/class-use/BelatedCreator.html new file mode 100644 index 0000000..92b0622 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/BelatedCreator.html @@ -0,0 +1,167 @@ + + + + + + +Uses of Class com.amazon.carbonado.util.BelatedCreator (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.util.BelatedCreator

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/class-use/Comparators.html b/apidocs/com/amazon/carbonado/util/class-use/Comparators.html new file mode 100644 index 0000000..c062f60 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/Comparators.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.util.Comparators (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.util.Comparators

+
+
No usage of com.amazon.carbonado.util.Comparators
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/class-use/ConversionComparator.html b/apidocs/com/amazon/carbonado/util/class-use/ConversionComparator.html new file mode 100644 index 0000000..bc5b448 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/ConversionComparator.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.util.ConversionComparator (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.util.ConversionComparator

+
+
No usage of com.amazon.carbonado.util.ConversionComparator
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/class-use/Converter.html b/apidocs/com/amazon/carbonado/util/class-use/Converter.html new file mode 100644 index 0000000..4a1d4be --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/Converter.html @@ -0,0 +1,164 @@ + + + + + + +Uses of Class com.amazon.carbonado.util.Converter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.util.Converter

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/class-use/QuickConstructorGenerator.html b/apidocs/com/amazon/carbonado/util/class-use/QuickConstructorGenerator.html new file mode 100644 index 0000000..c88bd26 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/QuickConstructorGenerator.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.util.QuickConstructorGenerator (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.util.QuickConstructorGenerator

+
+
No usage of com.amazon.carbonado.util.QuickConstructorGenerator
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/class-use/SoftValuedCache.html b/apidocs/com/amazon/carbonado/util/class-use/SoftValuedCache.html new file mode 100644 index 0000000..18f9056 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/SoftValuedCache.html @@ -0,0 +1,162 @@ + + + + + + +Uses of Class com.amazon.carbonado.util.SoftValuedCache (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.util.SoftValuedCache

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/class-use/TaskQueueThread.html b/apidocs/com/amazon/carbonado/util/class-use/TaskQueueThread.html new file mode 100644 index 0000000..1fc234e --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/TaskQueueThread.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.util.TaskQueueThread (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.util.TaskQueueThread

+
+
No usage of com.amazon.carbonado.util.TaskQueueThread
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/class-use/Throttle.html b/apidocs/com/amazon/carbonado/util/class-use/Throttle.html new file mode 100644 index 0000000..d5f0ce3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/Throttle.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.util.Throttle (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.util.Throttle

+
+
No usage of com.amazon.carbonado.util.Throttle
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/class-use/ThrowUnchecked.html b/apidocs/com/amazon/carbonado/util/class-use/ThrowUnchecked.html new file mode 100644 index 0000000..4c3b7de --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/ThrowUnchecked.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.util.ThrowUnchecked (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.util.ThrowUnchecked

+
+
No usage of com.amazon.carbonado.util.ThrowUnchecked
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/package-frame.html b/apidocs/com/amazon/carbonado/util/package-frame.html new file mode 100644 index 0000000..21b714e --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/package-frame.html @@ -0,0 +1,42 @@ + + + + + + +com.amazon.carbonado.util (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.util

+
+

Interfaces

+ +

Classes

+ +

Exceptions

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/util/package-summary.html b/apidocs/com/amazon/carbonado/util/package-summary.html new file mode 100644 index 0000000..8a6e5fa --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/package-summary.html @@ -0,0 +1,270 @@ + + + + + + +com.amazon.carbonado.util (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.util

+
+
Utilities used by Carbonado but which have no dependencies on + Carbonado.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.util Description

+
Utilities used by Carbonado but which have no dependencies on + Carbonado. These utilities are candidates for moving into another project.
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/package-tree.html b/apidocs/com/amazon/carbonado/util/package-tree.html new file mode 100644 index 0000000..e907ddf --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/package-tree.html @@ -0,0 +1,172 @@ + + + + + + +com.amazon.carbonado.util Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.util

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/util/package-use.html b/apidocs/com/amazon/carbonado/util/package-use.html new file mode 100644 index 0000000..1deec12 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/package-use.html @@ -0,0 +1,316 @@ + + + + + + +Uses of Package com.amazon.carbonado.util (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.util

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/constant-values.html b/apidocs/constant-values.html new file mode 100644 index 0000000..11ebc2d --- /dev/null +++ b/apidocs/constant-values.html @@ -0,0 +1,814 @@ + + + + + + +Constant Field Values (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Constant Field Values

+

Contents

+ +
+
+ + +

com.amazon.*

+ + + + + +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/deprecated-list.html b/apidocs/deprecated-list.html new file mode 100644 index 0000000..f9766c5 --- /dev/null +++ b/apidocs/deprecated-list.html @@ -0,0 +1,218 @@ + + + + + + +Deprecated List (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Deprecated API

+

Contents

+ +
+
+ + + + + + + + + + + +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/help-doc.html b/apidocs/help-doc.html new file mode 100644 index 0000000..1ac2d20 --- /dev/null +++ b/apidocs/help-doc.html @@ -0,0 +1,222 @@ + + + + + + +API Help (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+ +This help file applies to API documentation generated using the standard doclet.
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/index-files/index-1.html b/apidocs/index-files/index-1.html new file mode 100644 index 0000000..d90d52c --- /dev/null +++ b/apidocs/index-files/index-1.html @@ -0,0 +1,949 @@ + + + + + + +A-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  + + +

A

+
+
abortTry() - Method in class com.amazon.carbonado.Trigger
+
+
Call to quickly abort a "try" operation, returning false to the + caller.
+
+
abortTxn(Txn) - Method in class com.amazon.carbonado.txn.TransactionManager
+
+
Aborts and closes the given internal transaction.
+
+
AbstractBlob - Class in com.amazon.carbonado.lob
+
+
AbstractBlob implements a small set of common Blob methods.
+
+
AbstractBlob() - Constructor for class com.amazon.carbonado.lob.AbstractBlob
+
 
+
AbstractBlob(Repository) - Constructor for class com.amazon.carbonado.lob.AbstractBlob
+
+
Use of this constructor indicates that setValue should operate within a + transaction.
+
+
AbstractClob - Class in com.amazon.carbonado.lob
+
+
AbstractClob implements a small set of common Clob methods.
+
+
AbstractClob() - Constructor for class com.amazon.carbonado.lob.AbstractClob
+
 
+
AbstractClob(Repository) - Constructor for class com.amazon.carbonado.lob.AbstractClob
+
+
Use of this constructor indicates that setValue should operate within a + transaction.
+
+
AbstractCursor<S> - Class in com.amazon.carbonado.cursor
+
+
AbstractCursor implements a small set of common Cursor methods.
+
+
AbstractCursor() - Constructor for class com.amazon.carbonado.cursor.AbstractCursor
+
 
+
AbstractPool<K,V,E extends java.lang.Exception> - Class in com.amazon.carbonado.util
+
+
A concurrent pool of strongly referenced values mapped by key.
+
+
AbstractPool() - Constructor for class com.amazon.carbonado.util.AbstractPool
+
 
+
AbstractQuery<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
AbstractQuery implements a small set of common Query methods.
+
+
AbstractQuery() - Constructor for class com.amazon.carbonado.qe.AbstractQuery
+
 
+
AbstractQueryExecutor<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
AbstractQueryExecutor implements a small set of common QueryExecutor methods.
+
+
AbstractQueryExecutor() - Constructor for class com.amazon.carbonado.qe.AbstractQueryExecutor
+
 
+
AbstractRepository<Txn> - Class in com.amazon.carbonado.spi
+
+
Implements basic functionality required by a core Repository.
+
+
AbstractRepository(String) - Constructor for class com.amazon.carbonado.spi.AbstractRepository
+
 
+
AbstractRepositoryBuilder - Class in com.amazon.carbonado.spi
+
+
Abstract builder class for opening repositories.
+
+
AbstractRepositoryBuilder() - Constructor for class com.amazon.carbonado.spi.AbstractRepositoryBuilder
+
 
+
AbstractSequenceValueProducer - Class in com.amazon.carbonado.sequence
+
 
+
AbstractSequenceValueProducer() - Constructor for class com.amazon.carbonado.sequence.AbstractSequenceValueProducer
+
 
+
accept(Visitor<S, R, P>, P) - Method in class com.amazon.carbonado.filter.AndFilter
+
 
+
accept(Visitor<S, R, P>, P) - Method in class com.amazon.carbonado.filter.ClosedFilter
+
 
+
accept(Visitor<S, R, P>, P) - Method in class com.amazon.carbonado.filter.ExistsFilter
+
 
+
accept(Visitor<S, R, P>, P) - Method in class com.amazon.carbonado.filter.Filter
+
+
Accept the given visitor subclass to traverse the filter tree.
+
+
accept(Visitor<S, R, P>, P) - Method in class com.amazon.carbonado.filter.OpenFilter
+
 
+
accept(Visitor<S, R, P>, P) - Method in class com.amazon.carbonado.filter.OrFilter
+
 
+
accept(Visitor<S, R, P>, P) - Method in class com.amazon.carbonado.filter.PropertyFilter
+
 
+
ADAPTER_FIELD_ELEMENT - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Adapter field names are propertyName + "$adapter$" + number
+
+
AdapterDefinition - Annotation Type in com.amazon.carbonado.adapter
+
+
Allows annotations to be defined for supporting property types which are not + natively supported by the underlying storage layer.
+
+
adaptToBlob(String) - Method in class com.amazon.carbonado.adapter.TextAdapter.Adapter
+
 
+
adaptToBoolean(char) - Method in class com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter
+
+
Adapts a character 'T' or 'F' to true or false.
+
+
adaptToBoolean(Character) - Method in class com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter
+
+
Adapts a character 'T' or 'F' to true or false.
+
+
adaptToBoolean(String) - Method in class com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter
+
+
Adapts a character "T" or "F" to true or false.
+
+
adaptToBoolean(char) - Method in class com.amazon.carbonado.adapter.YesNoAdapter.Adapter
+
+
Adapts a character 'Y' or 'N' to true or false.
+
+
adaptToBoolean(Character) - Method in class com.amazon.carbonado.adapter.YesNoAdapter.Adapter
+
+
Adapts a character 'Y' or 'N' to true or false.
+
+
adaptToBoolean(String) - Method in class com.amazon.carbonado.adapter.YesNoAdapter.Adapter
+
+
Adapts a character "Y" or "N" to true or false.
+
+
adaptToBooleanArray(byte[]) - Method in class com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter
+
+
Unpacks a boolean array from a byte array, big-endian fashion.
+
+
adaptToBooleanObj(char) - Method in class com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter
+
+
Adapts a character 'T' or 'F' to true or false.
+
+
adaptToBooleanObj(Character) - Method in class com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter
+
+
Adapts a character 'T' or 'F' to true or false.
+
+
adaptToBooleanObj(String) - Method in class com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter
+
+
Adapts a character "T" or "F" to true or false.
+
+
adaptToBooleanObj(char) - Method in class com.amazon.carbonado.adapter.YesNoAdapter.Adapter
+
+
Adapts a character 'Y' or 'N' to true or false.
+
+
adaptToBooleanObj(Character) - Method in class com.amazon.carbonado.adapter.YesNoAdapter.Adapter
+
+
Adapts a character 'Y' or 'N' to true or false.
+
+
adaptToBooleanObj(String) - Method in class com.amazon.carbonado.adapter.YesNoAdapter.Adapter
+
+
Adapts a character "Y" or "N" to true or false.
+
+
adaptToByteArray(short[]) - Method in class com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter
+
 
+
adaptToByteArray(char[]) - Method in class com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter
+
 
+
adaptToByteArray(int[]) - Method in class com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter
+
 
+
adaptToByteArray(long[]) - Method in class com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter
+
 
+
adaptToByteArray(float[]) - Method in class com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter
+
 
+
adaptToByteArray(double[]) - Method in class com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter
+
 
+
adaptToByteArray(boolean[]) - Method in class com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter
+
+
Packs the given boolean array into a byte array, big-endian fashion.
+
+
adaptToChar(boolean) - Method in class com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter
+
+
Adapts a boolean true or false into 'T' or 'F'.
+
+
adaptToChar(Boolean) - Method in class com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter
+
+
Adapts a boolean true into 'T', and anything else to 'F'.
+
+
adaptToChar(boolean) - Method in class com.amazon.carbonado.adapter.YesNoAdapter.Adapter
+
+
Adapts a boolean true or false into 'Y' or 'N'.
+
+
adaptToChar(Boolean) - Method in class com.amazon.carbonado.adapter.YesNoAdapter.Adapter
+
+
Adapts a boolean true into 'Y', and anything else to 'N'.
+
+
adaptToCharacter(boolean) - Method in class com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter
+
+
Adapts a boolean true or false into 'T' or 'F'.
+
+
adaptToCharacter(Boolean) - Method in class com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter
+
+
Adapts a boolean true into 'T', and anything else to 'F'.
+
+
adaptToCharacter(boolean) - Method in class com.amazon.carbonado.adapter.YesNoAdapter.Adapter
+
+
Adapts a boolean true or false into 'Y' or 'N'.
+
+
adaptToCharacter(Boolean) - Method in class com.amazon.carbonado.adapter.YesNoAdapter.Adapter
+
+
Adapts a boolean true into 'Y', and anything else to 'N'.
+
+
adaptToCharArray(byte[]) - Method in class com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter
+
 
+
adaptToClob(String) - Method in class com.amazon.carbonado.adapter.TextAdapter.Adapter
+
 
+
adaptToDate(ReadableInstant) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToDate(LocalDateTime) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToDate(LocalDate) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToDate(long) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToDate(Long) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToDate(String) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToDate(Date) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToDate(Time) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToDate(Timestamp) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToDateMidnight(long) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToDateMidnight(Long) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToDateMidnight(String) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToDateMidnight(Date) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToDateMidnight(Date) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToDateMidnight(Time) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToDateMidnight(Timestamp) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToDateTime(long) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToDateTime(Long) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToDateTime(String) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToDateTime(Date) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToDateTime(Date) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToDateTime(Time) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToDateTime(Timestamp) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToDoubleArray(byte[]) - Method in class com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter
+
 
+
adaptToFloatArray(byte[]) - Method in class com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter
+
 
+
adaptToIntArray(byte[]) - Method in class com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter
+
 
+
adaptToLocalDate(long) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToLocalDate(Long) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToLocalDate(String) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToLocalDate(Date) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToLocalDate(Date) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToLocalDate(Time) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToLocalDate(Timestamp) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToLocalDateTime(long) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToLocalDateTime(Long) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToLocalDateTime(String) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToLocalDateTime(Date) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToLocalDateTime(Date) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToLocalDateTime(Time) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToLocalDateTime(Timestamp) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToLong(ReadableInstant) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToLong(LocalDateTime) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToLong(LocalDate) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToLong(Date) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToLongArray(byte[]) - Method in class com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter
+
 
+
adaptToLongObj(ReadableInstant) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToLongObj(LocalDateTime) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToLongObj(LocalDate) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToLongObj(Date) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToShortArray(byte[]) - Method in class com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter
+
 
+
adaptToSqlDate(ReadableInstant) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToSqlDate(LocalDateTime) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToSqlDate(LocalDate) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToSqlDate(Date) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToSqlTime(ReadableInstant) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToSqlTime(LocalDateTime) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToSqlTime(Date) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToSqlTimestamp(ReadableInstant) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToSqlTimestamp(LocalDateTime) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToSqlTimestamp(LocalDate) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToSqlTimestamp(Date) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToString(ReadableInstant) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToString(LocalDateTime) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToString(LocalDate) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToString(Date) - Method in class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
adaptToString(Clob) - Method in class com.amazon.carbonado.adapter.TextAdapter.Adapter
+
 
+
adaptToString(Blob) - Method in class com.amazon.carbonado.adapter.TextAdapter.Adapter
+
 
+
adaptToString(boolean) - Method in class com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter
+
+
Adapts a boolean true or false into "T" or "F".
+
+
adaptToString(Boolean) - Method in class com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter
+
+
Adapts a boolean true into "T", and anything else to "F".
+
+
adaptToString(boolean) - Method in class com.amazon.carbonado.adapter.YesNoAdapter.Adapter
+
+
Adapts a boolean true or false into "Y" or "N".
+
+
adaptToString(Boolean) - Method in class com.amazon.carbonado.adapter.YesNoAdapter.Adapter
+
+
Adapts a boolean true into "Y", and anything else to "N".
+
+
add(S) - Method in class com.amazon.carbonado.cursor.MergeSortBuffer
+
 
+
addAccessorAnnotationDescriptor(String) - Method in class com.amazon.carbonado.synthetic.SyntheticProperty
+
+
Add an arbitrary annotation to the property accessor method, as + specified by a descriptor.
+
+
addAlternateKey() - Method in interface com.amazon.carbonado.synthetic.SyntheticBuilder
+
+
Add an alternate key to be built.
+
+
addAlternateKey() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableBuilder
+
 
+
addAlternateKey() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder
+
 
+
addAlternateKeys(StorableInfo<S>) - Method in class com.amazon.carbonado.qe.StorableIndexSet
+
+
Adds all of the alternate keys of the given storable as indexes by + calling addKey.
+
+
addEqualsCall(CodeBuilder, String, TypeDesc, boolean, Label, LocalVariable) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Generates code to compare a field in this object against the same one in a + different instance.
+
+
addIndex() - Method in interface com.amazon.carbonado.synthetic.SyntheticBuilder
+
+
Add an index to the set managed by this builder.
+
+
addIndex() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableBuilder
+
 
+
addIndex() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder
+
 
+
addIndexes(StorableInfo<S>) - Method in class com.amazon.carbonado.qe.StorableIndexSet
+
+
Adds all the indexes of the given storable.
+
+
addIndexes(StorableInfo<S>, Direction) - Method in class com.amazon.carbonado.qe.StorableIndexSet
+
+
Adds all the indexes of the given storable.
+
+
addInvokeReadMethod(CodeAssembler) - Method in class com.amazon.carbonado.raw.StorablePropertyInfo
+
 
+
addInvokeReadMethod(CodeAssembler, TypeDesc) - Method in class com.amazon.carbonado.raw.StorablePropertyInfo
+
 
+
addInvokeWriteMethod(CodeAssembler) - Method in class com.amazon.carbonado.raw.StorablePropertyInfo
+
 
+
addInvokeWriteMethod(CodeAssembler, TypeDesc) - Method in class com.amazon.carbonado.raw.StorablePropertyInfo
+
 
+
addKey(StorableKey<S>) - Method in class com.amazon.carbonado.qe.StorableIndexSet
+
+
Adds the key as a unique index, preserving the property arrangement.
+
+
addKeyProperty(String, Direction) - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder
+
+
Add a property to the primary key which is a member of the Storable type + being referenced by this one.
+
+
addPrimaryKey(StorableInfo<S>) - Method in class com.amazon.carbonado.qe.StorableIndexSet
+
+
Adds the primary key of the given storable as indexes by calling addKey.
+
+
addPrimaryKey() - Method in interface com.amazon.carbonado.synthetic.SyntheticBuilder
+
+
Add a primary key to be built.
+
+
addPrimaryKey() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableBuilder
+
 
+
addPrimaryKey() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder
+
 
+
addProperty(StorableProperty<S>, Direction) - Method in class com.amazon.carbonado.info.StorableIndex
+
+
Returns a StorableIndex with the given property added.
+
+
addProperty(String, Class) - Method in interface com.amazon.carbonado.synthetic.SyntheticBuilder
+
+
Add a property to the set managed by this builder.
+
+
addProperty(SyntheticProperty) - Method in interface com.amazon.carbonado.synthetic.SyntheticBuilder
+
+
Add an externally defined synthetic property to the list
+
+
addProperty(String) - Method in class com.amazon.carbonado.synthetic.SyntheticPropertyList
+
+
Adds a property to this index, with an unspecified direction.
+
+
addProperty(String, Direction) - Method in class com.amazon.carbonado.synthetic.SyntheticPropertyList
+
+
Adds a property to this index, with the specified direction.
+
+
addProperty(String, Class) - Method in class com.amazon.carbonado.synthetic.SyntheticStorableBuilder
+
 
+
addProperty(SyntheticProperty) - Method in class com.amazon.carbonado.synthetic.SyntheticStorableBuilder
+
 
+
addProperty(String, Class) - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder
+
 
+
addProperty(SyntheticProperty) - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder
+
 
+
addToGroup(S) - Method in class com.amazon.carbonado.cursor.GroupedCursor
+
+
This method is called when more entries are found for the current + group.
+
+
addTrigger(Trigger<? super S>) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
addTrigger(Trigger<? super S>) - Method in interface com.amazon.carbonado.Storage
+
+
Register a trigger which will be called for overridden methods in the given + trigger implementation.
+
+
addTriggerFactory(TriggerFactory) - Method in interface com.amazon.carbonado.RepositoryBuilder
+
+
Optionally add a TriggerFactory which will be called upon to create an + initial trigger for each Storable type that the Repository supports.
+
+
addTriggerFactory(TriggerFactory) - Method in class com.amazon.carbonado.spi.AbstractRepositoryBuilder
+
 
+
addTriggers(Class<S>, Iterable<TriggerFactory>) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
addValueHashCodeCall(CodeBuilder, TypeDesc, boolean, boolean) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Generates code to compute a hashcode for a value on the stack, consuming + the value.
+
+
addValuesEqualCall(CodeBuilder, TypeDesc, boolean, Label, boolean) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Generates code to compare two values on the stack, and branch to the + provided Label if they are not equal.
+
+
after(T) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
 
+
after(T) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
after(T) - Method in interface com.amazon.carbonado.Query
+
+
Returns a query which fetches results for this query after a given + starting point, which is useful for re-opening a cursor.
+
+
afterDelete(S, Object) - Method in class com.amazon.carbonado.capability.ResyncCapability.Listener
+
+
Called right after a bogus storable has been successfully deleted.
+
+
afterDelete(S, Object) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
afterDelete(S, Object) - Method in class com.amazon.carbonado.Trigger
+
+
Called right after a storable has been successfully deleted.
+
+
afterInsert(S, Object) - Method in class com.amazon.carbonado.capability.ResyncCapability.Listener
+
+
Called right after a sync'd storable has been successfully inserted.
+
+
afterInsert(S, Object) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
afterInsert(S, Object) - Method in class com.amazon.carbonado.Trigger
+
+
Called right after a storable has been successfully inserted.
+
+
afterLoad(S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
afterLoad(S) - Method in class com.amazon.carbonado.Trigger
+
+
Called right after a storable has been successfully loaded or + fetched.
+
+
afterTryDelete(S, Object) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
afterTryDelete(S, Object) - Method in class com.amazon.carbonado.Trigger
+
+
Called right after a storable has been successfully deleted via + tryDelete.
+
+
afterTryInsert(S, Object) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
afterTryInsert(S, Object) - Method in class com.amazon.carbonado.Trigger
+
+
Called right after a storable has been successfully inserted via + tryInsert.
+
+
afterTryUpdate(S, Object) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
afterTryUpdate(S, Object) - Method in class com.amazon.carbonado.Trigger
+
+
Called right after a storable has been successfully updated via + tryUpdate.
+
+
afterUpdate(S, Object) - Method in class com.amazon.carbonado.capability.ResyncCapability.Listener
+
+
Called right after a sync'd storable has been successfully updated.
+
+
afterUpdate(S, Object) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
afterUpdate(S, Object) - Method in class com.amazon.carbonado.Trigger
+
+
Called right after a storable has been successfully updated.
+
+
Alias - Annotation Type in com.amazon.carbonado
+
+
Identifies alternate names for a Storable or a Storable property.
+
+
allStorage() - Method in class com.amazon.carbonado.spi.AbstractRepository
+
+
Returns all available Storage instances.
+
+
AlternateKeys - Annotation Type in com.amazon.carbonado
+
+
List of alternate keys for a Storable.
+
+
analyze(Filter<S>, OrderingList<S>, QueryHints) - Method in class com.amazon.carbonado.qe.IndexedQueryAnalyzer
+
 
+
analyze(Filter<S>, OrderingList<S>, QueryHints) - Method in class com.amazon.carbonado.qe.UnionQueryAnalyzer
+
 
+
and(Filter<S>) - Method in class com.amazon.carbonado.filter.ClosedFilter
+
 
+
and(String) - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.
+
+
and(Filter<S>) - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.
+
+
and(String, RelOp) - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.
+
+
and(String, RelOp, Object) - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.
+
+
and(Filter<S>) - Method in class com.amazon.carbonado.filter.OpenFilter
+
 
+
and(String) - Method in class com.amazon.carbonado.qe.AbstractQuery
+
 
+
and(Filter<S>) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always throws an IllegalStateException.
+
+
and(Filter<S>) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
and(String) - Method in interface com.amazon.carbonado.Query
+
+
Returns a new query which has another filter logically "and"ed to this, potentially reducing the amount of + results.
+
+
and(Filter<S>) - Method in interface com.amazon.carbonado.Query
+
+
Returns a new query which has another filter logically "and"ed to this, potentially reducing the amount of + results.
+
+
AND_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Query API method name
+
+
andExists(String, Filter<?>) - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns a combined filter instance that accepts records which are only + accepted by this filter and the "exists" test applied to a join.
+
+
AndFilter<S extends Storable> - Class in com.amazon.carbonado.filter
+
+
Filter tree node that performs a logical 'and' test.
+
+
andNotExists(String, Filter<?>) - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns a combined filter instance that accepts records which are only + accepted by this filter and the "not exists" test applied to a join.
+
+
AnnotationBuilder - Class in com.amazon.carbonado.util
+
+
Builds all Annotation properties to a Cojen Annotation definition.
+
+
AnnotationBuilder() - Constructor for class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
AnnotationDescParser - Class in com.amazon.carbonado.util
+
+
Parses an annotation descriptor String to a Cojen Annotation definition.
+
+
AnnotationDescParser(String) - Constructor for class com.amazon.carbonado.util.AnnotationDescParser
+
 
+
AnnotationDescPrinter - Class in com.amazon.carbonado.util
+
+
Prints machine readable, self-describing, annotation descriptors.
+
+
AnnotationDescPrinter(boolean, StringBuilder) - Constructor for class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
AnnotationPrinter - Class in com.amazon.carbonado.util
+
+
Prints an Annotation into a parseable format, exactly the same as Java + Annotation syntax.
+
+
AnnotationPrinter(boolean, StringBuilder) - Constructor for class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
AnnotationVisitor<R,P> - Class in com.amazon.carbonado.util
+
+
Generic annotation visitor.
+
+
AnnotationVisitor(boolean) - Constructor for class com.amazon.carbonado.util.AnnotationVisitor
+
 
+
append(StorableProperty<?>) - Method in class com.amazon.carbonado.info.ChainedProperty
+
+
Returns a new ChainedProperty with another property appended.
+
+
append(StorableProperty<?>, boolean) - Method in class com.amazon.carbonado.info.ChainedProperty
+
+
Returns a new ChainedProperty with another property appended.
+
+
append(ChainedProperty<?>) - Method in class com.amazon.carbonado.info.ChainedProperty
+
+
Returns a new ChainedProperty with another property appended.
+
+
Appender - Interface in com.amazon.carbonado.util
+
+
Interface that supports an alternate way of providing a string representation + for an object.
+
+
appendTo(Appendable, FilterValues<S>) - Method in class com.amazon.carbonado.filter.AndFilter
+
 
+
appendTo(Appendable, FilterValues<S>) - Method in class com.amazon.carbonado.filter.ClosedFilter
+
 
+
appendTo(Appendable, FilterValues<S>) - Method in class com.amazon.carbonado.filter.ExistsFilter
+
 
+
appendTo(Appendable) - Method in class com.amazon.carbonado.filter.Filter
+
+
Appends the string value of this filter into the given Appendable.
+
+
appendTo(Appendable, FilterValues<S>) - Method in class com.amazon.carbonado.filter.Filter
+
+
Appends the string value of this filter into the given Appendable.
+
+
appendTo(Appendable) - Method in class com.amazon.carbonado.filter.FilterValues
+
 
+
appendTo(Appendable, FilterValues<S>) - Method in class com.amazon.carbonado.filter.OpenFilter
+
 
+
appendTo(Appendable, FilterValues<S>) - Method in class com.amazon.carbonado.filter.OrFilter
+
 
+
appendTo(Appendable, FilterValues<S>) - Method in class com.amazon.carbonado.filter.PropertyFilter
+
 
+
appendTo(Appendable) - Method in class com.amazon.carbonado.info.ChainedProperty
+
+
Appends the chained property formatted as "name.subname.subsubname".
+
+
appendTo(Appendable) - Method in class com.amazon.carbonado.info.OrderedProperty
+
 
+
appendTo(Appendable) - Method in class com.amazon.carbonado.info.StorableIndex
+
+
Appends the same results as toString, but without the "StorableIndex" + prefix.
+
+
appendTo(Appendable) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
 
+
appendTo(Appendable) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
appendTo(Appendable) - Method in interface com.amazon.carbonado.util.Appender
+
+
Append the string representation of this object to the given Appendable.
+
+
apply(Cursor<S>, Query.Controller) - Static method in class com.amazon.carbonado.cursor.ControllerCursor
+
+
Returns a ControllerCursor depending on whether a controller instance is + passed in or not.
+
+
applyFilter(Cursor<S>, Class<S>, String, Object...) - Static method in class com.amazon.carbonado.cursor.FilteredCursor
+
+
Returns a Cursor that is filtered by the given filter expression and values.
+
+
applyFilter(Filter<S>, FilterValues<S>, Cursor<S>) - Static method in class com.amazon.carbonado.cursor.FilteredCursor
+
+
Returns a Cursor that is filtered by the given Filter and FilterValues.
+
+
arrayComparator(Class<T>, boolean) - Static method in class com.amazon.carbonado.util.Comparators
+
+
Returns a comparator which can sort single or multi-dimensional arrays + of primitves or Comparables.
+
+
ArraySortBuffer<S> - Class in com.amazon.carbonado.cursor
+
+
Sort buffer implementation backed by an ArrayList.
+
+
ArraySortBuffer() - Constructor for class com.amazon.carbonado.cursor.ArraySortBuffer
+
 
+
ArraySortBuffer(int) - Constructor for class com.amazon.carbonado.cursor.ArraySortBuffer
+
 
+
asJoinedFrom(Class<T>, String) - Method in class com.amazon.carbonado.filter.Filter
+
+
Prepends a join property to all properties of this filter.
+
+
asJoinedFrom(ChainedProperty<T>) - Method in class com.amazon.carbonado.filter.Filter
+
+
Prepends a join property to all properties of this filter.
+
+
asJoinedFromAny(ChainedProperty<T>) - Method in class com.amazon.carbonado.filter.AndFilter
+
 
+
asJoinedFromAny(ChainedProperty<T>) - Method in class com.amazon.carbonado.filter.ClosedFilter
+
 
+
asJoinedFromAny(ChainedProperty<T>) - Method in class com.amazon.carbonado.filter.ExistsFilter
+
 
+
asJoinedFromAny(ChainedProperty<T>) - Method in class com.amazon.carbonado.filter.Filter
+
+
Allows join from any property type, including one-to-many joins.
+
+
asJoinedFromAny(ChainedProperty<T>) - Method in class com.amazon.carbonado.filter.OpenFilter
+
 
+
asJoinedFromAny(ChainedProperty<T>) - Method in class com.amazon.carbonado.filter.OrFilter
+
 
+
asJoinedFromAny(ChainedProperty<T>) - Method in class com.amazon.carbonado.filter.PropertyFilter
+
 
+
assertParameterNotNull(CodeBuilder, int) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Generate code to throw an exception if a parameter is null
+
+
assertReady() - Method in class com.amazon.carbonado.spi.AbstractRepositoryBuilder
+
+
Throw a configuration exception if the configuration is not filled out + sufficiently and correctly such that a repository could be instantiated + from it.
+
+
asString() - Method in class com.amazon.carbonado.lob.AbstractBlob
+
 
+
asString(String) - Method in class com.amazon.carbonado.lob.AbstractBlob
+
 
+
asString(Charset) - Method in class com.amazon.carbonado.lob.AbstractBlob
+
 
+
asString() - Method in class com.amazon.carbonado.lob.AbstractClob
+
 
+
asString() - Method in interface com.amazon.carbonado.lob.Blob
+
+
Convenience method to capture all the Blob data as a single String, + assuming UTF-8 encoding.
+
+
asString(String) - Method in interface com.amazon.carbonado.lob.Blob
+
+
Convenience method to capture all the Blob data as a single String, + decoded against the given charset.
+
+
asString(Charset) - Method in interface com.amazon.carbonado.lob.Blob
+
+
Convenience method to capture all the Blob data as a single String, + decoded against the given charset.
+
+
asString() - Method in class com.amazon.carbonado.lob.CharArrayClob
+
 
+
asString() - Method in interface com.amazon.carbonado.lob.Clob
+
+
Convenience method to capture all the Clob data as a single String.
+
+
asString() - Method in class com.amazon.carbonado.lob.StringClob
+
 
+
attach() - Method in interface com.amazon.carbonado.Transaction
+
+
Attaches this transaction to the current thread, if it has been + detached.
+
+
attach() - Method in class com.amazon.carbonado.txn.TransactionPair
+
 
+
attach() - Method in class com.amazon.carbonado.txn.TransactionScope
+
+
Attach this scope to the current thread, if it has been detached.
+
+
attachNotification(Txn) - Method in class com.amazon.carbonado.txn.TransactionManager
+
+
Called to notify internal method that transaction is attached.
+
+
Authoritative - Annotation Type in com.amazon.carbonado
+
+
Indicates that all accesses to this Storable must come from an + authoritative source.
+
+
Automatic - Annotation Type in com.amazon.carbonado
+
+
Identifies a Storable property capable of selecting its own value on + insert.
+
+
+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.

+ + diff --git a/apidocs/index-files/index-10.html b/apidocs/index-files/index-10.html new file mode 100644 index 0000000..fa12fdb --- /dev/null +++ b/apidocs/index-files/index-10.html @@ -0,0 +1,167 @@ + + + + + + +J-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  + + +

J

+
+
JDBCBlobLoader - Interface in com.amazon.carbonado.repo.jdbc
+
+
Callback for reloading Blobs outside original transaction.
+
+
JDBCClobLoader - Interface in com.amazon.carbonado.repo.jdbc
+
+
Callback for reloading Clobs outside original transaction.
+
+
JDBCConnectionCapability - Interface in com.amazon.carbonado.repo.jdbc
+
+
Capability to directly access the JDBC connection being used by the current + transaction, which is thread-local.
+
+
JDBCRepositoryBuilder - Class in com.amazon.carbonado.repo.jdbc
+
+
Builds a repository instance backed by a JDBC accessible database.
+
+
JDBCRepositoryBuilder() - Constructor for class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
 
+
JDBCStorableInfo<S extends Storable> - Interface in com.amazon.carbonado.repo.jdbc
+
+
Contains all the metadata describing a specific Storable type as + needed by JDBCRepository.
+
+
JDBCStorableIntrospector - Class in com.amazon.carbonado.repo.jdbc
+
+
Provides additional metadata for a Storable type needed by + JDBCRepository.
+
+
JDBCStorableIntrospector() - Constructor for class com.amazon.carbonado.repo.jdbc.JDBCStorableIntrospector
+
 
+
JDBCStorableProperty<S extends Storable> - Interface in com.amazon.carbonado.repo.jdbc
+
+
Contains all the metadata describing a property of a specific Storable type as needed by JDBCRepository.
+
+
JDBCSupport<S extends Storable> - Interface in com.amazon.carbonado.repo.jdbc
+
 
+
Join - Annotation Type in com.amazon.carbonado
+
+
Identifies a Storable property as defining a join relationship + with another Storable type.
+
+
JoinedQueryExecutor<S extends Storable,T extends Storable> - Class in com.amazon.carbonado.qe
+
+
QueryExecutor which joins a source and target executor, + producing results of target type.
+
+
+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.

+ + diff --git a/apidocs/index-files/index-11.html b/apidocs/index-files/index-11.html new file mode 100644 index 0000000..a6efe45 --- /dev/null +++ b/apidocs/index-files/index-11.html @@ -0,0 +1,152 @@ + + + + + + +K-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  + + +

K

+
+
Key - Annotation Type in com.amazon.carbonado
+
+
Identifies a Storable property as being a member of an alternate + key.
+
+
KeyDecoder - Class in com.amazon.carbonado.raw
+
+
A very low-level class that decodes key components encoded by methods of + KeyEncoder.
+
+
KeyDecoder() - Constructor for class com.amazon.carbonado.raw.KeyDecoder
+
 
+
KeyEncoder - Class in com.amazon.carbonado.raw
+
+
A very low-level class that supports encoding of primitive data into unique, + sortable byte array keys.
+
+
KeyEncoder() - Constructor for class com.amazon.carbonado.raw.KeyEncoder
+
 
+
KeyQueryExecutor<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
QueryExecutor which has a fully specified key, and so cursors produce at + most one result.
+
+
KeyQueryExecutor(KeyQueryExecutor.Support<S>, StorableIndex<S>, FilteringScore<S>) - Constructor for class com.amazon.carbonado.qe.KeyQueryExecutor
+
 
+
KeyQueryExecutor.Support<S extends Storable> - Interface in com.amazon.carbonado.qe
+
+
Provides support for KeyQueryExecutor.
+
+
keySet() - Method in class com.amazon.carbonado.gen.StorablePropertyMap
+
 
+
+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.

+ + diff --git a/apidocs/index-files/index-12.html b/apidocs/index-files/index-12.html new file mode 100644 index 0000000..5685e6f --- /dev/null +++ b/apidocs/index-files/index-12.html @@ -0,0 +1,341 @@ + + + + + + +L-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  + + +

L

+
+
Layout - Class in com.amazon.carbonado.layout
+
+
Describes the layout of a specific generation of a storable.
+
+
LayoutCapability - Interface in com.amazon.carbonado.layout
+
+
Capability to get layout information on any storable generation.
+
+
LayoutFactory - Class in com.amazon.carbonado.layout
+
+
Factory for obtaining references to storable layouts.
+
+
LayoutFactory(Repository) - Constructor for class com.amazon.carbonado.layout.LayoutFactory
+
 
+
layoutFor(Class<? extends Storable>) - Method in interface com.amazon.carbonado.layout.LayoutCapability
+
+
Returns the layout matching the current definition of the given type.
+
+
layoutFor(Class<? extends Storable>, int) - Method in interface com.amazon.carbonado.layout.LayoutCapability
+
+
Returns the layout for a particular generation of the given type.
+
+
layoutFor(Class<? extends Storable>) - Method in class com.amazon.carbonado.layout.LayoutFactory
+
+
Returns the layout matching the current definition of the given type.
+
+
layoutFor(Class<? extends Storable>, LayoutOptions) - Method in class com.amazon.carbonado.layout.LayoutFactory
+
+
Returns the layout matching the current definition of the given type.
+
+
layoutFor(boolean, Class<? extends Storable>, LayoutOptions) - Method in class com.amazon.carbonado.layout.LayoutFactory
+
+
Returns the layout matching the current definition of the given type.
+
+
layoutFor(Class<? extends Storable>, int) - Method in class com.amazon.carbonado.layout.LayoutFactory
+
+
Returns the layout for a particular generation of the given type.
+
+
LayoutOptions - Class in com.amazon.carbonado.layout
+
+
Extra options encoded with a Storable layout.
+
+
LayoutOptions() - Constructor for class com.amazon.carbonado.layout.LayoutOptions
+
 
+
LayoutProperty - Class in com.amazon.carbonado.layout
+
+
Describes how a property is defined in a specific generation of a storable.
+
+
LayoutSync - Class in com.amazon.carbonado.layout
+
+
Synchronizes layout metadata between two repositories.
+
+
LayoutSync(Repository, Repository) - Constructor for class com.amazon.carbonado.layout.LayoutSync
+
 
+
LengthConstraint - Annotation Type in com.amazon.carbonado.constraint
+
+
Limits the value of a property to lie within a specific length range.
+
+
LengthConstraint.Constraint - Class in com.amazon.carbonado.constraint
+
+
Constraint implementation for LengthConstraint.
+
+
LengthConstraint.Constraint(Class<?>, String, LengthConstraint) - Constructor for class com.amazon.carbonado.constraint.LengthConstraint.Constraint
+
 
+
LengthConstraint.Constraint(Class<?>, String, int, int) - Constructor for class com.amazon.carbonado.constraint.LengthConstraint.Constraint
+
 
+
LimitCursor<S> - Class in com.amazon.carbonado.cursor
+
+
Wraps another cursor to limit the amount of elements.
+
+
LimitCursor(Cursor<S>, long) - Constructor for class com.amazon.carbonado.cursor.LimitCursor
+
 
+
load(JDBCConnectionCapability) - Method in interface com.amazon.carbonado.repo.jdbc.JDBCBlobLoader
+
 
+
load(JDBCConnectionCapability) - Method in interface com.amazon.carbonado.repo.jdbc.JDBCClobLoader
+
 
+
load() - Method in interface com.amazon.carbonado.Storable
+
+
Loads or reloads this object from the storage layer by a primary or + alternate key.
+
+
LOAD_COMPLETED_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Name of protected method which must be called after load to identify all + properties as valid and to fire any load triggers.
+
+
LOAD_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
LOAD_ONE_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Query API method name
+
+
loadOne() - Method in class com.amazon.carbonado.qe.AbstractQuery
+
 
+
loadOne(Query.Controller) - Method in class com.amazon.carbonado.qe.AbstractQuery
+
 
+
loadOne() - Method in interface com.amazon.carbonado.Query
+
+
Attempts to load exactly one matching object.
+
+
loadOne(Query.Controller) - Method in interface com.amazon.carbonado.Query
+
+
Attempts to load exactly one matching object.
+
+
loadPropertyValue(LocalVariable[], Boolean[], CodeAssembler, StorablePropertyInfo, int, boolean, LocalVariable, Class<?>, LocalVariable) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Generates code to load a property value onto the operand stack.
+
+
loadPropertyValue(CodeAssembler, StorablePropertyInfo, int, boolean, LocalVariable, Class<?>, LocalVariable) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Generates code to load a property value onto the operand stack.
+
+
Lob - Interface in com.amazon.carbonado.lob
+
+
Marker interface for Blobs and Clobs.
+
+
LobEngine - Class in com.amazon.carbonado.spi
+
+
Complete Lob support for repositories, although repository is responsible + for binding Lob properties to this engine.
+
+
LobEngine(Repository, Repository) - Constructor for class com.amazon.carbonado.spi.LobEngine
+
 
+
LobEngine(Repository, SequenceValueProducer) - Constructor for class com.amazon.carbonado.spi.LobEngine
+
 
+
localForeignComparator() - Static method in class com.amazon.carbonado.qe.CompositeScore
+
+
Returns a partial comparator suited for comparing local indexes to + foreign indexes.
+
+
localForeignComparator(QueryHints) - Static method in class com.amazon.carbonado.qe.CompositeScore
+
+
Returns a partial comparator suited for comparing local indexes to + foreign indexes.
+
+
locallyDisableDelete() - Method in class com.amazon.carbonado.spi.TriggerManager
+
+
Disables execution of all managed delete triggers for the current + thread.
+
+
locallyDisableInsert() - Method in class com.amazon.carbonado.spi.TriggerManager
+
+
Disables execution of all managed insert triggers for the current + thread.
+
+
locallyDisableLoad() - Method in class com.amazon.carbonado.spi.TriggerManager
+
+
Disables execution of all managed load triggers for the current + thread.
+
+
locallyDisableLoadTrigger() - Method in interface com.amazon.carbonado.gen.TriggerSupport
+
+
Disables execution of load trigger for the current thread.
+
+
locallyDisableUpdate() - Method in class com.amazon.carbonado.spi.TriggerManager
+
+
Disables execution of all managed update triggers for the current + thread.
+
+
locallyEnableDelete() - Method in class com.amazon.carbonado.spi.TriggerManager
+
+
Enables execution of all managed delete triggers for the current thread, + if they had been disabled before.
+
+
locallyEnableInsert() - Method in class com.amazon.carbonado.spi.TriggerManager
+
+
Enables execution of all managed insert triggers for the current thread, + if they had been disabled before.
+
+
locallyEnableLoad() - Method in class com.amazon.carbonado.spi.TriggerManager
+
+
Enables execution of all managed load triggers for the current thread, + if they had been disabled before.
+
+
locallyEnableLoadTrigger() - Method in interface com.amazon.carbonado.gen.TriggerSupport
+
+
Enables execution of load trigger for the current thread, if they it + been disabled before.
+
+
locallyEnableUpdate() - Method in class com.amazon.carbonado.spi.TriggerManager
+
+
Enables execution of all managed update triggers for the current thread, + if they had been disabled before.
+
+
localScope() - Method in class com.amazon.carbonado.txn.TransactionManager
+
+
Returns the thread-local TransactionScope, creating it if needed.
+
+
localTransactionScope() - Method in class com.amazon.carbonado.spi.AbstractRepository
+
+
Returns the thread-local TransactionScope, creating it if needed.
+
+
lockoutShutdown() - Method in class com.amazon.carbonado.spi.AbstractRepository
+
+
Call to prevent shutdown hook from running.
+
+
Log - Interface in com.amazon.carbonado.repo.logging
+
+
Very simple Log interface.
+
+
LogAccessCapability - Interface in com.amazon.carbonado.repo.logging
+
+
Provides access to the Log.
+
+
LoggingDataSource - Class in com.amazon.carbonado.repo.jdbc
+
+
Wraps another DataSource such that all SQL statements are logged as debug.
+
+
LoggingRepositoryBuilder - Class in com.amazon.carbonado.repo.logging
+
+
Repository implementation which logs activity against it.
+
+
LoggingRepositoryBuilder() - Constructor for class com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder
+
 
+
lowestCommon(IsolationLevel) - Method in enum com.amazon.carbonado.IsolationLevel
+
+
Returns the lowest common isolation level between this and the one + given.
+
+
+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.

+ + diff --git a/apidocs/index-files/index-13.html b/apidocs/index-files/index-13.html new file mode 100644 index 0000000..2550f5d --- /dev/null +++ b/apidocs/index-files/index-13.html @@ -0,0 +1,355 @@ + + + + + + +M-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  + + +

M

+
+
main(String[]) - Static method in class com.amazon.carbonado.info.StorableIntrospector
+
+
Test program which examines candidate Storable classes.
+
+
main(String[]) - Static method in class com.amazon.carbonado.util.Throttle
+
+
Test program which exercises the CPU in an infinite loop, throttled by + the amount given in args[0].
+
+
makeFetchException(String, Throwable) - Method in exception com.amazon.carbonado.PersistDeadlockException
+
 
+
makeFetchException(String, Throwable) - Method in exception com.amazon.carbonado.PersistInterruptedException
+
 
+
makeFetchException(String, Throwable) - Method in exception com.amazon.carbonado.PersistMultipleException
+
 
+
makeFetchException(String, Throwable) - Method in exception com.amazon.carbonado.PersistNoneException
+
 
+
makeFetchException(String, Throwable) - Method in exception com.amazon.carbonado.PersistTimeoutException
+
 
+
makeFetchException(String, Throwable) - Method in exception com.amazon.carbonado.RepositoryException
+
+
Subclasses can override this to provide a more specialized exception.
+
+
makePersistException(String, Throwable) - Method in exception com.amazon.carbonado.FetchDeadlockException
+
 
+
makePersistException(String, Throwable) - Method in exception com.amazon.carbonado.FetchInterruptedException
+
 
+
makePersistException(String, Throwable) - Method in exception com.amazon.carbonado.FetchMultipleException
+
 
+
makePersistException(String, Throwable) - Method in exception com.amazon.carbonado.FetchNoneException
+
 
+
makePersistException(String, Throwable) - Method in exception com.amazon.carbonado.FetchTimeoutException
+
 
+
makePersistException(String, Throwable) - Method in exception com.amazon.carbonado.RepositoryException
+
+
Subclasses can override this to provide a more specialized exception.
+
+
makePlainDescriptor(Class<? extends Annotation>) - Static method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
+
Returns an annotation descriptor that has no parameters.
+
+
makePlainDescriptor(String) - Static method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
+
Returns an annotation descriptor that has no parameters.
+
+
makeReadMethodName(String, Class) - Static method in class com.amazon.carbonado.synthetic.SyntheticProperty
+
+
Generate a name for a bean "get" method ("is" method, for booleans).
+
+
makeWriteMethodName(String) - Static method in class com.amazon.carbonado.synthetic.SyntheticProperty
+
+
Generate a name for a bean "set" method
+
+
MalformedArgumentException - Exception in com.amazon.carbonado
+
+
A MalformedArgumentException is thrown after detailed analysis on an + argument determined it was not suitable.
+
+
MalformedArgumentException() - Constructor for exception com.amazon.carbonado.MalformedArgumentException
+
 
+
MalformedArgumentException(String) - Constructor for exception com.amazon.carbonado.MalformedArgumentException
+
 
+
MalformedArgumentException(List<String>) - Constructor for exception com.amazon.carbonado.MalformedArgumentException
+
 
+
MalformedFilterException - Exception in com.amazon.carbonado
+
+
A MalformedFilterException indicates that a + query filter is invalid.
+
+
MalformedFilterException(String) - Constructor for exception com.amazon.carbonado.MalformedFilterException
+
 
+
MalformedFilterException(String, int) - Constructor for exception com.amazon.carbonado.MalformedFilterException
+
 
+
MalformedFilterException(String, String) - Constructor for exception com.amazon.carbonado.MalformedFilterException
+
 
+
MalformedFilterException(String, String, int) - Constructor for exception com.amazon.carbonado.MalformedFilterException
+
 
+
MalformedTypeException - Exception in com.amazon.carbonado
+
+
A MalformedTypeException indicates that a Storable is defined in a + way that violates the requirements for Storable objects.
+
+
MalformedTypeException(Class<?>) - Constructor for exception com.amazon.carbonado.MalformedTypeException
+
 
+
MalformedTypeException(Class<?>, String) - Constructor for exception com.amazon.carbonado.MalformedTypeException
+
 
+
MalformedTypeException(Class<?>, List<String>) - Constructor for exception com.amazon.carbonado.MalformedTypeException
+
 
+
MapRepositoryBuilder - Class in com.amazon.carbonado.repo.map
+
+
Volatile repository implementation backed by a concurrent map.
+
+
MapRepositoryBuilder() - Constructor for class com.amazon.carbonado.repo.map.MapRepositoryBuilder
+
 
+
MARK_ALL_PROPERTIES_CLEAN - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
MARK_ALL_PROPERTIES_DIRTY - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
MARK_PROPERTIES_CLEAN - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
MARK_PROPERTIES_DIRTY - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
markAllPropertiesClean() - Method in interface com.amazon.carbonado.Storable
+
+
Marks all properties as clean, including uninitialized properties.
+
+
markAllPropertiesDirty() - Method in interface com.amazon.carbonado.Storable
+
+
Marks all properties as dirty, including uninitialized properties.
+
+
markClustered(boolean) - Method in class com.amazon.carbonado.qe.StorableIndexSet
+
+
Marks all indexes as clustered or non-clustered.
+
+
markPropertiesClean() - Method in interface com.amazon.carbonado.Storable
+
+
Marks all dirty properties as clean.
+
+
markPropertiesDirty() - Method in interface com.amazon.carbonado.Storable
+
+
Marks all clean properties as dirty.
+
+
MasterFeature - Enum in com.amazon.carbonado.gen
+
+
Master feature to enable when using MasterStorableGenerator.
+
+
MasterStorableGenerator<S extends Storable> - Class in com.amazon.carbonado.gen
+
+
Generates and caches abstract implementations of Storable types + suitable for use by master repositories.
+
+
MasterSupport<S extends Storable> - Interface in com.amazon.carbonado.gen
+
+
Provides runtime support for Storable classes generated by MasterStorableGenerator.
+
+
mClassFile - Variable in class com.amazon.carbonado.synthetic.ClassFileBuilder
+
+
Partially hydrogenated class operators
+
+
mergeRemainder(IndexedQueryAnalyzer<S>.Result) - Method in class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result
+
+
Merges the remainder filter and orderings of this result with the + one given, returning a new result.
+
+
mergeRemainderFilter(CompositeScore<S>) - Method in class com.amazon.carbonado.qe.CompositeScore
+
+
Merges the remainder filter of this score with the one given using an + 'or' operation.
+
+
mergeRemainderFilter(FilteringScore<S>) - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Merges the remainder filter of this score with the one given using an + 'or' operation.
+
+
mergeRemainderFilter(Filter<S>) - Method in class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result
+
+
Merges the remainder filter of this result with the given filter, + returning a new result.
+
+
mergeRemainderOrdering(CompositeScore<S>) - Method in class com.amazon.carbonado.qe.CompositeScore
+
+
Merges the remainder orderings of this score with the one given.
+
+
mergeRemainderOrdering(OrderingScore<S>) - Method in class com.amazon.carbonado.qe.OrderingScore
+
+
Merges the remainder orderings of this score with the one given.
+
+
MergeSortBuffer<S extends Storable> - Class in com.amazon.carbonado.cursor
+
+
Sort buffer implemented via a merge sort algorithm.
+
+
MergeSortBuffer() - Constructor for class com.amazon.carbonado.cursor.MergeSortBuffer
+
 
+
MergeSortBuffer(Query.Controller) - Constructor for class com.amazon.carbonado.cursor.MergeSortBuffer
+
 
+
MergeSortBuffer(Storage<S>) - Constructor for class com.amazon.carbonado.cursor.MergeSortBuffer
+
 
+
MergeSortBuffer(Storage<S>, Query.Controller) - Constructor for class com.amazon.carbonado.cursor.MergeSortBuffer
+
 
+
MergeSortBuffer(Storage<S>, String) - Constructor for class com.amazon.carbonado.cursor.MergeSortBuffer
+
 
+
MergeSortBuffer(Storage<S>, String, int) - Constructor for class com.amazon.carbonado.cursor.MergeSortBuffer
+
 
+
MergeSortBuffer(Storage<S>, String, int, Query.Controller) - Constructor for class com.amazon.carbonado.cursor.MergeSortBuffer
+
 
+
micros(long) - Static method in class com.amazon.carbonado.Query.Timeout
+
+
Return a new Timeout in microseconds.
+
+
millis(long) - Static method in class com.amazon.carbonado.Query.Timeout
+
+
Return a new Timeout in milliseconds.
+
+
mInjector - Variable in class com.amazon.carbonado.synthetic.ClassFileBuilder
+
 
+
minutes(long) - Static method in class com.amazon.carbonado.Query.Timeout
+
+
Return a new Timeout in minutes.
+
+
MismatchException - Exception in com.amazon.carbonado
+
+
Indicates that a Storable doesn't exactly match up with an external + schema.
+
+
MismatchException() - Constructor for exception com.amazon.carbonado.MismatchException
+
 
+
MismatchException(String) - Constructor for exception com.amazon.carbonado.MismatchException
+
 
+
MismatchException(List<String>) - Constructor for exception com.amazon.carbonado.MismatchException
+
 
+
MismatchException(Class<?>) - Constructor for exception com.amazon.carbonado.MismatchException
+
 
+
MismatchException(Class<?>, String) - Constructor for exception com.amazon.carbonado.MismatchException
+
 
+
MismatchException(Class<?>, List<String>) - Constructor for exception com.amazon.carbonado.MismatchException
+
 
+
mLock - Variable in class com.amazon.carbonado.raw.RawCursor
+
+
Lock object, as passed into the constructor
+
+
MultiTransformedCursor<S,T> - Class in com.amazon.carbonado.cursor
+
+
Abstract cursor which wraps another cursor and transforms each storable + result into a set of target storables.
+
+
MultiTransformedCursor(Cursor<S>) - Constructor for class com.amazon.carbonado.cursor.MultiTransformedCursor
+
 
+
+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.

+ + diff --git a/apidocs/index-files/index-14.html b/apidocs/index-files/index-14.html new file mode 100644 index 0000000..50d4579 --- /dev/null +++ b/apidocs/index-files/index-14.html @@ -0,0 +1,283 @@ + + + + + + +N-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  + + +

N

+
+
Name - Annotation Type in com.amazon.carbonado
+
+
Overrides the primary name of a Storable property.
+
+
nanos(long) - Static method in class com.amazon.carbonado.Query.Timeout
+
+
Return a new Timeout in nanoseconds.
+
+
newCache(int) - Static method in class com.amazon.carbonado.util.SoftValuedCache
+
+
Deprecated.
+ 
+
newInstance() - Method in class com.amazon.carbonado.gen.DetachedStorableFactory
+
 
+
newInstance(FilterValues<S>, OrderingList<S>, QueryHints) - Method in class com.amazon.carbonado.qe.StandardQuery
+
+
Return a new or cached instance of StandardQuery implementation, using + new filter values.
+
+
newline(Appendable) - Method in class com.amazon.carbonado.qe.AbstractQueryExecutor
+
+
Appends a newline character.
+
+
newRepository() - Static method in class com.amazon.carbonado.repo.map.MapRepositoryBuilder
+
+
Convenience method to build a new MapRepository.
+
+
next() - Method in class com.amazon.carbonado.cursor.ControllerCursor
+
 
+
next() - Method in class com.amazon.carbonado.cursor.DifferenceCursor
+
 
+
next() - Method in class com.amazon.carbonado.cursor.EmptyCursor
+
+
Always throws NoSuchElementException.
+
+
next() - Method in class com.amazon.carbonado.cursor.FetchAheadCursor
+
 
+
next() - Method in class com.amazon.carbonado.cursor.FilteredCursor
+
 
+
next() - Method in class com.amazon.carbonado.cursor.GroupedCursor
+
 
+
next() - Method in class com.amazon.carbonado.cursor.IntersectionCursor
+
 
+
next() - Method in class com.amazon.carbonado.cursor.IteratorCursor
+
 
+
next() - Method in class com.amazon.carbonado.cursor.LimitCursor
+
 
+
next() - Method in class com.amazon.carbonado.cursor.MultiTransformedCursor
+
 
+
next() - Method in interface com.amazon.carbonado.Cursor
+
+
Returns the next element from this cursor.
+
+
next() - Method in class com.amazon.carbonado.cursor.SingletonCursor
+
 
+
next() - Method in class com.amazon.carbonado.cursor.SkipCursor
+
 
+
next() - Method in class com.amazon.carbonado.cursor.SortedCursor
+
 
+
next() - Method in class com.amazon.carbonado.cursor.SymmetricDifferenceCursor
+
 
+
next() - Method in class com.amazon.carbonado.cursor.ThrottledCursor
+
 
+
next() - Method in class com.amazon.carbonado.cursor.TransformedCursor
+
 
+
next() - Method in class com.amazon.carbonado.cursor.UnionCursor
+
 
+
next() - Method in class com.amazon.carbonado.raw.RawCursor
+
 
+
nextDecimalValue() - Method in class com.amazon.carbonado.sequence.AbstractSequenceValueProducer
+
 
+
nextDecimalValue() - Method in interface com.amazon.carbonado.sequence.SequenceValueProducer
+
+
Returns the next decimal string value from the sequence, which remains + positive.
+
+
nextGeneration() - Method in class com.amazon.carbonado.layout.Layout
+
+
Returns the next known generation of the storable's layout, or null + if none.
+
+
nextIntValue() - Method in class com.amazon.carbonado.sequence.AbstractSequenceValueProducer
+
 
+
nextIntValue() - Method in class com.amazon.carbonado.sequence.SequenceValueGenerator
+
+
Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted.
+
+
nextIntValue() - Method in interface com.amazon.carbonado.sequence.SequenceValueProducer
+
+
Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted.
+
+
nextLongValue() - Method in class com.amazon.carbonado.sequence.SequenceValueGenerator
+
+
Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted.
+
+
nextLongValue() - Method in interface com.amazon.carbonado.sequence.SequenceValueProducer
+
+
Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted.
+
+
nextNumericalValue(int, int) - Method in class com.amazon.carbonado.sequence.AbstractSequenceValueProducer
+
 
+
nextNumericalValue(int, int) - Method in interface com.amazon.carbonado.sequence.SequenceValueProducer
+
+
Returns the next numerical string value from the sequence, which remains + positive.
+
+
NonDurableCommitException - Exception in com.amazon.carbonado
+
+
Thrown during a transaction commit if durability guarantees cannot be met.
+
+
NonDurableCommitException() - Constructor for exception com.amazon.carbonado.NonDurableCommitException
+
 
+
NonDurableCommitException(String) - Constructor for exception com.amazon.carbonado.NonDurableCommitException
+
 
+
NonDurableCommitException(String, Throwable) - Constructor for exception com.amazon.carbonado.NonDurableCommitException
+
 
+
NonDurableCommitException(Throwable) - Constructor for exception com.amazon.carbonado.NonDurableCommitException
+
 
+
not() - Method in class com.amazon.carbonado.filter.AndFilter
+
 
+
not() - Method in class com.amazon.carbonado.filter.ClosedFilter
+
 
+
not() - Method in class com.amazon.carbonado.filter.ExistsFilter
+
 
+
not() - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns the logical negation of this filter.
+
+
not() - Method in class com.amazon.carbonado.filter.OpenFilter
+
 
+
not() - Method in class com.amazon.carbonado.filter.OrFilter
+
 
+
not() - Method in class com.amazon.carbonado.filter.PropertyFilter
+
 
+
not() - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Returns a query that fetches everything, possibly in a specified order.
+
+
not() - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
not() - Method in interface com.amazon.carbonado.Query
+
+
Returns a new query which produces all the results not supplied in this + query.
+
+
notJoinedFrom(String) - Method in class com.amazon.carbonado.filter.Filter
+
+
Removes a join property prefix from all applicable properties of this + filter.
+
+
notJoinedFrom(ChainedProperty<S>) - Method in class com.amazon.carbonado.filter.Filter
+
+
Removes a join property prefix from all applicable properties of this + filter.
+
+
Nullable - Annotation Type in com.amazon.carbonado
+
+
Identifies that a Storable property can have a null value.
+
+
+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.

+ + diff --git a/apidocs/index-files/index-15.html b/apidocs/index-files/index-15.html new file mode 100644 index 0000000..90b3094 --- /dev/null +++ b/apidocs/index-files/index-15.html @@ -0,0 +1,346 @@ + + + + + + +O-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  + + +

O

+
+
onPanic(Object, Exception) - Method in interface com.amazon.carbonado.repo.sleepycat.BDBPanicHandler
+
+
Called when an Environment panics or an EnvironmentFailureException is thrown.
+
+
OpenFilter<S extends Storable> - Class in com.amazon.carbonado.filter
+
+
Filter which lets all results pass through.
+
+
openInputStream() - Method in interface com.amazon.carbonado.lob.Blob
+
+
Returns an InputStream for reading Blob data positioned at the + start.
+
+
openInputStream(long) - Method in interface com.amazon.carbonado.lob.Blob
+
+
Returns an InputStream for reading Blob data.
+
+
openInputStream(long, int) - Method in interface com.amazon.carbonado.lob.Blob
+
+
Returns an InputStream for reading Blob data.
+
+
openInputStream() - Method in class com.amazon.carbonado.lob.ByteArrayBlob
+
 
+
openInputStream(long) - Method in class com.amazon.carbonado.lob.ByteArrayBlob
+
 
+
openInputStream(long, int) - Method in class com.amazon.carbonado.lob.ByteArrayBlob
+
 
+
openInputStream() - Method in class com.amazon.carbonado.lob.FileBlob
+
 
+
openInputStream(long) - Method in class com.amazon.carbonado.lob.FileBlob
+
 
+
openInputStream(long, int) - Method in class com.amazon.carbonado.lob.FileBlob
+
 
+
openOutputStream() - Method in interface com.amazon.carbonado.lob.Blob
+
+
Returns an OutputStream for writing Blob data, positioned at the + start.
+
+
openOutputStream(long) - Method in interface com.amazon.carbonado.lob.Blob
+
+
Returns an OutputStream for writing Blob data.
+
+
openOutputStream(long, int) - Method in interface com.amazon.carbonado.lob.Blob
+
+
Returns an OutputStream for writing Blob data.
+
+
openOutputStream() - Method in class com.amazon.carbonado.lob.ByteArrayBlob
+
 
+
openOutputStream(long) - Method in class com.amazon.carbonado.lob.ByteArrayBlob
+
 
+
openOutputStream(long, int) - Method in class com.amazon.carbonado.lob.ByteArrayBlob
+
 
+
openOutputStream() - Method in class com.amazon.carbonado.lob.FileBlob
+
 
+
openOutputStream(long) - Method in class com.amazon.carbonado.lob.FileBlob
+
 
+
openOutputStream(long, int) - Method in class com.amazon.carbonado.lob.FileBlob
+
 
+
openReader() - Method in class com.amazon.carbonado.lob.BlobClob
+
 
+
openReader(long) - Method in class com.amazon.carbonado.lob.BlobClob
+
 
+
openReader(long, int) - Method in class com.amazon.carbonado.lob.BlobClob
+
 
+
openReader() - Method in class com.amazon.carbonado.lob.CharArrayClob
+
 
+
openReader(long) - Method in class com.amazon.carbonado.lob.CharArrayClob
+
 
+
openReader(long, int) - Method in class com.amazon.carbonado.lob.CharArrayClob
+
 
+
openReader() - Method in interface com.amazon.carbonado.lob.Clob
+
+
Returns a Reader for reading Clob data, positioned at the start.
+
+
openReader(long) - Method in interface com.amazon.carbonado.lob.Clob
+
+
Returns a Reader for reading Clob data.
+
+
openReader(long, int) - Method in interface com.amazon.carbonado.lob.Clob
+
+
Returns a Reader for reading Clob data.
+
+
openReader() - Method in class com.amazon.carbonado.lob.StringClob
+
 
+
openReader(long) - Method in class com.amazon.carbonado.lob.StringClob
+
 
+
openReader(long, int) - Method in class com.amazon.carbonado.lob.StringClob
+
 
+
openWriter() - Method in class com.amazon.carbonado.lob.BlobClob
+
 
+
openWriter(long) - Method in class com.amazon.carbonado.lob.BlobClob
+
 
+
openWriter(long, int) - Method in class com.amazon.carbonado.lob.BlobClob
+
 
+
openWriter() - Method in class com.amazon.carbonado.lob.CharArrayClob
+
 
+
openWriter(long) - Method in class com.amazon.carbonado.lob.CharArrayClob
+
 
+
openWriter(long, int) - Method in class com.amazon.carbonado.lob.CharArrayClob
+
 
+
openWriter() - Method in interface com.amazon.carbonado.lob.Clob
+
+
Returns a Writer for writing Clob data, positioned at the start.
+
+
openWriter(long) - Method in interface com.amazon.carbonado.lob.Clob
+
+
Returns a Writer for writing Clob data.
+
+
openWriter(long, int) - Method in interface com.amazon.carbonado.lob.Clob
+
+
Returns a Writer for writing Clob data.
+
+
openWriter() - Method in class com.amazon.carbonado.lob.StringClob
+
 
+
openWriter(long) - Method in class com.amazon.carbonado.lob.StringClob
+
 
+
openWriter(long, int) - Method in class com.amazon.carbonado.lob.StringClob
+
 
+
OptimisticLockException - Exception in com.amazon.carbonado
+
+
An OptimisticLockException is thrown if the Repository is using + optimistic locking for concurrency control, and lock aquisition failed.
+
+
OptimisticLockException() - Constructor for exception com.amazon.carbonado.OptimisticLockException
+
 
+
OptimisticLockException(String) - Constructor for exception com.amazon.carbonado.OptimisticLockException
+
 
+
OptimisticLockException(String, Throwable) - Constructor for exception com.amazon.carbonado.OptimisticLockException
+
 
+
OptimisticLockException(Throwable) - Constructor for exception com.amazon.carbonado.OptimisticLockException
+
 
+
OptimisticLockException(long) - Constructor for exception com.amazon.carbonado.OptimisticLockException
+
 
+
OptimisticLockException(Object) - Constructor for exception com.amazon.carbonado.OptimisticLockException
+
 
+
OptimisticLockException(Object, Object) - Constructor for exception com.amazon.carbonado.OptimisticLockException
+
 
+
OptimisticLockException(Object, Object, Storable) - Constructor for exception com.amazon.carbonado.OptimisticLockException
+
 
+
OptimisticLockException(Object, Storable, Object) - Constructor for exception com.amazon.carbonado.OptimisticLockException
+
+
Construct exception for when new version was expected to have increased.
+
+
or(Filter<S>) - Method in class com.amazon.carbonado.filter.ClosedFilter
+
 
+
or(String) - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.
+
+
or(Filter<S>) - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.
+
+
or(String, RelOp) - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.
+
+
or(String, RelOp, Object) - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.
+
+
or(Filter<S>) - Method in class com.amazon.carbonado.filter.OpenFilter
+
 
+
or(String) - Method in class com.amazon.carbonado.qe.AbstractQuery
+
 
+
or(Filter<S>) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
 
+
or(Filter<S>) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
or(String) - Method in interface com.amazon.carbonado.Query
+
+
Returns a new query which has another filter logically "or"ed to this, potentially increasing the amount of + results.
+
+
or(Filter<S>) - Method in interface com.amazon.carbonado.Query
+
+
Returns a new query which has another filter logically "or"ed to this, potentially increasing the amount of + results.
+
+
orderBy(String) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
 
+
orderBy(String...) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
 
+
orderBy(String) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
orderBy(String...) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
orderBy(String) - Method in interface com.amazon.carbonado.Query
+
+
Returns a copy of this query ordered by a specific property value.
+
+
orderBy(String...) - Method in interface com.amazon.carbonado.Query
+
+
Returns a copy of this query ordered by specific property values.
+
+
OrderedProperty<S extends Storable> - Class in com.amazon.carbonado.info
+
+
Represents a property paired with a preferred ordering direction.
+
+
OrderingList<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
Produces unmodifiable lists of orderings.
+
+
OrderingScore<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
Evaluates an index for how well it matches a query's desired ordering.
+
+
orExists(String, Filter<?>) - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns a combined filter instance that accepts records which are + accepted either by this filter or the "exists" test applied to a join.
+
+
OrFilter<S extends Storable> - Class in com.amazon.carbonado.filter
+
+
Filter tree node that performs a logical 'or' test.
+
+
orNotExists(String, Filter<?>) - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns a combined filter instance that accepts records which are + accepted either by this filter or the "not exists" test applied to a + join.
+
+
+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.

+ + 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.

+ + diff --git a/apidocs/index-files/index-17.html b/apidocs/index-files/index-17.html new file mode 100644 index 0000000..51b5a60 --- /dev/null +++ b/apidocs/index-files/index-17.html @@ -0,0 +1,230 @@ + + + + + + +Q-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  + + +

Q

+
+
query(Filter<S>, FilterValues<S>, OrderingList<S>, QueryHints) - Method in interface com.amazon.carbonado.qe.QueryFactory
+
+
Returns a query that handles the given query specification.
+
+
query() - Method in class com.amazon.carbonado.qe.StandardQueryFactory
+
+
Returns a new or cached query that fetches everything.
+
+
query(String) - Method in class com.amazon.carbonado.qe.StandardQueryFactory
+
+
Returns a new or cached query for the given filter.
+
+
query(Filter<S>) - Method in class com.amazon.carbonado.qe.StandardQueryFactory
+
+
Returns a new or cached query for the given filter.
+
+
query(Filter<S>, OrderingList<S>) - Method in class com.amazon.carbonado.qe.StandardQueryFactory
+
+
Returns a new or cached query for the given query specification.
+
+
query(Filter<S>, OrderingList<S>, QueryHints) - Method in class com.amazon.carbonado.qe.StandardQueryFactory
+
+
Returns a new or cached query for the given query specification.
+
+
query(Filter<S>, FilterValues<S>, OrderingList<S>) - Method in class com.amazon.carbonado.qe.StandardQueryFactory
+
+
Returns a new or cached query for the given query specification.
+
+
query(Filter<S>, FilterValues<S>, OrderingList<S>, QueryHints) - Method in class com.amazon.carbonado.qe.StandardQueryFactory
+
+
Returns a new or cached query for the given query specification.
+
+
Query<S extends Storable> - Interface in com.amazon.carbonado
+
+
Supports complex retrieval and deletion of Storable objects.
+
+
query() - Method in interface com.amazon.carbonado.Storage
+
+
Query for all Storable instances in this Storage.
+
+
query(String) - Method in interface com.amazon.carbonado.Storage
+
+
Query for Storable instances against a filter expression.
+
+
query(Filter<S>) - Method in interface com.amazon.carbonado.Storage
+
+
Query for Storable instances against an explicitly constructed filter + object.
+
+
Query.Controller - Interface in com.amazon.carbonado
+
+
Controller instance can be used to abort query operations.
+
+
Query.Timeout - Class in com.amazon.carbonado
+
+
Timeout controller, for aborting long running queries.
+
+
Query.Timeout(long, TimeUnit) - Constructor for class com.amazon.carbonado.Query.Timeout
+
 
+
QUERY_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storage API method name
+
+
QueryEngine<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
Complete rule-based query engine implementation.
+
+
QueryEngine(Class<S>, RepositoryAccess) - Constructor for class com.amazon.carbonado.qe.QueryEngine
+
 
+
QueryExecutor<S extends Storable> - Interface in com.amazon.carbonado.qe
+
+
Performs all the actual work of executing a query.
+
+
QueryExecutorCache<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
QueryExecutors should be cached since expensive analysis is often required to build + them.
+
+
QueryExecutorCache(QueryExecutorFactory<S>) - Constructor for class com.amazon.carbonado.qe.QueryExecutorCache
+
 
+
QueryExecutorFactory<S extends Storable> - Interface in com.amazon.carbonado.qe
+
+
Produces QueryExecutor instances from a query specification.
+
+
QueryFactory<S extends Storable> - Interface in com.amazon.carbonado.qe
+
+
Produces Query instances from a query specification.
+
+
queryFactory() - Method in class com.amazon.carbonado.qe.StandardQuery
+
+
Return a QueryFactory which is used to form new queries from this one.
+
+
QueryHint - Enum in com.amazon.carbonado.qe
+
+
Defines a hint key.
+
+
QueryHints - Class in com.amazon.carbonado.qe
+
+
An immutable map of query hints.
+
+
QuickConstructorGenerator - Class in com.amazon.carbonado.util
+
+
Deprecated. +
use QuickConstructorGenerator
+
+
+
QuickConstructorGenerator() - Constructor for class com.amazon.carbonado.util.QuickConstructorGenerator
+
+
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.

+ + diff --git a/apidocs/index-files/index-18.html b/apidocs/index-files/index-18.html new file mode 100644 index 0000000..a564fed --- /dev/null +++ b/apidocs/index-files/index-18.html @@ -0,0 +1,416 @@ + + + + + + +R-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  + + +

R

+
+
RAFInputStream - Class in com.amazon.carbonado.spi
+
+
InputStream that wraps a RandomAccessFile.
+
+
RAFInputStream(RandomAccessFile) - Constructor for class com.amazon.carbonado.spi.RAFInputStream
+
 
+
RAFOutputStream - Class in com.amazon.carbonado.spi
+
+
OutputStream that wraps a RandomAccessFile.
+
+
RAFOutputStream(RandomAccessFile) - Constructor for class com.amazon.carbonado.spi.RAFOutputStream
+
 
+
rangeComparator() - Static method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns a partial comparator which determines which FilteringScores are + better by examining only identity and range matches.
+
+
RawCursor<S> - Class in com.amazon.carbonado.raw
+
+
Abstract Cursor implementation for a repository that manipulates raw bytes.
+
+
RawCursor(Lock, byte[], boolean, byte[], boolean, int, boolean) - Constructor for class com.amazon.carbonado.raw.RawCursor
+
 
+
RawStorableGenerator - Class in com.amazon.carbonado.raw
+
+
Generates and caches abstract implementations of Storable types + which are encoded and decoded in a raw format.
+
+
RawSupport<S extends Storable> - Interface in com.amazon.carbonado.raw
+
+
Provides runtime support for Storable classes generated by RawStorableGenerator.
+
+
RawUtil - Class in com.amazon.carbonado.raw
+
+
Utilities for manipulating binary data.
+
+
RawUtil() - Constructor for class com.amazon.carbonado.raw.RawUtil
+
 
+
read() - Method in class com.amazon.carbonado.spi.RAFInputStream
+
 
+
read(byte[]) - Method in class com.amazon.carbonado.spi.RAFInputStream
+
 
+
read(byte[], int, int) - Method in class com.amazon.carbonado.spi.RAFInputStream
+
 
+
READ_FROM - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
readFrom(InputStream) - Method in interface com.amazon.carbonado.Storable
+
+
Restores property values and states as encoded by Storable.writeTo(java.io.OutputStream).
+
+
readFully(InputStream, byte[]) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Reads as many bytes from the stream as is necessary to fill the given + byte array.
+
+
readLayoutFrom(InputStream) - Method in class com.amazon.carbonado.layout.LayoutFactory
+
+
Read a layout as written by Layout.writeTo(java.io.OutputStream).
+
+
readLength(InputStream) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a length value which was encoded by DataEncoder.writeLength(int, java.io.OutputStream).
+
+
receive() - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Request
+
+
Receive data from caller.
+
+
receiveInto(Collection<? super D>) - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Request
+
+
Receive all remaining data from caller.
+
+
reconstruct() - Method in class com.amazon.carbonado.layout.Layout
+
+
Reconstructs the storable type defined by this layout by returning an + auto-generated class.
+
+
reconstruct(ClassLoader) - Method in class com.amazon.carbonado.layout.Layout
+
+
Reconstructs the storable type defined by this layout by returning an + auto-generated class.
+
+
reduce() - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns an equivalent filter with redundant terms eliminated.
+
+
reduce() - Method in class com.amazon.carbonado.qe.OrderingList
+
+
Eliminates redundant ordering properties.
+
+
reduce() - Method in class com.amazon.carbonado.qe.StorableIndexSet
+
+
Reduces the size of the set by removing redundant indexes, and merges + others together.
+
+
reduce(Direction) - Method in class com.amazon.carbonado.qe.StorableIndexSet
+
+
Reduces the size of the set by removing redundant indexes, and merges + others together.
+
+
register(Class<S>, Cursor<S>) - Method in class com.amazon.carbonado.txn.TransactionScope
+
+
Registers the given cursor against the active transaction, allowing it + to be closed on transaction exit or transaction manager close.
+
+
release() - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Release any internal resources, called when closed.
+
+
RelOp - Enum in com.amazon.carbonado.filter
+
+
Relational operator enumeration.
+
+
RemoteProcedure<R,D> - Interface in com.amazon.carbonado.capability
+
+
Defines a remote procedure which can be executed by RemoteProcedureCapability.
+
+
RemoteProcedure.Call<R,D> - Interface in com.amazon.carbonado.capability
+
+
Client-side call into a remote procedure.
+
+
RemoteProcedure.Reply<R> - Interface in com.amazon.carbonado.capability
+
+
Reply from remote procedure implementation.
+
+
RemoteProcedure.Request<R,D> - Interface in com.amazon.carbonado.capability
+
+
Request into a remote procedure, as seen by procedure implementation.
+
+
RemoteProcedureCapability - Interface in com.amazon.carbonado.capability
+
+
Capability which allows arbitrary code to run on a remote host and access + its repository.
+
+
remove(Object) - Method in class com.amazon.carbonado.gen.StorablePropertyMap
+
 
+
remove(Object) - Method in class com.amazon.carbonado.util.AbstractPool
+
+
Remove a value, returning the old value.
+
+
remove(K) - Method in class com.amazon.carbonado.util.SoftValuedCache
+
+
Deprecated.
+ 
+
remove(K, V) - Method in class com.amazon.carbonado.util.SoftValuedCache
+
+
Deprecated.
+ 
+
removeTrigger(Trigger<? super S>) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
removeTrigger(Trigger<? super S>) - Method in interface com.amazon.carbonado.Storage
+
+
Remove a trigger which was registered earlier.
+
+
removeTriggerFactory(TriggerFactory) - Method in interface com.amazon.carbonado.RepositoryBuilder
+
+
Remove a TriggerFactory which was added earlier.
+
+
removeTriggerFactory(TriggerFactory) - Method in class com.amazon.carbonado.spi.AbstractRepositoryBuilder
+
 
+
repair(double) - Method in interface com.amazon.carbonado.repo.indexed.IndexEntryAccessor
+
+
Repairs the index by inserting missing entries and fixing + inconsistencies.
+
+
RepairExecutor - Class in com.amazon.carbonado.spi
+
+
A convenience class for repositories to run dynamic repairs in separate + threads.
+
+
replace(int, OrderedProperty<S>) - Method in class com.amazon.carbonado.qe.OrderingList
+
+
Returns a list with the given element replaced.
+
+
replace(K, V, V) - Method in class com.amazon.carbonado.util.SoftValuedCache
+
+
Deprecated.
+ 
+
replace(K, V) - Method in class com.amazon.carbonado.util.SoftValuedCache
+
+
Deprecated.
+ 
+
ReplicatedRepositoryBuilder - Class in com.amazon.carbonado.repo.replicated
+
+
Repository builder for the replicated repository.
+
+
ReplicatedRepositoryBuilder() - Constructor for class com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder
+
 
+
Repository - Interface in com.amazon.carbonado
+
+
A Repository represents a database for Storable + instances.
+
+
RepositoryAccess - Interface in com.amazon.carbonado.qe
+
+
Provides internal access to a Repository, necessary for query + execution.
+
+
RepositoryBuilder - Interface in com.amazon.carbonado
+
+
Standard interface for building up configuration and opening a Repository instance.
+
+
RepositoryException - Exception in com.amazon.carbonado
+
+
General checked exception thrown when accessing a Repository.
+
+
RepositoryException() - Constructor for exception com.amazon.carbonado.RepositoryException
+
 
+
RepositoryException(String) - Constructor for exception com.amazon.carbonado.RepositoryException
+
 
+
RepositoryException(String, Throwable) - Constructor for exception com.amazon.carbonado.RepositoryException
+
 
+
RepositoryException(Throwable) - Constructor for exception com.amazon.carbonado.RepositoryException
+
 
+
reset() - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Call
+
+
Reset the internal object stream of the call, allowing cached + objects to get freed.
+
+
reset() - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Reply
+
+
Reset the internal object stream of the reply, allowing cached + objects to get freed.
+
+
reset(int) - Method in class com.amazon.carbonado.sequence.SequenceValueGenerator
+
+
Reset the sequence.
+
+
resetExecutor() - Method in class com.amazon.carbonado.qe.StandardQuery
+
+
Resets any cached reference to a query executor.
+
+
resetExecutors() - Method in class com.amazon.carbonado.qe.StandardQueryFactory
+
+
For each cached query, calls StandardQuery.resetExecutor().
+
+
resumeCheckpointer() - Method in interface com.amazon.carbonado.repo.sleepycat.CheckpointCapability
+
+
Resumes the checkpointer if it was suspended.
+
+
resync(Class<S>, double, String, Object...) - Method in interface com.amazon.carbonado.capability.ResyncCapability
+
+
Re-synchronizes replicated storables against the master repository.
+
+
resync(Class<S>, ResyncCapability.Listener<? super S>, double, String, Object...) - Method in interface com.amazon.carbonado.capability.ResyncCapability
+
+
Re-synchronizes replicated storables against the master repository.
+
+
ResyncCapability - Interface in com.amazon.carbonado.capability
+
+
Capability of replicating repositories for re-synchronizing to the master + repository.
+
+
ResyncCapability.Listener<S> - Class in com.amazon.carbonado.capability
+
+
Trigger which is invoked as storables get re-sync'd.
+
+
ResyncCapability.Listener() - Constructor for class com.amazon.carbonado.capability.ResyncCapability.Listener
+
 
+
returnReservedValues() - Method in class com.amazon.carbonado.sequence.SequenceValueGenerator
+
+
Allow any unused reserved values to be returned for re-use.
+
+
returnReservedValues() - Method in interface com.amazon.carbonado.sequence.SequenceValueProducer
+
+
Allow any unused reserved values to be returned for re-use.
+
+
returnReservedValues(Log) - Method in class com.amazon.carbonado.sequence.SequenceValueProducerPool
+
+
Returns reserved values for all SequenceValueProducers.
+
+
reuseTxn(Txn) - Method in class com.amazon.carbonado.txn.TransactionManager
+
+
Called when a transaction is about to be reused.
+
+
reverse() - Method in enum com.amazon.carbonado.filter.RelOp
+
 
+
reverse() - Method in enum com.amazon.carbonado.info.Direction
+
+
Returns the reverse direction of this.
+
+
reverse() - Method in class com.amazon.carbonado.info.OrderedProperty
+
 
+
reverse() - Method in class com.amazon.carbonado.info.StorableIndex
+
+
Returns a StorableIndex instance with all the properties reversed.
+
+
reverseDirections() - Method in class com.amazon.carbonado.qe.OrderingList
+
+
Returns this list with all orderings in reverse.
+
+
run() - Method in class com.amazon.carbonado.layout.LayoutSync
+
 
+
run() - Method in class com.amazon.carbonado.util.TaskQueueThread
+
 
+
+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.

+ + diff --git a/apidocs/index-files/index-19.html b/apidocs/index-files/index-19.html new file mode 100644 index 0000000..8984346 --- /dev/null +++ b/apidocs/index-files/index-19.html @@ -0,0 +1,1331 @@ + + + + + + +S-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  + + +

S

+
+
seconds(long) - Static method in class com.amazon.carbonado.Query.Timeout
+
+
Return a new Timeout in seconds.
+
+
selectIsolationLevel(Transaction, IsolationLevel) - Method in class com.amazon.carbonado.txn.TransactionManager
+
+
Returns supported isolation level, which may be higher.
+
+
send(D) - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Call
+
+
Send data to the remote procedure.
+
+
send(R) - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Reply
+
+
Send reply data to the caller.
+
+
sendAll(Iterable<? extends D>) - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Call
+
+
Send all data from the given iterable to the remote procedure.
+
+
sendAll(Cursor<? extends D>) - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Call
+
+
Send all data from the given cursor to the remote procedure.
+
+
sendAll(Iterable<? extends R>) - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Reply
+
+
Reply with all data from the given iterable to the caller.
+
+
sendAll(Cursor<? extends R>) - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Reply
+
+
Reply with all data from the given cursor to the caller.
+
+
Sequence - Annotation Type in com.amazon.carbonado
+
+
Identifies a Storable property capable of selecting its own value on + insert, by a named sequence.
+
+
SequenceCapability - Interface in com.amazon.carbonado.sequence
+
+
Capability to use sequences.
+
+
SequenceValueGenerator - Class in com.amazon.carbonado.sequence
+
+
General purpose implementation of a sequence value generator.
+
+
SequenceValueGenerator(Repository, String) - Constructor for class com.amazon.carbonado.sequence.SequenceValueGenerator
+
+
Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist.
+
+
SequenceValueGenerator(Repository, String, long, int) - Constructor for class com.amazon.carbonado.sequence.SequenceValueGenerator
+
+
Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist.
+
+
SequenceValueGenerator(Repository, String, long, int, int) - Constructor for class com.amazon.carbonado.sequence.SequenceValueGenerator
+
+
Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist.
+
+
SequenceValueProducer - Interface in com.amazon.carbonado.sequence
+
+
Produces values for sequences.
+
+
SequenceValueProducerPool - Class in com.amazon.carbonado.sequence
+
+
A concurrent pool of strongly referenced SequenceValueProducer + instances mapped by name.
+
+
SequenceValueProducerPool() - Constructor for class com.amazon.carbonado.sequence.SequenceValueProducerPool
+
 
+
SET_FOR_UPDATE_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Transaction API method name
+
+
SET_PROPERTY_VALUE - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
setActualRepositoryBuilder(RepositoryBuilder) - Method in class com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder
+
+
Set the Repository to wrap all calls to.
+
+
setAdapter(StorablePropertyAdapter) - Method in class com.amazon.carbonado.synthetic.SyntheticProperty
+
+
Storables cannot currently have more than one adapter per property.
+
+
setAdapterParams(String) - Method in interface com.amazon.carbonado.layout.StoredLayoutProperty
+
 
+
setAdapterTypeName(String) - Method in interface com.amazon.carbonado.layout.StoredLayoutProperty
+
 
+
setAllClustered(boolean) - Method in class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder
+
+
When all indexes are identified as clustered, the query analyzer treats + all indexes as performing equally well.
+
+
setAutoShutdownEnabled(boolean) - Method in interface com.amazon.carbonado.capability.ShutdownCapability
+
+
Request to enable or disable the automatic shutdown hook.
+
+
setAutoShutdownEnabled(boolean) - Method in class com.amazon.carbonado.spi.AbstractRepository
+
 
+
setAutoVersioningEnabled(boolean, String) - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
By default, JDBCRepository assumes that version numbers are initialized and + incremented by triggers installed on the database.
+
+
setBDBProduct(BDBProduct) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Sets the BDB product to use, which defaults to JE.
+
+
setBlobValue(PreparedStatement, int, Blob) - Method in interface com.amazon.carbonado.repo.jdbc.JDBCSupport
+
 
+
setBlobValue(long, Blob) - Method in class com.amazon.carbonado.spi.LobEngine
+
+
Stores a value into a Blob, replacing anything that was there + before.
+
+
setBlobValue(long, InputStream) - Method in class com.amazon.carbonado.spi.LobEngine
+
+
Stores a value into a Blob, replacing anything that was there + before.
+
+
setBlockNumber(int) - Method in class com.amazon.carbonado.spi.StoredLob.Block
+
 
+
setBlockSize(int) - Method in class com.amazon.carbonado.spi.StoredLob
+
 
+
setCachePercent(int) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Set the percent of JVM heap used by the repository cache.
+
+
setCachePercent(Integer) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Set the percent of JVM heap used by the repository cache.
+
+
setCacheSize(long) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Set the repository cache size, in bytes.
+
+
setCacheSize(Long) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Set the repository cache size, in bytes.
+
+
setCatalog(String) - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
Optionally set the catalog to search for metadata.
+
+
setCheckpointInterval(int) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Set the interval to run checkpoints.
+
+
setCheckpointThresholdKB(int) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Set the size threshold to run checkpoints.
+
+
setCheckpointThresholdMinutes(int) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Set the time threshold to run checkpoints.
+
+
setChecksumEnabled(Boolean) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
When true, enable checksum verification of pages read into the cache + from the backing filestore.
+
+
setClassNameProvider(SyntheticBuilder.ClassNameProvider) - Method in class com.amazon.carbonado.synthetic.SyntheticStorableBuilder
+
 
+
setClobValue(PreparedStatement, int, Clob) - Method in interface com.amazon.carbonado.repo.jdbc.JDBCSupport
+
 
+
setClobValue(long, Clob) - Method in class com.amazon.carbonado.spi.LobEngine
+
+
Stores a value into a Clob, replacing anything that was there + before.
+
+
setClobValue(long, Reader) - Method in class com.amazon.carbonado.spi.LobEngine
+
+
Stores a value into a Clob, replacing anything that was there + before.
+
+
setCompressionType(String) - Method in class com.amazon.carbonado.layout.LayoutOptions
+
 
+
setCompressor(String, String) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Set the compressor for the given class, overriding a custom StorableCodecFactory.
+
+
setCreationHost(String) - Method in interface com.amazon.carbonado.layout.StoredLayout
+
 
+
setCreationTimestamp(long) - Method in interface com.amazon.carbonado.layout.StoredLayout
+
 
+
setCreationTimestamp(long) - Method in interface com.amazon.carbonado.repo.indexed.StoredIndexInfo
+
 
+
setCreationTimestamp(long) - Method in class com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo
+
 
+
setCreationUser(String) - Method in interface com.amazon.carbonado.layout.StoredLayout
+
 
+
setData(byte[]) - Method in class com.amazon.carbonado.spi.StoredLob.Block
+
 
+
setDatabaseHook(BDBRepositoryBuilder.DatabaseHook) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Sets a hook to be called whenever a database is opened.
+
+
setDatabaseName(String) - Method in class com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo
+
 
+
setDatabasePageSize(Integer, Class<? extends Storable>) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Sets the desired page size for a given type.
+
+
setDatabasesTransactional(Boolean) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
When true, allows databases to be transactional.
+
+
setDataHome(String) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
By default, data files are stored relative to the environment home.
+
+
setDataHomeFile(File) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
By default, data files are stored relative to the environment home.
+
+
setDataSource(DataSource) - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
Set the source of JDBC connections, overriding any configuration + supported by these methods: + + + JDBCRepositoryBuilder.setDriverClassName(java.lang.String) + JDBCRepositoryBuilder.setDriverURL(java.lang.String) + JDBCRepositoryBuilder.setUserName(java.lang.String) + JDBCRepositoryBuilder.setPassword(java.lang.String) +
+
+
setDataSourceCloseOnShutdown(boolean) - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
Pass true to cause the DataSource to be closed when the repository is + closed or shutdown.
+
+
setDataSourceLogging(boolean) - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
Pass true to enable debug logging.
+
+
setDefaultDirection(Direction) - Method in class com.amazon.carbonado.info.StorableIndex
+
+
Returns a StorableIndex instance with all unspecified directions set to + the given direction.
+
+
setDefaultDirection(Direction) - Method in class com.amazon.carbonado.qe.StorableIndexSet
+
+
Set the default direction for all index properties.
+
+
setDefaultFetchSize(Integer) - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
Set the default fetch size when running queries.
+
+
setDesiredLockTimeout(int, TimeUnit) - Method in interface com.amazon.carbonado.Transaction
+
+
Specify a desired timeout for aquiring locks within this + transaction.
+
+
setDesiredLockTimeout(int, TimeUnit) - Method in class com.amazon.carbonado.txn.TransactionPair
+
 
+
setDriverClassName(String) - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
Set the JDBC driver class name, which is required if a DataSource was not provided.
+
+
setDriverURL(String) - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
Set the JDBC connection URL, which is required if a DataSource was not + provided.
+
+
setEnvironmentHome(String) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Sets the repository environment home directory, which is required.
+
+
setEnvironmentHomeFile(File) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Sets the repository environment home directory, which is required.
+
+
setEvolutionStrategy(int) - Method in class com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo
+
 
+
setEvolvable(boolean) - Method in class com.amazon.carbonado.synthetic.SyntheticStorableBuilder
+
+
By default, generated storable implements the Unevolvable marker + interface, which can affect how it is encoded.
+
+
setExecutor() - Method in class com.amazon.carbonado.qe.StandardQuery
+
+
Ensures that a cached query executor reference is available.
+
+
setExecutors() - Method in class com.amazon.carbonado.qe.StandardQueryFactory
+
+
For each cached query, calls StandardQuery.setExecutor().
+
+
setExtraData(byte[]) - Method in interface com.amazon.carbonado.layout.StoredLayout
+
 
+
setExtraData(byte[]) - Method in interface com.amazon.carbonado.layout.StoredLayoutEquivalence
+
 
+
setExtraData(byte[]) - Method in interface com.amazon.carbonado.layout.StoredLayoutProperty
+
 
+
setExtraData(byte[]) - Method in interface com.amazon.carbonado.repo.indexed.StoredIndexInfo
+
 
+
setExtraData(byte[]) - Method in class com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo
+
 
+
setFileName(String, String) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Specify the file that a BDB database should reside in, except for log + files and caches.
+
+
setForceStoredSequence(boolean) - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
By default, native sequences are used if supported.
+
+
setForUpdate(boolean) - Method in interface com.amazon.carbonado.Transaction
+
+
Set to true to force all read operations within this transaction to + acquire upgradable or write locks.
+
+
setForUpdate(Txn, boolean) - Method in class com.amazon.carbonado.txn.TransactionManager
+
+
Called when the Transaction.setForUpdate method is called.
+
+
setForUpdate(boolean) - Method in class com.amazon.carbonado.txn.TransactionPair
+
 
+
setGeneration(int) - Method in interface com.amazon.carbonado.layout.StoredLayout
+
 
+
setGeneration(int) - Method in interface com.amazon.carbonado.layout.StoredLayoutEquivalence
+
 
+
setIndexName(String) - Method in interface com.amazon.carbonado.repo.indexed.StoredIndexInfo
+
 
+
setIndexNameDescriptor(String) - Method in class com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo
+
 
+
setIndexRepairDiscardDuplicates(boolean) - Method in class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder
+
+
Set true to skip collisions during index repair, logging each as a + warning.
+
+
setIndexRepairEnabled(boolean) - Method in class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder
+
+
By default, index repair is enabled.
+
+
setIndexRepairEnabled(boolean) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
By default, index repair is enabled.
+
+
setIndexRepairThrottle(double) - Method in class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder
+
+
Sets the throttle parameter used when indexes are added, dropped or bulk + repaired.
+
+
setIndexRepairThrottle(double) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Sets the throttle parameter used when indexes are added, dropped or bulk + repaired.
+
+
setIndexRepairVerifyOnly(boolean) - Method in class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder
+
+
Set true to build and verify indexes, but don't apply any changes.
+
+
setIndexSupport(boolean) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
By default, user specified indexes are supported.
+
+
setIndexTypeDescriptor(String) - Method in interface com.amazon.carbonado.repo.indexed.StoredIndexInfo
+
 
+
setIndexTypeDescriptor(String) - Method in class com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo
+
 
+
setInitialDatabaseConfig(Object) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Optionally set the BDB specific database configuration to use + for all databases created.
+
+
setInitialEnvironmentConfig(Object) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Optionally set the BDB specific environment configuration to + use.
+
+
setInitializeLogging(boolean) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Ensure the transaction logging sub-system is initialized, which is + usually implied.
+
+
setInitialValue(long) - Method in interface com.amazon.carbonado.sequence.StoredSequence
+
 
+
setInitialValue(long) - Method in interface com.amazon.carbonado.spi.StoredSequence
+
+
Deprecated.
+ 
+
setIsNullable(boolean) - Method in class com.amazon.carbonado.synthetic.SyntheticProperty
+
 
+
setIsVersion(boolean) - Method in class com.amazon.carbonado.synthetic.SyntheticProperty
+
 
+
setKeepOldLogFiles(boolean) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
By default, transaction log files are deleted when no longer needed.
+
+
setLayoutID(long) - Method in interface com.amazon.carbonado.layout.StoredLayout
+
 
+
setLayoutID(long) - Method in interface com.amazon.carbonado.layout.StoredLayoutProperty
+
 
+
setLength(long) - Method in interface com.amazon.carbonado.lob.Blob
+
+
Set the length of this Blob, in bytes.
+
+
setLength(long) - Method in class com.amazon.carbonado.lob.BlobClob
+
 
+
setLength(long) - Method in class com.amazon.carbonado.lob.ByteArrayBlob
+
 
+
setLength(long) - Method in class com.amazon.carbonado.lob.CharArrayClob
+
 
+
setLength(long) - Method in interface com.amazon.carbonado.lob.Clob
+
+
Set the length of this Clob, in characters.
+
+
setLength(long) - Method in class com.amazon.carbonado.lob.FileBlob
+
 
+
setLength(long) - Method in class com.amazon.carbonado.lob.StringClob
+
 
+
setLength(long) - Method in class com.amazon.carbonado.spi.StoredLob
+
 
+
setLocator(long) - Method in class com.amazon.carbonado.spi.StoredLob.Block
+
 
+
setLocator(long) - Method in class com.amazon.carbonado.spi.StoredLob
+
 
+
setLockConflictDeadlockDetectMode(boolean) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Enable deadlock detection whenever a lock conflict occurs.
+
+
setLockTimeout(int, TimeUnit) - Method in class com.amazon.carbonado.repo.map.MapRepositoryBuilder
+
+
Set the lock timeout.
+
+
setLockTimeout(double) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Set the lock timeout, in seconds.
+
+
setLockTimeoutMillis(int) - Method in class com.amazon.carbonado.repo.map.MapRepositoryBuilder
+
+
Set the lock timeout, in milliseconds.
+
+
setLog(Log) - Method in class com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder
+
+
Set the Log to use.
+
+
setLogFileMaxSize(Integer) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Set the maximum transaction log file size for the BDB environment.
+
+
setLogInMemory(boolean) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Set true to store transaction logs in memory only instead of persistent + storage.
+
+
setLoginTimeout(int) - Method in class com.amazon.carbonado.repo.jdbc.LoggingDataSource
+
 
+
setLoginTimeout(int) - Method in class com.amazon.carbonado.repo.jdbc.SimpleDataSource
+
 
+
setLogRegionSize(int) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Set the repository log region size, in bytes.
+
+
setLogRegionSize(Integer) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Set the repository log region size, in bytes.
+
+
setLogWriter(PrintWriter) - Method in class com.amazon.carbonado.repo.jdbc.LoggingDataSource
+
 
+
setLogWriter(PrintWriter) - Method in class com.amazon.carbonado.repo.jdbc.SimpleDataSource
+
 
+
setMaster(boolean) - Method in class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder
+
 
+
setMaster(boolean) - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
 
+
setMaster(boolean) - Method in class com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder
+
 
+
setMaster(boolean) - Method in class com.amazon.carbonado.repo.map.MapRepositoryBuilder
+
 
+
setMaster(boolean) - Method in class com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder
+
 
+
setMaster(boolean) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
 
+
setMaster(boolean) - Method in interface com.amazon.carbonado.RepositoryBuilder
+
+
Set to false if repository should not assume the role of master.
+
+
setMasterRepositoryBuilder(RepositoryBuilder) - Method in class com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder
+
+
Set "master" respository to replicate from, which is required.
+
+
setMatchedGeneration(int) - Method in interface com.amazon.carbonado.layout.StoredLayoutEquivalence
+
 
+
setMaxLocks(Integer) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
 
+
setMultiversion(boolean) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Set true to enable multiversion concurrency control (MVCC) on BDB + environment.
+
+
setName(String) - Method in class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder
+
 
+
setName(String) - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
 
+
setName(String) - Method in class com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder
+
 
+
setName(String) - Method in class com.amazon.carbonado.repo.map.MapRepositoryBuilder
+
 
+
setName(String) - Method in class com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder
+
 
+
setName(String) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
 
+
setName(String) - Method in interface com.amazon.carbonado.RepositoryBuilder
+
+
Set name for the repository, which is required.
+
+
setName(String) - Method in interface com.amazon.carbonado.sequence.StoredSequence
+
 
+
setName(String) - Method in interface com.amazon.carbonado.spi.StoredSequence
+
+
Deprecated.
+ 
+
setNextValue(long) - Method in interface com.amazon.carbonado.sequence.StoredSequence
+
 
+
setNextValue(long) - Method in interface com.amazon.carbonado.spi.StoredSequence
+
+
Deprecated.
+ 
+
setNullable(boolean) - Method in interface com.amazon.carbonado.layout.StoredLayoutProperty
+
 
+
setOrdinal(int) - Method in interface com.amazon.carbonado.layout.StoredLayoutProperty
+
 
+
setPanicHandler(BDBPanicHandler) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Set the handler to call if the database panics.
+
+
setPassword(String) - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
Optionally set the password to use with DataSource.
+
+
setPreShutdownHook(Runnable) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Sets a callback to be invoked before the repository has finished running + its own shutdown hooks.
+
+
setPrimaryKeyCheckDisabled(boolean) - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
By default, JDBCRepository makes sure that every declared primary key + in the database table for a Storable lines up with a declared + PrimaryKey or AlternateKey.
+
+
setPrimaryKeyMember(boolean) - Method in interface com.amazon.carbonado.layout.StoredLayoutProperty
+
 
+
setPrivate(boolean) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
When true, BDB environment cannot be shared by other processes, and + region files are not created.
+
+
setProduct(String) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Sets the BDB product to use, which defaults to JE.
+
+
setPropertyName(String) - Method in interface com.amazon.carbonado.layout.StoredLayoutProperty
+
 
+
setPropertyTypeDescriptor(String) - Method in interface com.amazon.carbonado.layout.StoredLayoutProperty
+
 
+
setPropertyValue(String, Object) - Method in interface com.amazon.carbonado.Storable
+
+
Sets a Storable property value by name.
+
+
setReadOnly(boolean) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Sets the repository to read-only mode.
+
+
setReplicaRepositoryBuilder(RepositoryBuilder) - Method in class com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder
+
+
Set "replica" respository to replicate to, which is required.
+
+
setReverseSplitOff(boolean) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Pass true to disable reverse split of B-tree nodes to reduce deadlocks.
+
+
setRunCheckpointer(boolean) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Disable automatic checkpointing of database if another process is + responsible for that.
+
+
setRunDeadlockDetector(boolean) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Disable automatic deadlock detection of database if another thread is + responsible for that.
+
+
setRunFullRecovery(boolean) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Pass true to override the default and run a full (catastrophic) recovery + when environment is opened.
+
+
setSchema(String) - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
Optionally set the schema to search for metadata.
+
+
setSequenceSelectStatement(String) - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
Override the default native sequence select statement with a printf.
+
+
setShutdownHook(Runnable) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Sets a callback to be invoked after repository has finished running its + own shutdown hooks.
+
+
setSingleFileName(String) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Specify that all BDB databases should reside in one file, except for log + files and caches.
+
+
setStorableCodecFactory(StorableCodecFactory) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Override the default storable codec factory.
+
+
setStorableTypeName(String) - Method in interface com.amazon.carbonado.layout.StoredLayout
+
 
+
setStorableTypeName(String) - Method in interface com.amazon.carbonado.layout.StoredLayoutEquivalence
+
 
+
setStorableWithPrimaryKey(Storable) - Method in exception com.amazon.carbonado.CorruptEncodingException
+
+
If the decoder can at least extract the primary key, it should set it here.
+
+
setStrictTriggers(boolean) - Method in class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder
+
+
Set to true to require that index maintenance triggers use a "for update" transaction, + avoiding deadlocks and lock upgrade failures.
+
+
setSuppressReload(boolean, String) - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
By default, JDBCRepository reloads Storables after every insert or + update.
+
+
setTransactionMaxActive(Integer) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Set the maximum number of concurrent transactions, or pass null to use + the default.
+
+
setTransactionNoSync(boolean) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
When true, commits are not immediately written or flushed to disk.
+
+
setTransactionTimeout(double) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Set the transaction timeout, in seconds.
+
+
setTransactionWriteNoSync(boolean) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
When true, commits are written, but they are not flushed to disk.
+
+
setUserName(String) - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
Optionally set the username to use with DataSource.
+
+
setValue(String) - Method in class com.amazon.carbonado.lob.AbstractBlob
+
 
+
setValue(String, String) - Method in class com.amazon.carbonado.lob.AbstractBlob
+
 
+
setValue(String, Charset) - Method in class com.amazon.carbonado.lob.AbstractBlob
+
 
+
setValue(String) - Method in class com.amazon.carbonado.lob.AbstractClob
+
 
+
setValue(String) - Method in interface com.amazon.carbonado.lob.Blob
+
+
Convenience method to overwrite all Blob data with the value of a single + String, applying UTF-8 encoding.
+
+
setValue(String, String) - Method in interface com.amazon.carbonado.lob.Blob
+
+
Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding.
+
+
setValue(String, Charset) - Method in interface com.amazon.carbonado.lob.Blob
+
+
Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding.
+
+
setValue(String) - Method in interface com.amazon.carbonado.lob.Clob
+
+
Convenience method to overwrite all Clob data with the value of a single + String.
+
+
setValue(String) - Method in class com.amazon.carbonado.lob.StringClob
+
 
+
setVersion(boolean) - Method in interface com.amazon.carbonado.layout.StoredLayoutProperty
+
 
+
setVersion(int) - Method in interface com.amazon.carbonado.sequence.StoredSequence
+
 
+
setVersion(int) - Method in class com.amazon.carbonado.spi.StoredLob.Block
+
 
+
setVersion(int) - Method in class com.amazon.carbonado.spi.StoredLob
+
 
+
setVersionNumber(int) - Method in interface com.amazon.carbonado.layout.StoredLayout
+
 
+
setVersionNumber(int) - Method in interface com.amazon.carbonado.layout.StoredLayoutEquivalence
+
 
+
setVersionNumber(int) - Method in interface com.amazon.carbonado.layout.StoredLayoutProperty
+
 
+
setVersionNumber(int) - Method in interface com.amazon.carbonado.repo.indexed.StoredIndexInfo
+
 
+
setVersionNumber(int) - Method in class com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo
+
 
+
setWrappedRepository(RepositoryBuilder) - Method in class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder
+
+
Set the required wrapped respository, which must support the + IndexInfoCapability.
+
+
shouldCopyDerived() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns true if this derived property should be included when copying a + storable.
+
+
shouldReverseOrder() - Method in class com.amazon.carbonado.qe.OrderingScore
+
+
Returns true if evaluated index must be iterated in reverse to achieve + the desired ordering.
+
+
shouldReverseRange() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns true if there is a range start or end match, but natural order + of matching property is descending.
+
+
shutdown() - Method in interface com.amazon.carbonado.capability.ShutdownCapability
+
+
Similar to calling close on a repository, except should only be called + when the virtual machine is in the process of shutting down.
+
+
shutdown() - Method in class com.amazon.carbonado.spi.AbstractRepository
+
 
+
shutdown() - Method in class com.amazon.carbonado.util.TaskQueueThread
+
+
Indicate that this task queue thread should finish running its enqueued + tasks and then exit.
+
+
ShutdownCapability - Interface in com.amazon.carbonado.capability
+
+
Capability for repositories that require special attention with the Java + virtual machine exits.
+
+
shutdownHook() - Method in class com.amazon.carbonado.spi.AbstractRepository
+
+
Install custom shutdown logic by overriding this method.
+
+
SimpleDataSource - Class in com.amazon.carbonado.repo.jdbc
+
+
SimpleDataSource does not implement any connection pooling.
+
+
SimpleDataSource(String, String, Properties) - Constructor for class com.amazon.carbonado.repo.jdbc.SimpleDataSource
+
 
+
SimpleDataSource(String, String, String, String) - Constructor for class com.amazon.carbonado.repo.jdbc.SimpleDataSource
+
 
+
SimpleDataSource(String, String, String, String, Properties) - Constructor for class com.amazon.carbonado.repo.jdbc.SimpleDataSource
+
 
+
SingletonCursor<S> - Class in com.amazon.carbonado.cursor
+
+
Special cursor implementation that returns only one element.
+
+
SingletonCursor(S) - Constructor for class com.amazon.carbonado.cursor.SingletonCursor
+
 
+
size() - Method in class com.amazon.carbonado.cursor.MergeSortBuffer
+
 
+
size() - Method in class com.amazon.carbonado.gen.StorablePropertyMap
+
 
+
size() - Method in class com.amazon.carbonado.qe.OrderingList
+
 
+
size() - Method in class com.amazon.carbonado.util.SoftValuedCache
+
+
Deprecated.
+ 
+
skip(long) - Method in class com.amazon.carbonado.spi.RAFInputStream
+
 
+
SkipCursor<S> - Class in com.amazon.carbonado.cursor
+
+
Wraps another cursor to skip an initial amount of elements.
+
+
SkipCursor(Cursor<S>, long) - Constructor for class com.amazon.carbonado.cursor.SkipCursor
+
 
+
skipNext(int) - Method in class com.amazon.carbonado.cursor.AbstractCursor
+
 
+
skipNext(int) - Method in class com.amazon.carbonado.cursor.EmptyCursor
+
+
Always returns 0.
+
+
skipNext(int) - Method in class com.amazon.carbonado.cursor.FilteredCursor
+
 
+
skipNext(int) - Method in class com.amazon.carbonado.cursor.GroupedCursor
+
 
+
skipNext(int) - Method in class com.amazon.carbonado.cursor.LimitCursor
+
 
+
skipNext(int) - Method in class com.amazon.carbonado.cursor.MultiTransformedCursor
+
 
+
skipNext(int) - Method in class com.amazon.carbonado.cursor.SingletonCursor
+
 
+
skipNext(int) - Method in class com.amazon.carbonado.cursor.SkipCursor
+
 
+
skipNext(int) - Method in interface com.amazon.carbonado.Cursor
+
+
Skips forward by the specified amount of elements, returning the actual + amount skipped.
+
+
skipNext(int) - Method in class com.amazon.carbonado.cursor.SortedCursor
+
 
+
skipNext(int) - Method in class com.amazon.carbonado.cursor.ThrottledCursor
+
 
+
skipNext(int) - Method in class com.amazon.carbonado.cursor.TransformedCursor
+
 
+
skipNext(int) - Method in class com.amazon.carbonado.raw.RawCursor
+
 
+
SoftValuedCache<K,V> - Class in com.amazon.carbonado.util
+
+
Deprecated. +
use Cojen Cache interface
+
+
+
SoftValuedCache() - Constructor for class com.amazon.carbonado.util.SoftValuedCache
+
+
Deprecated.
+ 
+
sort() - Method in class com.amazon.carbonado.cursor.ArraySortBuffer
+
 
+
sort() - Method in class com.amazon.carbonado.cursor.MergeSortBuffer
+
 
+
sort() - Method in interface com.amazon.carbonado.cursor.SortBuffer
+
+
Finish sorting buffer.
+
+
SortBuffer<S> - Interface in com.amazon.carbonado.cursor
+
+
Buffers up Storable instances allowing them to be sorted.
+
+
SortedCursor<S> - Class in com.amazon.carbonado.cursor
+
+
Wraps another Cursor and ensures the results are sorted.
+
+
SortedCursor(Cursor<S>, SortBuffer<S>, Comparator<S>, Comparator<S>) - Constructor for class com.amazon.carbonado.cursor.SortedCursor
+
 
+
SortedCursor(Cursor<S>, SortBuffer<S>, Class<S>, String...) - Constructor for class com.amazon.carbonado.cursor.SortedCursor
+
 
+
SortedQueryExecutor<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
QueryExecutor which wraps another and sorts the results.
+
+
SortedQueryExecutor(SortedQueryExecutor.Support<S>, QueryExecutor<S>, OrderingList<S>, OrderingList<S>) - Constructor for class com.amazon.carbonado.qe.SortedQueryExecutor
+
 
+
SortedQueryExecutor.ArraySortSupport<S extends Storable> - Class in com.amazon.carbonado.qe
+
 
+
SortedQueryExecutor.ArraySortSupport() - Constructor for class com.amazon.carbonado.qe.SortedQueryExecutor.ArraySortSupport
+
 
+
SortedQueryExecutor.MergeSortSupport<S extends Storable> - Class in com.amazon.carbonado.qe
+
 
+
SortedQueryExecutor.MergeSortSupport() - Constructor for class com.amazon.carbonado.qe.SortedQueryExecutor.MergeSortSupport
+
 
+
SortedQueryExecutor.Support<S extends Storable> - Interface in com.amazon.carbonado.qe
+
+
Provides support for SortedQueryExecutor.
+
+
StandardQuery<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
Abstract query implementation which uses a QueryExecutor.
+
+
StandardQuery(Filter<S>, FilterValues<S>, OrderingList<S>, QueryHints) - Constructor for class com.amazon.carbonado.qe.StandardQuery
+
 
+
StandardQueryFactory<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
Builds and caches StandardQuery instances.
+
+
StandardQueryFactory(Class<S>) - Constructor for class com.amazon.carbonado.qe.StandardQueryFactory
+
 
+
StandardQueryFactory(Class<S>, boolean) - Constructor for class com.amazon.carbonado.qe.StandardQueryFactory
+
 
+
startBackup() - Method in interface com.amazon.carbonado.repo.sleepycat.HotBackupCapability
+
+
Starts the backup by disabling log file deletion.
+
+
startBackup(boolean) - Method in interface com.amazon.carbonado.repo.sleepycat.HotBackupCapability
+
+
Starts the backup by disabling log file deletion.
+
+
startIncrementalBackup(long) - Method in interface com.amazon.carbonado.repo.sleepycat.HotBackupCapability
+
+
Starts an incremental backup.
+
+
startIncrementalBackup(long, boolean) - Method in interface com.amazon.carbonado.repo.sleepycat.HotBackupCapability
+
+
Starts an incremental backup.
+
+
Storable<S extends Storable<S>> - Interface in com.amazon.carbonado
+
+
A data access object in a Repository.
+
+
STORABLE_TYPE_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
StorableCodec<S extends Storable> - Interface in com.amazon.carbonado.raw
+
+
Supports encoding and decoding of storables.
+
+
StorableCodecFactory - Interface in com.amazon.carbonado.raw
+
+
Factory for creating instances of StorableCodec.
+
+
StorableCopier<S extends Storable,T extends Storable> - Class in com.amazon.carbonado.gen
+
+
Copies properties between otherwise incompatible Storables.
+
+
StorableCopier() - Constructor for class com.amazon.carbonado.gen.StorableCopier
+
 
+
StorableCopier.From<S extends Storable> - Class in com.amazon.carbonado.gen
+
 
+
StorableGenerator<S extends Storable> - Class in com.amazon.carbonado.gen
+
+
Generates and caches abstract implementations of Storable + types.
+
+
StorableIndex<S extends Storable> - Class in com.amazon.carbonado.info
+
+
Represents an index that must be defined for a specific Storable type.
+
+
StorableIndex(StorableProperty<S>[], Direction[]) - Constructor for class com.amazon.carbonado.info.StorableIndex
+
+
Creates a StorableIndex from the given properties and matching + directions.
+
+
StorableIndex(StorableProperty<S>[], Direction[], boolean) - Constructor for class com.amazon.carbonado.info.StorableIndex
+
+
Creates a StorableIndex from the given properties and matching + directions.
+
+
StorableIndex(StorableProperty<S>[], Direction[], boolean, boolean) - Constructor for class com.amazon.carbonado.info.StorableIndex
+
+
Creates a StorableIndex from the given properties and matching + directions.
+
+
StorableIndex(StorableKey<S>, Direction) - Constructor for class com.amazon.carbonado.info.StorableIndex
+
+
Creates a StorableIndex from a StorableKey.
+
+
StorableIndex(OrderedProperty<S>[], Direction) - Constructor for class com.amazon.carbonado.info.StorableIndex
+
+
Creates a StorableIndex from OrderedProperties.
+
+
StorableIndex(Class<S>, IndexInfo) - Constructor for class com.amazon.carbonado.info.StorableIndex
+
+
Creates a StorableIndex from an IndexInfo.
+
+
StorableIndexSet<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
Manages a set of StorableIndex objects, intended for reducing the + set such that the minimal amount of physical indexes need to be defined for + a specific type of Storable.
+
+
StorableIndexSet() - Constructor for class com.amazon.carbonado.qe.StorableIndexSet
+
 
+
StorableIndexSet(StorableIndexSet<S>) - Constructor for class com.amazon.carbonado.qe.StorableIndexSet
+
+
Copy constructor.
+
+
StorableInfo<S extends Storable> - Interface in com.amazon.carbonado.info
+
+
Contains all the metadata describing a specific Storable type.
+
+
StorableInfoCapability - Interface in com.amazon.carbonado.capability
+
+
Capability that returns information about known storable types in a + repository.
+
+
StorableIntrospector - Class in com.amazon.carbonado.info
+
+
Supports examination of Storable types, returning all metadata + associated with it.
+
+
StorableIntrospector() - Constructor for class com.amazon.carbonado.info.StorableIntrospector
+
 
+
StorableKey<S extends Storable> - Interface in com.amazon.carbonado.info
+
+
Represents a primary, alternate or partition key of a specific Storable type.
+
+
StorableProperty<S extends Storable> - Interface in com.amazon.carbonado.info
+
+
Contains all the metadata describing a property of a specific Storable type.
+
+
StorablePropertyAdapter - Class in com.amazon.carbonado.info
+
+
Information about an adapter annotation applied to a property.
+
+
StorablePropertyAdapter(String, Class<?>, Class<? extends Annotation>) - Constructor for class com.amazon.carbonado.info.StorablePropertyAdapter
+
+
Construct a generic StorablePropertyAdapter instance not attached to a + storable definition.
+
+
StorablePropertyAnnotation - Class in com.amazon.carbonado.info
+
+
Information about a custom annotation applied to a property.
+
+
StorablePropertyAnnotation(Annotation, Method) - Constructor for class com.amazon.carbonado.info.StorablePropertyAnnotation
+
+
Use this constructor if an annotation was actually defined.
+
+
StorablePropertyAnnotation(Class<? extends Annotation>, Method) - Constructor for class com.amazon.carbonado.info.StorablePropertyAnnotation
+
+
Use this constructor if an annotation was not defined, but instead is + being automatically applied.
+
+
StorablePropertyConstraint - Class in com.amazon.carbonado.info
+
+
Information about a constraint annotation applied to a property.
+
+
StorablePropertyInfo - Class in com.amazon.carbonado.raw
+
 
+
StorablePropertyMap<S extends Storable> - Class in com.amazon.carbonado.gen
+
+
Basic implementation for Storable.propertyMap() method.
+
+
StorableSupport<S extends Storable> - Interface in com.amazon.carbonado.gen
+
+
Provides runtime support for Storable classes generated by StorableGenerator.
+
+
storableType() - Method in interface com.amazon.carbonado.Storable
+
+
Returns the class or interface from which this storable was + generated.
+
+
Storage<S extends Storable> - Interface in com.amazon.carbonado
+
+
Access for a specific type of Storable from a Repository.
+
+
STORAGE_FOR_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Repository API method name
+
+
StorageAccess<S extends Storable> - Interface in com.amazon.carbonado.qe
+
+
Provides internal access to a Storage, necessary for query + execution.
+
+
storageAccessFor(Class<S>) - Method in interface com.amazon.carbonado.qe.RepositoryAccess
+
+
Returns a StorageAccess instance for the given user defined Storable + class or interface.
+
+
storageDelegate(StorableIndex<S>) - Method in interface com.amazon.carbonado.qe.StorageAccess
+
+
If the given index is not directly supported by storage, queries should + be delegated.
+
+
storageFor(Class<S>) - Method in interface com.amazon.carbonado.Repository
+
+
Returns a Storage instance for the given user defined Storable class or + interface.
+
+
storageFor(Class<S>) - Method in class com.amazon.carbonado.spi.AbstractRepository
+
 
+
StoragePool - Class in com.amazon.carbonado.spi
+
+
A concurrent pool of strongly referenced Storage instances mapped by + Storable type.
+
+
StoragePool() - Constructor for class com.amazon.carbonado.spi.StoragePool
+
 
+
store(S, byte[], byte[]) - Method in interface com.amazon.carbonado.raw.RawSupport
+
+
Try to store the entry referenced by the given key with the given + value.
+
+
StoredDatabaseInfo - Class in com.amazon.carbonado.repo.sleepycat
+
+
Stores basic information about the BDB databases managed by BDBRepository.
+
+
StoredDatabaseInfo() - Constructor for class com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo
+
 
+
StoredIndexInfo - Interface in com.amazon.carbonado.repo.indexed
+
+
Stores basic information about the indexes managed by IndexedRepository.
+
+
StoredLayout - Interface in com.amazon.carbonado.layout
+
+
Stored information regarding the layout of a Storable type, which is used + internally by Layout.
+
+
StoredLayoutEquivalence - Interface in com.amazon.carbonado.layout
+
+
Maps layout generations which are equivalent.
+
+
StoredLayoutProperty - Interface in com.amazon.carbonado.layout
+
+
Stored property joined to a StoredLayout, which is used internally + by LayoutProperty.
+
+
StoredLob - Class in com.amazon.carbonado.spi
+
+
Can be used internally by repositories for supporting Lobs.
+
+
StoredLob() - Constructor for class com.amazon.carbonado.spi.StoredLob
+
 
+
StoredLob.Block - Class in com.amazon.carbonado.spi
+
+
Blocks stored here.
+
+
StoredLob.Block() - Constructor for class com.amazon.carbonado.spi.StoredLob.Block
+
 
+
StoredSequence - Interface in com.amazon.carbonado.sequence
+
+
Stores data for SequenceValueGenerator.
+
+
StoredSequence - Interface in com.amazon.carbonado.spi
+
+
Deprecated. +
Replaced by StoredSequence
+
+
+
storePropertyValue(CodeAssembler, StorablePropertyInfo, boolean, LocalVariable, Class<?>) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Generates code to store a property value into an instance which is + already on the operand stack.
+
+
StringClob - Class in com.amazon.carbonado.lob
+
+
Implementation of a Clob which is backed by a read-only String.
+
+
StringClob(String) - Constructor for class com.amazon.carbonado.lob.StringClob
+
 
+
subList(int, int) - Method in class com.amazon.carbonado.qe.OrderingList
+
 
+
SUPPORT_FIELD_NAME - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Reference to TriggerSupport instance
+
+
SupportException - Exception in com.amazon.carbonado
+
+
Indicates that an action cannot be supported by the Repository it is being requested from.
+
+
SupportException() - Constructor for exception com.amazon.carbonado.SupportException
+
 
+
SupportException(String) - Constructor for exception com.amazon.carbonado.SupportException
+
 
+
SupportException(String, Throwable) - Constructor for exception com.amazon.carbonado.SupportException
+
 
+
SupportException(Throwable) - Constructor for exception com.amazon.carbonado.SupportException
+
 
+
supportsForUpdate() - Method in class com.amazon.carbonado.txn.TransactionManager
+
+
Return true if transactions support "for update" mode.
+
+
suspendCheckpointer(long) - Method in interface com.amazon.carbonado.repo.sleepycat.CheckpointCapability
+
+
Suspend the checkpointer until the suspension time has expired or until + manually resumed.
+
+
SymmetricDifferenceCursor<S> - Class in com.amazon.carbonado.cursor
+
+
Wraps two Cursors and performs a symmetric set difference + operation.
+
+
SymmetricDifferenceCursor(Cursor<S>, Cursor<S>, Comparator<S>) - Constructor for class com.amazon.carbonado.cursor.SymmetricDifferenceCursor
+
 
+
sync() - Method in interface com.amazon.carbonado.repo.sleepycat.CheckpointCapability
+
+
Synchronously flushes changes to stable storage, which is cheaper than + performing a checkpoint.
+
+
SyntheticBuilder - Interface in com.amazon.carbonado.synthetic
+
+
A synthetic builder provides a mechanism for creating a user storable from scratch.
+
+
SyntheticBuilder.ClassNameProvider - Interface in com.amazon.carbonado.synthetic
+
+
Interface used to get the name for the class to generate.
+
+
SyntheticIndex - Class in com.amazon.carbonado.synthetic
+
+
Specification of a collection of properties which will participate in an index.
+
+
SyntheticKey - Class in com.amazon.carbonado.synthetic
+
+
Specification of a collection of properties which will participate in a key.
+
+
SyntheticProperty - Class in com.amazon.carbonado.synthetic
+
+
Minimal specification of a storable property for use with a SyntheticStorableBuilder.
+
+
SyntheticProperty(String, Class) - Constructor for class com.amazon.carbonado.synthetic.SyntheticProperty
+
+
Every property requires minimally a name and a type
+
+
SyntheticProperty(String, Class, boolean, boolean) - Constructor for class com.amazon.carbonado.synthetic.SyntheticProperty
+
 
+
SyntheticPropertyList - Class in com.amazon.carbonado.synthetic
+
+
Specification of a collection of properties which will participate in a key + or index.
+
+
SyntheticStorableBuilder - Class in com.amazon.carbonado.synthetic
+
+
Allows the definition of very simple synthetic storables.
+
+
SyntheticStorableBuilder(String, ClassLoader) - Constructor for class com.amazon.carbonado.synthetic.SyntheticStorableBuilder
+
 
+
SyntheticStorableReferenceAccess<S extends Storable> - Class in com.amazon.carbonado.synthetic
+
+
Provides access to the generated storable reference class and utility + methods.
+
+
SyntheticStorableReferenceBuilder<S extends Storable> - Class in com.amazon.carbonado.synthetic
+
+
A SyntheticStorableReference defines new kinds of Storables from an existing + master storable.
+
+
SyntheticStorableReferenceBuilder(Class<S>, boolean) - Constructor for class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder
+
 
+
SyntheticStorableReferenceBuilder(Class<S>, String, boolean) - Constructor for class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder
+
 
+
+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.

+ + diff --git a/apidocs/index-files/index-2.html b/apidocs/index-files/index-2.html new file mode 100644 index 0000000..8c980bc --- /dev/null +++ b/apidocs/index-files/index-2.html @@ -0,0 +1,415 @@ + + + + + + +B-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  + + +

B

+
+
backoff(E, int, int) - Static method in exception com.amazon.carbonado.RepositoryException
+
+
One strategy for resolving an optimistic lock failure is to try the + operation again, after waiting some bounded random amount of time.
+
+
BDBPanicHandler - Interface in com.amazon.carbonado.repo.sleepycat
+
+
Interface for a generic panic handler for any BDB products.
+
+
BDBProduct - Enum in com.amazon.carbonado.repo.sleepycat
+
+
Set of supported BDB products.
+
+
BDBRepositoryBuilder - Class in com.amazon.carbonado.repo.sleepycat
+
+
Builder and configuration options for BDBRepository.
+
+
BDBRepositoryBuilder() - Constructor for class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
 
+
BDBRepositoryBuilder.DatabaseHook - Interface in com.amazon.carbonado.repo.sleepycat
+
 
+
beforeDelete(S) - Method in class com.amazon.carbonado.capability.ResyncCapability.Listener
+
+
Called before a bogus storable is to be deleted.
+
+
beforeDelete(S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeDelete(Transaction, S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeDelete(S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be deleted.
+
+
beforeDelete(Transaction, S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be deleted.
+
+
beforeInsert(S) - Method in class com.amazon.carbonado.capability.ResyncCapability.Listener
+
+
Called before a sync'd storable is to be inserted.
+
+
beforeInsert(S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeInsert(Transaction, S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeInsert(S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be inserted.
+
+
beforeInsert(Transaction, S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be inserted.
+
+
beforeTryDelete(S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeTryDelete(Transaction, S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeTryDelete(S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be deleted via tryDelete.
+
+
beforeTryDelete(Transaction, S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be deleted via tryDelete.
+
+
beforeTryInsert(S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeTryInsert(Transaction, S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeTryInsert(S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be inserted via tryInsert.
+
+
beforeTryInsert(Transaction, S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be inserted via tryInsert.
+
+
beforeTryUpdate(S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeTryUpdate(Transaction, S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeTryUpdate(S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be updated via tryUpdate.
+
+
beforeTryUpdate(Transaction, S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be updated via tryUpdate.
+
+
beforeUpdate(S) - Method in class com.amazon.carbonado.capability.ResyncCapability.Listener
+
+
Called before a sync'd storable is to be updated.
+
+
beforeUpdate(S, S) - Method in class com.amazon.carbonado.capability.ResyncCapability.Listener
+
+
Overloaded version of beforeUpdate method which is passed the + storable in it's out-of-sync and sync'd states.
+
+
beforeUpdate(S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeUpdate(Transaction, S) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
beforeUpdate(S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be updated.
+
+
beforeUpdate(Transaction, S) - Method in class com.amazon.carbonado.Trigger
+
+
Called before a storable is to be updated.
+
+
begin() - Method in interface com.amazon.carbonado.Query.Controller
+
+
Called by query when it begins, possibly multiple times.
+
+
begin() - Method in class com.amazon.carbonado.Query.Timeout
+
 
+
beginCall(RemoteProcedure<R, D>) - Method in interface com.amazon.carbonado.capability.RemoteProcedureCapability
+
+
Begins a call to execute the given procedure on a remote host.
+
+
beginGroup(S) - Method in class com.amazon.carbonado.cursor.GroupedCursor
+
+
This method is called for the first entry in a group.
+
+
beginReply() - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Request
+
+
Begin a reply after receiving all data.
+
+
BelatedCreationException - Exception in com.amazon.carbonado.util
+
+
Exception throw when attempting to perform an unavailable operation on an + object undergoing belated creation.
+
+
BelatedCreationException(String) - Constructor for exception com.amazon.carbonado.util.BelatedCreationException
+
+
Create a new exception with the given message.
+
+
BelatedCreationException(String, Throwable) - Constructor for exception com.amazon.carbonado.util.BelatedCreationException
+
+
Create a new exception with the given message and cause.
+
+
BelatedCreator<T,E extends java.lang.Exception> - Class in com.amazon.carbonado.util
+
+
Generic one-shot factory which supports late object creation.
+
+
BelatedCreator(Class<T>, int) - Constructor for class com.amazon.carbonado.util.BelatedCreator
+
 
+
BelatedRepositoryCreator - Class in com.amazon.carbonado.spi
+
+
Generic one-shot Repository builder which supports late object creation.
+
+
BelatedRepositoryCreator(Log, RepositoryBuilder, int) - Constructor for class com.amazon.carbonado.spi.BelatedRepositoryCreator
+
 
+
BelatedRepositoryCreator(Log, RepositoryBuilder, AtomicReference<Repository>, int) - Constructor for class com.amazon.carbonado.spi.BelatedRepositoryCreator
+
 
+
BelatedStorageCreator<S extends Storable> - Class in com.amazon.carbonado.spi
+
+
Generic one-shot Storage creator which supports late object creation.
+
+
BelatedStorageCreator(Log, Repository, Class<S>, int) - Constructor for class com.amazon.carbonado.spi.BelatedStorageCreator
+
 
+
BinaryOpFilter<S extends Storable> - Class in com.amazon.carbonado.filter
+
+
Base class for filter tree nodes that have a left and right child.
+
+
bind() - Method in class com.amazon.carbonado.filter.BinaryOpFilter
+
 
+
bind() - Method in class com.amazon.carbonado.filter.ClosedFilter
+
 
+
bind() - Method in class com.amazon.carbonado.filter.ExistsFilter
+
 
+
bind() - Method in class com.amazon.carbonado.filter.Filter
+
+
Walks through each property filter, assigning a bind ID to it.
+
+
bind() - Method in class com.amazon.carbonado.filter.OpenFilter
+
 
+
bind() - Method in class com.amazon.carbonado.filter.PropertyFilter
+
 
+
bindQueryParam(Class) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Determines which overloaded "with" method on Query should be bound to.
+
+
blankValue(CodeBuilder, TypeDesc) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Generates code to push a blank value to the stack.
+
+
Blob - Interface in com.amazon.carbonado.lob
+
+
Provides access to BLOBs, which are Binary Large OBjects.
+
+
BlobClob - Class in com.amazon.carbonado.lob
+
+
A Clob implementation which is backed by a Blob.
+
+
BlobClob(Blob) - Constructor for class com.amazon.carbonado.lob.BlobClob
+
 
+
BoundaryType - Enum in com.amazon.carbonado.qe
+
+
Describes a value range boundary.
+
+
build(RepositoryAccess, ChainedProperty<T>, Filter<T>, OrderingList<T>, QueryHints) - Static method in class com.amazon.carbonado.qe.JoinedQueryExecutor
+
+
Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins.
+
+
build(AtomicReference<Repository>) - Method in class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder
+
 
+
build(AtomicReference<Repository>) - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
 
+
build(AtomicReference<Repository>) - Method in class com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder
+
 
+
build(AtomicReference<Repository>) - Method in class com.amazon.carbonado.repo.map.MapRepositoryBuilder
+
 
+
build(AtomicReference<Repository>) - Method in class com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder
+
 
+
build(AtomicReference<Repository>) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
 
+
build() - Method in interface com.amazon.carbonado.RepositoryBuilder
+
+
Builds a repository instance.
+
+
build(AtomicReference<Repository>) - Method in interface com.amazon.carbonado.RepositoryBuilder
+
+
Builds a repository instance.
+
+
build() - Method in class com.amazon.carbonado.spi.AbstractRepositoryBuilder
+
 
+
build() - Method in class com.amazon.carbonado.synthetic.ClassFileBuilder
+
+
Defines the class for this generator
+
+
build() - Method in interface com.amazon.carbonado.synthetic.SyntheticBuilder
+
+
Convenience method to generate the class.
+
+
build() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableBuilder
+
 
+
build() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder
+
 
+
build(Class<C>) - Static method in class com.amazon.carbonado.util.Converter
+
 
+
buildClass(Class<C>) - Static method in class com.amazon.carbonado.util.Converter
+
 
+
buildDataDecoding(CodeAssembler, StorableProperty<S>[], LocalVariable, Class<?>, boolean, int, Label, LocalVariable) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Generates bytecode instructions to decode properties.
+
+
buildDataEncoding(CodeAssembler, StorableProperty<S>[], LocalVariable, Class<?>, boolean, int) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Generates bytecode instructions to encode properties.
+
+
buildKeyDecoding(CodeAssembler, OrderedProperty<S>[], LocalVariable, Class<?>, boolean, LocalVariable) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Generates bytecode instructions to decode properties.
+
+
buildKeyEncoding(CodeAssembler, OrderedProperty<S>[], LocalVariable, Class<?>, boolean, LocalVariable, LocalVariable) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Generates bytecode instructions to encode properties.
+
+
buildPkIndex(String...) - Method in class com.amazon.carbonado.raw.CustomStorableCodec
+
+
Convenient way to define the clustered primary key index + descriptor.
+
+
buildRootAnnotation(TypeDesc) - Method in class com.amazon.carbonado.util.AnnotationDescParser
+
+
Override this method if a root annotation is not provided, as it must be + built after parsing the root annotation type.
+
+
buildSerialDecoding(CodeAssembler, StorableProperty<S>[], LocalVariable) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Generates bytecode instructions to decode properties and their states.
+
+
buildSerialEncoding(CodeAssembler, StorableProperty<S>[]) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Generates bytecode instructions to encode properties and their + states.
+
+
ByteArrayBlob - Class in com.amazon.carbonado.lob
+
+
Implementation of a Blob which is backed by a growable in-memory byte array.
+
+
ByteArrayBlob(int) - Constructor for class com.amazon.carbonado.lob.ByteArrayBlob
+
+
Construct a ByteArrayBlob with the given initial capacity.
+
+
ByteArrayBlob(byte[]) - Constructor for class com.amazon.carbonado.lob.ByteArrayBlob
+
+
Construct a ByteArrayBlob initially backed by the given byte array.
+
+
ByteArrayBlob(byte[], int) - Constructor for class com.amazon.carbonado.lob.ByteArrayBlob
+
+
Construct a ByteArrayBlob initially backed by the given byte array.
+
+
+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.

+ + diff --git a/apidocs/index-files/index-20.html b/apidocs/index-files/index-20.html new file mode 100644 index 0000000..df53699 --- /dev/null +++ b/apidocs/index-files/index-20.html @@ -0,0 +1,611 @@ + + + + + + +T-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  + + +

T

+
+
tail() - Method in class com.amazon.carbonado.info.ChainedProperty
+
+
Returns a new ChainedProperty which contains everything that follows + this ChainedProperty's prime property.
+
+
TaskQueueThread - Class in com.amazon.carbonado.util
+
+
Simple generic queue for running tasks from a single thread.
+
+
TaskQueueThread(String, int) - Constructor for class com.amazon.carbonado.util.TaskQueueThread
+
 
+
TaskQueueThread(String, int, long) - Constructor for class com.amazon.carbonado.util.TaskQueueThread
+
 
+
TextAdapter - Annotation Type in com.amazon.carbonado.adapter
+
+
Converts database Blobs and Clobs to Strings.
+
+
TextAdapter.Adapter - Class in com.amazon.carbonado.adapter
+
+
Adapter implementation for TextAdapter.
+
+
TextAdapter.Adapter(Class<?>, String, TextAdapter) - Constructor for class com.amazon.carbonado.adapter.TextAdapter.Adapter
+
 
+
TextAdapter.Adapter(Class<?>, String, String) - Constructor for class com.amazon.carbonado.adapter.TextAdapter.Adapter
+
 
+
TextAdapter.Adapter(Class<?>, String, Charset) - Constructor for class com.amazon.carbonado.adapter.TextAdapter.Adapter
+
 
+
TextAdapter.Adapter(Class<?>, String, Charset, Charset[]) - Constructor for class com.amazon.carbonado.adapter.TextAdapter.Adapter
+
 
+
TextConstraint - Annotation Type in com.amazon.carbonado.constraint
+
+
Limits the value of a property to be a member of a specific set.
+
+
TextConstraint.Constraint - Class in com.amazon.carbonado.constraint
+
+
Constraint implementation for TextConstraint.
+
+
TextConstraint.Constraint(Class<?>, String, TextConstraint) - Constructor for class com.amazon.carbonado.constraint.TextConstraint.Constraint
+
 
+
TextConstraint.Constraint(Class<?>, String, String[], String[]) - Constructor for class com.amazon.carbonado.constraint.TextConstraint.Constraint
+
 
+
the() - Static method in class com.amazon.carbonado.cursor.EmptyCursor
+
+
Returns the empty cursor instance.
+
+
Throttle - Class in com.amazon.carbonado.util
+
+
General purpose class for throttling work relative to its actual measured + performance.
+
+
Throttle(int) - Constructor for class com.amazon.carbonado.util.Throttle
+
 
+
throttle(double, long) - Method in class com.amazon.carbonado.util.Throttle
+
 
+
ThrottledCursor<S> - Class in com.amazon.carbonado.cursor
+
+
Wraps another cursor and fetches results at a reduced speed.
+
+
ThrottledCursor(Cursor<S>, double) - Constructor for class com.amazon.carbonado.cursor.ThrottledCursor
+
 
+
throwConcatException(CodeBuilder, Class, String...) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Generate code to throw an exception with a message concatenated at runtime.
+
+
throwException(CodeBuilder, Class, String) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Generate code to throw an exception with an optional message.
+
+
ThrowUnchecked - Class in com.amazon.carbonado.util
+
+
Deprecated. +
use ThrowUnchecked instead
+
+
+
ThrowUnchecked() - Constructor for class com.amazon.carbonado.util.ThrowUnchecked
+
+
Deprecated.
+ 
+
timedOutNotification(long) - Method in class com.amazon.carbonado.spi.BelatedRepositoryCreator
+
 
+
timedOutNotification(long) - Method in class com.amazon.carbonado.spi.BelatedStorageCreator
+
 
+
timedOutNotification(long) - Method in class com.amazon.carbonado.util.BelatedCreator
+
+
Notification that createReal is taking too long.
+
+
to(Class<T>) - Method in class com.amazon.carbonado.gen.StorableCopier.From
+
 
+
TO_STRING_KEY_ONLY_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
TO_STRING_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
toCharacter() - Method in enum com.amazon.carbonado.info.Direction
+
+
Returns '+' for ASCENDING, '-' for DESCENDING, and '~' for UNSPECIFIED.
+
+
toFetchException(Throwable) - Method in interface com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability
+
+
Transforms the given throwable into an appropriate fetch exception.
+
+
toFetchException() - Method in exception com.amazon.carbonado.RepositoryException
+
+
Converts RepositoryException into an appropriate FetchException.
+
+
toFetchException(String) - Method in exception com.amazon.carbonado.RepositoryException
+
+
Converts RepositoryException into an appropriate FetchException, prepending + the specified message.
+
+
toFetchException(Throwable) - Method in class com.amazon.carbonado.spi.ExceptionTransformer
+
+
Transforms the given throwable into an appropriate fetch exception.
+
+
toFirst() - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Move the cursor to the first available entry.
+
+
toFirst(byte[]) - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Move the cursor to the first available entry at or after the given + key.
+
+
toLast() - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Move the cursor to the last available entry.
+
+
toLast(byte[]) - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Move the cursor to the last available entry at or before the given + key.
+
+
toList() - Method in class com.amazon.carbonado.cursor.AbstractCursor
+
 
+
toList(int) - Method in class com.amazon.carbonado.cursor.AbstractCursor
+
 
+
toList() - Method in class com.amazon.carbonado.cursor.EmptyCursor
+
+
Always returns an empty list.
+
+
toList(int) - Method in class com.amazon.carbonado.cursor.EmptyCursor
+
+
Always returns an empty list.
+
+
toList() - Method in class com.amazon.carbonado.cursor.SingletonCursor
+
 
+
toList(int) - Method in class com.amazon.carbonado.cursor.SingletonCursor
+
 
+
toList() - Method in interface com.amazon.carbonado.Cursor
+
+
Copies all remaining next elements into a new modifiable list.
+
+
toList(int) - Method in interface com.amazon.carbonado.Cursor
+
+
Copies a limited amount of remaining next elements into a new modifiable + list.
+
+
toNext() - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Move the cursor to the next available entry, returning false if none.
+
+
toNext(int) - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Move the cursor to the next available entry, incrementing by the amount + given.
+
+
toNextKey() - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Move the cursor to the next unique key, returning false if none.
+
+
toPersistException(Throwable) - Method in interface com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability
+
+
Transforms the given throwable into an appropriate persist exception.
+
+
toPersistException() - Method in exception com.amazon.carbonado.RepositoryException
+
+
Converts RepositoryException into an appropriate PersistException.
+
+
toPersistException(String) - Method in exception com.amazon.carbonado.RepositoryException
+
+
Converts RepositoryException into an appropriate PersistException, prepending + the specified message.
+
+
toPersistException(Throwable) - Method in class com.amazon.carbonado.spi.ExceptionTransformer
+
+
Transforms the given throwable into an appropriate persist exception.
+
+
toPrevious() - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Move the cursor to the previous available entry, returning false if + none.
+
+
toPrevious(int) - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Move the cursor to the previous available entry, decrementing by the + amount given.
+
+
toPreviousKey() - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Move the cursor to the previous unique key, returning false if none.
+
+
toRepositoryException(Throwable) - Method in class com.amazon.carbonado.spi.ExceptionTransformer
+
+
Transforms the given throwable into an appropriate repository + exception.
+
+
toString() - Method in class com.amazon.carbonado.filter.ClosedFilter
+
 
+
toString() - Method in class com.amazon.carbonado.filter.Filter.NotJoined
+
 
+
toString() - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns the string value of this filter, which is also parsable.
+
+
toString() - Method in class com.amazon.carbonado.filter.FilterValues
+
+
Returns the string value of the filter with any values substituted.
+
+
toString() - Method in class com.amazon.carbonado.filter.OpenFilter
+
 
+
toString() - Method in enum com.amazon.carbonado.filter.RelOp
+
+
Returns one of "=", "!=", "<", ">=", ">", or "<=".
+
+
toString() - Method in class com.amazon.carbonado.info.ChainedProperty
+
+
Returns the chained property formatted as "name.subname.subsubname".
+
+
toString() - Method in class com.amazon.carbonado.info.OrderedProperty
+
+
Returns the chained property in a parseable form.
+
+
toString() - Method in class com.amazon.carbonado.info.StorableIndex
+
 
+
toString() - Method in interface com.amazon.carbonado.info.StorableProperty
+
 
+
toString() - Method in class com.amazon.carbonado.layout.Layout
+
 
+
toString() - Method in class com.amazon.carbonado.layout.LayoutProperty
+
 
+
toString() - Method in class com.amazon.carbonado.lob.AbstractBlob
+
 
+
toString() - Method in class com.amazon.carbonado.lob.AbstractClob
+
 
+
toString() - Method in class com.amazon.carbonado.qe.AbstractQuery
+
+
Implementation calls appendTo.
+
+
toString() - Method in class com.amazon.carbonado.qe.CompositeScore
+
 
+
toString() - Method in class com.amazon.carbonado.qe.FilteringScore
+
 
+
toString() - Method in class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result
+
 
+
toString() - Method in class com.amazon.carbonado.qe.OrderingScore
+
 
+
toString() - Method in class com.amazon.carbonado.qe.QueryHints
+
 
+
toString() - Method in class com.amazon.carbonado.Query.Timeout
+
 
+
toString() - Method in interface com.amazon.carbonado.Query
+
+
Returns a description of the query filter and any other arguments.
+
+
toString() - Method in class com.amazon.carbonado.raw.StorablePropertyInfo
+
 
+
toString() - Method in class com.amazon.carbonado.spi.IndexInfoImpl
+
 
+
toString() - Method in interface com.amazon.carbonado.Storable
+
+
Returns a string for debugging purposes that contains all supported + property names and values for this object.
+
+
toString() - Method in class com.amazon.carbonado.synthetic.SyntheticProperty
+
 
+
toString() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableBuilder
+
 
+
toString() - Method in class com.amazon.carbonado.util.SoftValuedCache
+
+
Deprecated.
+ 
+
toStringKeyOnly() - Method in interface com.amazon.carbonado.Storable
+
+
Returns a string for debugging purposes that contains supported key + property names and values for this object.
+
+
Transaction - Interface in com.amazon.carbonado
+
+
Transactions define atomic operations which can be committed or aborted as a + unit.
+
+
transactionManager() - Method in class com.amazon.carbonado.spi.AbstractRepository
+
+
Returns the repository's TransactionManager.
+
+
TransactionManager<Txn> - Class in com.amazon.carbonado.txn
+
+
Generic transaction manager for repositories.
+
+
TransactionManager() - Constructor for class com.amazon.carbonado.txn.TransactionManager
+
 
+
TransactionManager(TransactionMonitor) - Constructor for class com.amazon.carbonado.txn.TransactionManager
+
 
+
TransactionMonitor - Interface in com.amazon.carbonado.txn
+
+
Is notified as transactions enter and exit.
+
+
TransactionPair - Class in com.amazon.carbonado.txn
+
+
Pairs two transaction together into one.
+
+
TransactionPair(Transaction, Transaction) - Constructor for class com.amazon.carbonado.txn.TransactionPair
+
 
+
TransactionScope<Txn> - Class in com.amazon.carbonado.txn
+
+
Container of thread local, scoped transactions.
+
+
transform(S) - Method in class com.amazon.carbonado.cursor.MultiTransformedCursor
+
+
This method must be implemented to transform storables.
+
+
transform(S) - Method in class com.amazon.carbonado.cursor.TransformedCursor
+
+
This method must be implemented to transform storables.
+
+
TransformedCursor<S,T> - Class in com.amazon.carbonado.cursor
+
+
Abstract cursor which wraps another cursor and transforms each storable + result into a target storable.
+
+
TransformedCursor(Cursor<S>) - Constructor for class com.amazon.carbonado.cursor.TransformedCursor
+
 
+
transformIntoFetchException(Throwable) - Method in class com.amazon.carbonado.spi.ExceptionTransformer
+
+
Override to support custom transformations, returning null if none is + applicable.
+
+
transformIntoPersistException(Throwable) - Method in class com.amazon.carbonado.spi.ExceptionTransformer
+
+
Override to support custom transformations, returning null if none is + applicable.
+
+
transformIntoRepositoryException(Throwable) - Method in class com.amazon.carbonado.spi.ExceptionTransformer
+
+
Override to support custom transformations, returning null if none is + applicable.
+
+
Trigger<S> - Class in com.amazon.carbonado
+
+
Callback mechanism to allow custom code to run when a storable is + persisted.
+
+
Trigger() - Constructor for class com.amazon.carbonado.Trigger
+
 
+
Trigger.Abort - Exception in com.amazon.carbonado
+
 
+
TriggerFactory - Interface in com.amazon.carbonado
+
+
Can be used with RepositoryBuilder to automatically register + triggers as Storable types become available.
+
+
triggerFor(Class<S>) - Method in interface com.amazon.carbonado.TriggerFactory
+
+
Return an appropriate trigger for the given type, or null if none.
+
+
TriggerManager<S extends Storable> - Class in com.amazon.carbonado.spi
+
+
Used by Storage implementations to manage triggers and consolidate them into + single logical triggers.
+
+
TriggerManager() - Constructor for class com.amazon.carbonado.spi.TriggerManager
+
 
+
TriggerManager(Class<S>, Iterable<TriggerFactory>) - Constructor for class com.amazon.carbonado.spi.TriggerManager
+
 
+
TriggerManagerCapability - Interface in com.amazon.carbonado.spi
+
+
Provides the capability to get the TriggerManager from a Repository.
+
+
TriggerSupport<S extends Storable> - Interface in com.amazon.carbonado.gen
+
+
Provides runtime support for Storable classes generated by StorableGenerator.
+
+
trim() - Method in class com.amazon.carbonado.info.ChainedProperty
+
+
Returns a new ChainedProperty with the last property in the chain removed.
+
+
TrueFalseAdapter - Annotation Type in com.amazon.carbonado.adapter
+
+
Adapter that converts 'T' or 'F' to and from a boolean value.
+
+
TrueFalseAdapter.Adapter - Class in com.amazon.carbonado.adapter
+
+
Adapter implementation for TrueFalseAdapter.
+
+
TrueFalseAdapter.Adapter(Class<?>, String, TrueFalseAdapter) - Constructor for class com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter
+
 
+
TrueFalseAdapter.Adapter(Class<?>, String, boolean) - Constructor for class com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter
+
 
+
truncate() - Method in interface com.amazon.carbonado.Storage
+
+
Attempts to quickly delete all Storables instances in this + Storage.
+
+
TRY_DELETE_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
TRY_INSERT_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
TRY_LOAD_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
TRY_LOAD_ONE_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Query API method name
+
+
TRY_UPDATE_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
tryDelete(S, byte[]) - Method in interface com.amazon.carbonado.raw.RawSupport
+
+
Try to delete the entry referenced by the given key.
+
+
tryDelete() - Method in interface com.amazon.carbonado.Storable
+
+
Deletes this object from the storage layer by its primary key, + regardless of whether this object has actually been loaded or not.
+
+
tryDeleteOne() - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always returns false.
+
+
tryDeleteOne(Query.Controller) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always returns false.
+
+
tryDeleteOne() - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
tryDeleteOne(Query.Controller) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
tryDeleteOne() - Method in interface com.amazon.carbonado.Query
+
+
Deletes zero or one matching objects.
+
+
tryDeleteOne(Query.Controller) - Method in interface com.amazon.carbonado.Query
+
+
Deletes zero or one matching objects.
+
+
tryInsert(S, byte[], byte[]) - Method in interface com.amazon.carbonado.raw.RawSupport
+
+
Try to insert the entry referenced by the given key with the given + value.
+
+
tryInsert() - Method in interface com.amazon.carbonado.Storable
+
+
Inserts a new persistent value for this object.
+
+
tryLoad(S, byte[]) - Method in interface com.amazon.carbonado.raw.RawSupport
+
+
Try to load the entry referenced by the given key, but return null + if not found.
+
+
tryLoad() - Method in interface com.amazon.carbonado.Storable
+
+
Loads or reloads this object from the storage layer by a primary or + alternate key.
+
+
tryLoadOne() - Method in class com.amazon.carbonado.qe.AbstractQuery
+
 
+
tryLoadOne(Query.Controller) - Method in class com.amazon.carbonado.qe.AbstractQuery
+
 
+
tryLoadOne() - Method in interface com.amazon.carbonado.Query
+
+
Tries to load one record, but returns null if nothing was found.
+
+
tryLoadOne(Query.Controller) - Method in interface com.amazon.carbonado.Query
+
+
Tries to load one record, but returns null if nothing was found.
+
+
tryUpdate() - Method in interface com.amazon.carbonado.Storable
+
+
Updates the persistent value of this object, regardless of whether this + object has actually been loaded or not.
+
+
+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.

+ + diff --git a/apidocs/index-files/index-21.html b/apidocs/index-files/index-21.html new file mode 100644 index 0000000..819d2b1 --- /dev/null +++ b/apidocs/index-files/index-21.html @@ -0,0 +1,238 @@ + + + + + + +U-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  + + +

U

+
+
unbind() - Method in class com.amazon.carbonado.filter.AndFilter
+
 
+
unbind() - Method in class com.amazon.carbonado.filter.ClosedFilter
+
 
+
unbind() - Method in class com.amazon.carbonado.filter.ExistsFilter
+
 
+
unbind() - Method in class com.amazon.carbonado.filter.Filter
+
+
Undoes the effect of a bind operation.
+
+
unbind() - Method in class com.amazon.carbonado.filter.OpenFilter
+
 
+
unbind() - Method in class com.amazon.carbonado.filter.OrFilter
+
 
+
unbind() - Method in class com.amazon.carbonado.filter.PropertyFilter
+
 
+
uneraseGenericParameter(CodeBuilder, TypeDesc, int) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Generate code to create a local variable containing the specified parameter coerced + to the specified type.
+
+
Unevolvable - Interface in com.amazon.carbonado.layout
+
+
Marker interface for storables that are not allowed to evolve.
+
+
Unindexed - Interface in com.amazon.carbonado.repo.indexed
+
+
Marker interface for storables that are not allowed to have indexes.
+
+
UnionCursor<S> - Class in com.amazon.carbonado.cursor
+
+
Wraps two Cursors and performs a set union operation.
+
+
UnionCursor(Cursor<S>, Cursor<S>, Comparator<S>) - Constructor for class com.amazon.carbonado.cursor.UnionCursor
+
 
+
UnionQueryAnalyzer<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
Analyzes a query specification and determines how it can be executed as a + union of smaller queries.
+
+
UnionQueryAnalyzer(Class<S>, RepositoryAccess) - Constructor for class com.amazon.carbonado.qe.UnionQueryAnalyzer
+
 
+
UnionQueryAnalyzer.Result - Class in com.amazon.carbonado.qe
+
 
+
UnionQueryExecutor<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
QueryExecutor which wraps several others and unions the results.
+
+
UnionQueryExecutor(QueryExecutor<S>...) - Constructor for class com.amazon.carbonado.qe.UnionQueryExecutor
+
 
+
UnionQueryExecutor(List<QueryExecutor<S>>) - Constructor for class com.amazon.carbonado.qe.UnionQueryExecutor
+
 
+
UnionQueryExecutor(List<QueryExecutor<S>>, OrderingList<S>) - Constructor for class com.amazon.carbonado.qe.UnionQueryExecutor
+
 
+
unique(boolean) - Method in class com.amazon.carbonado.info.StorableIndex
+
+
Returns a StorableIndex instance which is unique or not.
+
+
UniqueConstraintException - Exception in com.amazon.carbonado
+
+
A UniqueConstraintException is thrown if the Repository storage + layer has a unique constraint check defined for a property, and a violation + has been detected.
+
+
UniqueConstraintException() - Constructor for exception com.amazon.carbonado.UniqueConstraintException
+
 
+
UniqueConstraintException(String) - Constructor for exception com.amazon.carbonado.UniqueConstraintException
+
 
+
UniqueConstraintException(String, Throwable) - Constructor for exception com.amazon.carbonado.UniqueConstraintException
+
 
+
UniqueConstraintException(Throwable) - Constructor for exception com.amazon.carbonado.UniqueConstraintException
+
 
+
uniquify(StorableKey<S>) - Method in class com.amazon.carbonado.info.StorableIndex
+
+
Returns a StorableIndex which is unique, possibly by appending + properties from the given key.
+
+
uniquify(StorableInfo<S>) - Method in class com.amazon.carbonado.qe.StorableIndexSet
+
+
Augment non-unique indexes with primary key properties, thus making them + unique.
+
+
uniquify(StorableKey<S>) - Method in class com.amazon.carbonado.qe.StorableIndexSet
+
+
Augment non-unique indexes with key properties, thus making them unique.
+
+
unlockoutShutdown() - Method in class com.amazon.carbonado.spi.AbstractRepository
+
+
Only call this to release lockoutShutdown.
+
+
unregister(Class<S>, Cursor<S>) - Method in class com.amazon.carbonado.txn.TransactionScope
+
+
Unregisters a previously registered cursor.
+
+
UnsupportedTypeException - Exception in com.amazon.carbonado
+
+
Thrown by a Repository which cannot support a Storable which + is declared as Independent or Authoritative.
+
+
UnsupportedTypeException(String, Class<? extends Storable>) - Constructor for exception com.amazon.carbonado.UnsupportedTypeException
+
 
+
unwrap(Class<T>) - Method in class com.amazon.carbonado.repo.jdbc.LoggingDataSource
+
 
+
unwrap(Class<T>) - Method in class com.amazon.carbonado.repo.jdbc.SimpleDataSource
+
 
+
update() - Method in interface com.amazon.carbonado.Storable
+
+
Updates the persistent value of this object, regardless of whether this + object has actually been loaded or not.
+
+
UPDATE_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
updateBlob(Blob, Blob) - Method in interface com.amazon.carbonado.repo.jdbc.JDBCSupport
+
 
+
updateClob(Clob, Clob) - Method in interface com.amazon.carbonado.repo.jdbc.JDBCSupport
+
 
+
+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.

+ + diff --git a/apidocs/index-files/index-22.html b/apidocs/index-files/index-22.html new file mode 100644 index 0000000..9a2bad7 --- /dev/null +++ b/apidocs/index-files/index-22.html @@ -0,0 +1,481 @@ + + + + + + +V-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  + + +

V

+
+
valueOf(String) - Static method in enum com.amazon.carbonado.filter.RelOp
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.amazon.carbonado.gen.MasterFeature
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.amazon.carbonado.info.Direction
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.amazon.carbonado.IsolationLevel
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.amazon.carbonado.qe.BoundaryType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.amazon.carbonado.qe.QueryHint
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.amazon.carbonado.raw.CompressionType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum com.amazon.carbonado.repo.sleepycat.BDBProduct
+
+
Returns the enum constant of this type with the specified name.
+
+
values() - Static method in enum com.amazon.carbonado.filter.RelOp
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.amazon.carbonado.gen.MasterFeature
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Method in class com.amazon.carbonado.gen.StorablePropertyMap
+
 
+
values() - Static method in enum com.amazon.carbonado.info.Direction
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.amazon.carbonado.IsolationLevel
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.amazon.carbonado.qe.BoundaryType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.amazon.carbonado.qe.QueryHint
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.amazon.carbonado.raw.CompressionType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum com.amazon.carbonado.repo.sleepycat.BDBProduct
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Method in class com.amazon.carbonado.util.AbstractPool
+
+
Returns the pool values, which may be concurrently modified.
+
+
verify(PrintStream) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Opens the BDB environment, checks if it is corrupt, and then closes it.
+
+
VERSION - Static variable in class com.amazon.carbonado.layout.LayoutFactory
+
 
+
Version - Annotation Type in com.amazon.carbonado
+
+
Designates a Storable property as being the authoritative version + number for the entire Storable instance.
+
+
visit(OrFilter<S>, P) - Method in class com.amazon.carbonado.filter.Visitor
+
 
+
visit(AndFilter<S>, P) - Method in class com.amazon.carbonado.filter.Visitor
+
 
+
visit(PropertyFilter<S>, P) - Method in class com.amazon.carbonado.filter.Visitor
+
 
+
visit(ExistsFilter<S>, P) - Method in class com.amazon.carbonado.filter.Visitor
+
 
+
visit(OpenFilter<S>, P) - Method in class com.amazon.carbonado.filter.Visitor
+
 
+
visit(ClosedFilter<S>, P) - Method in class com.amazon.carbonado.filter.Visitor
+
 
+
visit(String, int, Annotation, Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(String, int, int, Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(String, int, long, Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(String, int, float, Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(String, int, double, Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(String, int, boolean, Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(String, int, byte, Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(String, int, short, Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(String, int, char, Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(String, int, String, Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(String, int, Class, Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(String, int, Enum, Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(String, int, Annotation[], Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(String, int, int[], Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(String, int, long[], Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(String, int, float[], Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(String, int, double[], Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(String, int, boolean[], Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(String, int, byte[], Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(String, int, short[], Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(String, int, char[], Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(String, int, String[], Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(String, int, Class[], Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(String, int, Enum[], Annotation) - Method in class com.amazon.carbonado.util.AnnotationBuilder
+
 
+
visit(Annotation) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
+
Prints the annotation to the builder passed to the constructor.
+
+
visit(String, int, Annotation, Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(String, int, int, Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(String, int, long, Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(String, int, float, Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(String, int, double, Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(String, int, boolean, Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(String, int, byte, Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(String, int, short, Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(String, int, char, Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(String, int, String, Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(String, int, Class, Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(String, int, Enum, Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(String, int, Annotation[], Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(String, int, int[], Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(String, int, long[], Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(String, int, float[], Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(String, int, double[], Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(String, int, boolean[], Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(String, int, byte[], Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(String, int, short[], Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(String, int, char[], Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(String, int, String[], Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(String, int, Class[], Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(String, int, Enum[], Object) - Method in class com.amazon.carbonado.util.AnnotationDescPrinter
+
 
+
visit(Annotation) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
+
Prints the annotation to the builder passed to the constructor.
+
+
visit(String, int, Annotation, Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(String, int, int, Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(String, int, long, Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(String, int, float, Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(String, int, double, Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(String, int, boolean, Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(String, int, byte, Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(String, int, short, Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(String, int, char, Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(String, int, String, Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(String, int, Class, Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(String, int, Enum, Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(String, int, Annotation[], Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(String, int, int[], Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(String, int, long[], Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(String, int, float[], Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(String, int, double[], Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(String, int, boolean[], Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(String, int, byte[], Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(String, int, short[], Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(String, int, char[], Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(String, int, String[], Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(String, int, Class[], Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(String, int, Enum[], Object) - Method in class com.amazon.carbonado.util.AnnotationPrinter
+
 
+
visit(Annotation, P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Visits an annotation by breaking it down into its components and calling + various other visit methods.
+
+
visit(String, int, Annotation, P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Visits an annotation by breaking it down into its components and calling + various other visit methods.
+
+
visit(String, int, int, P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Override to visit ints.
+
+
visit(String, int, long, P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Override to visit longs.
+
+
visit(String, int, float, P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Override to visit floats.
+
+
visit(String, int, double, P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Override to visit doubles.
+
+
visit(String, int, boolean, P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Override to visit booleans.
+
+
visit(String, int, byte, P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Override to visit bytes.
+
+
visit(String, int, short, P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Override to visit shorts.
+
+
visit(String, int, char, P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Override to visit chars.
+
+
visit(String, int, String, P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Override to visit Strings.
+
+
visit(String, int, Class, P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Override to visit Classes.
+
+
visit(String, int, Enum, P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Override to visit Enums.
+
+
visit(String, int, Annotation[], P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Visits each array element.
+
+
visit(String, int, int[], P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Visits each array element.
+
+
visit(String, int, long[], P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Visits each array element.
+
+
visit(String, int, float[], P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Visits each array element.
+
+
visit(String, int, double[], P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Visits each array element.
+
+
visit(String, int, boolean[], P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Visits each array element.
+
+
visit(String, int, byte[], P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Visits each array element.
+
+
visit(String, int, short[], P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Visits each array element.
+
+
visit(String, int, char[], P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Visits each array element.
+
+
visit(String, int, String[], P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Visits each array element.
+
+
visit(String, int, Class[], P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Visits each array element.
+
+
visit(String, int, Enum[], P) - Method in class com.amazon.carbonado.util.AnnotationVisitor
+
+
Visits each array element.
+
+
Visitor<S extends Storable,R,P> - Class in com.amazon.carbonado.filter
+
+
Traverses a filter tree in its canonical order.
+
+
Visitor() - Constructor for class com.amazon.carbonado.filter.Visitor
+
 
+
+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.

+ + diff --git a/apidocs/index-files/index-23.html b/apidocs/index-files/index-23.html new file mode 100644 index 0000000..605cb9a --- /dev/null +++ b/apidocs/index-files/index-23.html @@ -0,0 +1,338 @@ + + + + + + +W-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  + + +

W

+
+
waitForRepairsToFinish(long) - Static method in class com.amazon.carbonado.spi.RepairExecutor
+
+
Waits for repairs that were executed from the current thread to finish.
+
+
with(int) - Method in class com.amazon.carbonado.filter.FilterValues
+
+
Returns a new FilterValues instance with the next blank parameter filled in.
+
+
with(long) - Method in class com.amazon.carbonado.filter.FilterValues
+
+
Returns a new FilterValues instance with the next blank parameter filled in.
+
+
with(float) - Method in class com.amazon.carbonado.filter.FilterValues
+
+
Returns a new FilterValues instance with the next blank parameter filled in.
+
+
with(double) - Method in class com.amazon.carbonado.filter.FilterValues
+
+
Returns a new FilterValues instance with the next blank parameter filled in.
+
+
with(boolean) - Method in class com.amazon.carbonado.filter.FilterValues
+
+
Returns a new FilterValues instance with the next blank parameter filled in.
+
+
with(char) - Method in class com.amazon.carbonado.filter.FilterValues
+
+
Returns a new FilterValues instance with the next blank parameter filled in.
+
+
with(byte) - Method in class com.amazon.carbonado.filter.FilterValues
+
+
Returns a new FilterValues instance with the next blank parameter filled in.
+
+
with(short) - Method in class com.amazon.carbonado.filter.FilterValues
+
+
Returns a new FilterValues instance with the next blank parameter filled in.
+
+
with(Object) - Method in class com.amazon.carbonado.filter.FilterValues
+
+
Returns a new FilterValues instance with the next blank parameter filled in.
+
+
with(int) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always throws an IllegalStateException.
+
+
with(long) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always throws an IllegalStateException.
+
+
with(float) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always throws an IllegalStateException.
+
+
with(double) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always throws an IllegalStateException.
+
+
with(boolean) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always throws an IllegalStateException.
+
+
with(char) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always throws an IllegalStateException.
+
+
with(byte) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always throws an IllegalStateException.
+
+
with(short) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always throws an IllegalStateException.
+
+
with(Object) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always throws an IllegalStateException.
+
+
with(QueryHint) - Method in class com.amazon.carbonado.qe.QueryHints
+
+
Returns a new QueryHints object with the given hint.
+
+
with(QueryHint, Object) - Method in class com.amazon.carbonado.qe.QueryHints
+
+
Returns a new QueryHints object with the given hint and value.
+
+
with(int) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
with(long) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
with(float) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
with(double) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
with(boolean) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
with(char) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
with(byte) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
with(short) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
with(Object) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
with(int) - Method in interface com.amazon.carbonado.Query
+
+
Returns a copy of this Query with the next blank parameter filled in.
+
+
with(long) - Method in interface com.amazon.carbonado.Query
+
+
Returns a copy of this Query with the next blank parameter filled in.
+
+
with(float) - Method in interface com.amazon.carbonado.Query
+
+
Returns a copy of this Query with the next blank parameter filled in.
+
+
with(double) - Method in interface com.amazon.carbonado.Query
+
+
Returns a copy of this Query with the next blank parameter filled in.
+
+
with(boolean) - Method in interface com.amazon.carbonado.Query
+
+
Returns a copy of this Query with the next blank parameter filled in.
+
+
with(char) - Method in interface com.amazon.carbonado.Query
+
+
Returns a copy of this Query with the next blank parameter filled in.
+
+
with(byte) - Method in interface com.amazon.carbonado.Query
+
+
Returns a copy of this Query with the next blank parameter filled in.
+
+
with(short) - Method in interface com.amazon.carbonado.Query
+
+
Returns a copy of this Query with the next blank parameter filled in.
+
+
with(Object) - Method in interface com.amazon.carbonado.Query
+
+
Returns a copy of this Query with the next blank parameter filled in.
+
+
WITH_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Query API method name
+
+
without(QueryHint) - Method in class com.amazon.carbonado.qe.QueryHints
+
+
Returns a new QueryHints object without the given hint.
+
+
withRemainderFilter(Filter<S>) - Method in class com.amazon.carbonado.qe.CompositeScore
+
+
Returns a new CompositeScore with the filtering remainder replaced and + covering matches recalculated.
+
+
withRemainderFilter(Filter<S>) - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns a new FilteringScore with the remainder replaced and covering + matches recalculated.
+
+
withRemainderFilter(Filter<S>) - Method in class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result
+
+
Returns a new result with the remainder filter replaced.
+
+
withRemainderOrdering(OrderingList<S>) - Method in class com.amazon.carbonado.qe.CompositeScore
+
+
Returns a new CompositeScore with the ordering remainder + replaced.
+
+
withRemainderOrdering(OrderingList<S>) - Method in class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result
+
+
Returns a new result with the remainder ordering replaced.
+
+
withRemainderOrdering(OrderingList<S>) - Method in class com.amazon.carbonado.qe.OrderingScore
+
+
Returns a new OrderingScore with the remainder replaced.
+
+
withStackTrace() - Method in exception com.amazon.carbonado.Trigger.Abort
+
+
Returns this exception but with a fresh stack trace.
+
+
withValues(Object...) - Method in class com.amazon.carbonado.filter.FilterValues
+
+
Returns a new FilterValues instance with the next blank parameters filled in.
+
+
withValues(Object...) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Throws an IllegalStateException unless no values passed in.
+
+
withValues(Object...) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
withValues(Object...) - Method in interface com.amazon.carbonado.Query
+
+
Returns a copy of this Query with the next blank parameters filled in.
+
+
write(String) - Method in class com.amazon.carbonado.repo.logging.CommonsLog
+
 
+
write(String) - Method in interface com.amazon.carbonado.repo.logging.Log
+
 
+
write(int) - Method in class com.amazon.carbonado.spi.RAFOutputStream
+
 
+
write(byte[]) - Method in class com.amazon.carbonado.spi.RAFOutputStream
+
 
+
write(byte[], int, int) - Method in class com.amazon.carbonado.spi.RAFOutputStream
+
 
+
WRITE_TO - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
writeLength(int, OutputStream) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Writes a positive length value in up to five bytes.
+
+
writeTo(OutputStream) - Method in class com.amazon.carbonado.layout.Layout
+
+
Write a layout to be read by LayoutFactory.readLayoutFrom(java.io.InputStream).
+
+
writeTo(OutputStream) - Method in interface com.amazon.carbonado.Storable
+
+
Serializes property values and states for temporary storage or for + network transfer.
+
+
+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.

+ + diff --git a/apidocs/index-files/index-24.html b/apidocs/index-files/index-24.html new file mode 100644 index 0000000..6f6ebd5 --- /dev/null +++ b/apidocs/index-files/index-24.html @@ -0,0 +1,136 @@ + + + + + + +Y-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  + + +

Y

+
+
YesNoAdapter - Annotation Type in com.amazon.carbonado.adapter
+
+
Adapter that converts 'Y' or 'N' to and from a boolean value.
+
+
YesNoAdapter.Adapter - Class in com.amazon.carbonado.adapter
+
+
Adapter implementation for YesNoAdapter.
+
+
YesNoAdapter.Adapter(Class<?>, String, YesNoAdapter) - Constructor for class com.amazon.carbonado.adapter.YesNoAdapter.Adapter
+
 
+
YesNoAdapter.Adapter(Class<?>, String, boolean) - Constructor for class com.amazon.carbonado.adapter.YesNoAdapter.Adapter
+
 
+
yieldConnection(Connection) - Method in interface com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability
+
+
Gives up a connection returned from getConnection.
+
+
+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.

+ + diff --git a/apidocs/index-files/index-3.html b/apidocs/index-files/index-3.html new file mode 100644 index 0000000..6ec67f3 --- /dev/null +++ b/apidocs/index-files/index-3.html @@ -0,0 +1,1109 @@ + + + + + + +C-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  + + +

C

+
+
calculateEncodedLength(BigInteger) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Returns the amount of bytes required to encode the given BigInteger.
+
+
calculateEncodedLength(BigDecimal) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Returns the amount of bytes required to encode the given BigDecimal.
+
+
calculateEncodedLength(byte[]) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Returns the amount of bytes required to encode the given byte array.
+
+
calculateEncodedLength(byte[], int, int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Returns the amount of bytes required to encode the given byte array.
+
+
calculateEncodedLength(BigInteger) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Returns the amount of bytes required to encode a BigInteger.
+
+
calculateEncodedLength(BigDecimal) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Returns the amount of bytes required to encode a BigDecimal.
+
+
calculateEncodedLength(byte[]) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Returns the amount of bytes required to encode a byte array of the given + length.
+
+
calculateEncodedLength(byte[], int, int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Returns the amount of bytes required to encode the given byte array.
+
+
calculateEncodedStringLength(String) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Returns the amount of bytes required to encode the given String.
+
+
calculateEncodedStringLength(String) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Returns the amount of bytes required to encode the given String.
+
+
callStringBuilderAppendChar(CodeBuilder) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Appends a char to a StringBuilder.
+
+
callStringBuilderAppendString(CodeBuilder) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Appends a String to a StringBuilder.
+
+
callStringBuilderLength(CodeBuilder) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Calls length on a StringBuilder on the stack, leaving an int on the stack.
+
+
callStringBuilderSetLength(CodeBuilder) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Calls setLength on a StringBuilder.
+
+
callStringBuilderToString(CodeBuilder) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Calls toString on a StringBuilder.
+
+
canMergeRemainder(CompositeScore<S>) - Method in class com.amazon.carbonado.qe.CompositeScore
+
+
Returns true if the filtering score can merge its remainder filter and + the ordering score can merge its remainder orderings.
+
+
canMergeRemainder(IndexedQueryAnalyzer<S>.Result) - Method in class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result
+
+
Returns true if the given result uses the same index as this, and in + the same way.
+
+
canMergeRemainderFilter(FilteringScore<S>) - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns true if the given score uses an index exactly the same as this + one.
+
+
canMergeRemainderOrdering(OrderingScore<S>) - Method in class com.amazon.carbonado.qe.OrderingScore
+
+
Returns true if the given score uses an index exactly the same as this + one.
+
+
Capability - Interface in com.amazon.carbonado.capability
+
+
Marker interface for identifying extra repository capabilities.
+
+
ChainedProperty<S extends Storable> - Class in com.amazon.carbonado.info
+
+
Represents a property to filter on or to order by.
+
+
CharArrayClob - Class in com.amazon.carbonado.lob
+
+
Implementation of a Clob which is backed by a growable in-memory character + array.
+
+
CharArrayClob(int) - Constructor for class com.amazon.carbonado.lob.CharArrayClob
+
+
Construct a CharArrayClob with the given initial capacity.
+
+
CharArrayClob(char[]) - Constructor for class com.amazon.carbonado.lob.CharArrayClob
+
+
Construct a CharArrayClob initially backed by the given character array.
+
+
CharArrayClob(char[], int) - Constructor for class com.amazon.carbonado.lob.CharArrayClob
+
+
Construct a CharArrayClob initially backed by the given character array.
+
+
CHECK_PK_FOR_DELETE_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.
+
+
CHECK_PK_FOR_INSERT_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.
+
+
CHECK_PK_FOR_LOAD_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.
+
+
CHECK_PK_FOR_UPDATE_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.
+
+
CheckpointCapability - Interface in com.amazon.carbonado.repo.sleepycat
+
+
Capability to control BDB checkpointing.
+
+
checkSliceArguments(long, Long) - Method in class com.amazon.carbonado.qe.AbstractQuery
+
+
Called by sliced fetch to ensure that arguments are valid.
+
+
checkSupport(StorableProperty<S>) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
 
+
checkSupport(StorableProperty<S>[]) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
 
+
ClassFileBuilder - Class in com.amazon.carbonado.synthetic
+
+
Simple interface representing a partially filled class and injector pair.
+
+
ClassFileBuilder() - Constructor for class com.amazon.carbonado.synthetic.ClassFileBuilder
+
 
+
clear() - Method in class com.amazon.carbonado.cursor.MergeSortBuffer
+
 
+
clear() - Method in class com.amazon.carbonado.gen.StorablePropertyMap
+
 
+
clear() - Method in class com.amazon.carbonado.util.AbstractPool
+
 
+
clear() - Method in class com.amazon.carbonado.util.SoftValuedCache
+
+
Deprecated.
+ 
+
clearExecutor() - Method in class com.amazon.carbonado.qe.StandardQuery
+
+
Clears any cached reference to a query executor.
+
+
clearExecutors() - Method in class com.amazon.carbonado.qe.StandardQueryFactory
+
+
For each cached query, calls StandardQuery.clearExecutor().
+
+
Clob - Interface in com.amazon.carbonado.lob
+
+
Provides access to CLOBs, which are Character Large OBjects.
+
+
CLONE_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
close() - Method in class com.amazon.carbonado.cursor.ArraySortBuffer
+
 
+
close() - Method in interface com.amazon.carbonado.Cursor
+
+
Call close to release any resources being held by this cursor.
+
+
close() - Method in class com.amazon.carbonado.cursor.ControllerCursor
+
 
+
close() - Method in class com.amazon.carbonado.cursor.DifferenceCursor
+
 
+
close() - Method in class com.amazon.carbonado.cursor.EmptyCursor
+
+
Does nothing.
+
+
close() - Method in class com.amazon.carbonado.cursor.FetchAheadCursor
+
 
+
close() - Method in class com.amazon.carbonado.cursor.FilteredCursor
+
 
+
close() - Method in class com.amazon.carbonado.cursor.GroupedCursor
+
 
+
close() - Method in class com.amazon.carbonado.cursor.IntersectionCursor
+
 
+
close() - Method in class com.amazon.carbonado.cursor.IteratorCursor
+
 
+
close() - Method in class com.amazon.carbonado.cursor.LimitCursor
+
 
+
close() - Method in class com.amazon.carbonado.cursor.MergeSortBuffer
+
 
+
close() - Method in class com.amazon.carbonado.cursor.MultiTransformedCursor
+
 
+
close() - Method in class com.amazon.carbonado.cursor.SingletonCursor
+
 
+
close() - Method in class com.amazon.carbonado.cursor.SkipCursor
+
 
+
close() - Method in interface com.amazon.carbonado.cursor.SortBuffer
+
+
Clear and close buffer.
+
+
close() - Method in class com.amazon.carbonado.cursor.SortedCursor
+
 
+
close() - Method in class com.amazon.carbonado.cursor.SymmetricDifferenceCursor
+
 
+
close() - Method in class com.amazon.carbonado.cursor.ThrottledCursor
+
 
+
close() - Method in class com.amazon.carbonado.cursor.TransformedCursor
+
 
+
close() - Method in class com.amazon.carbonado.cursor.UnionCursor
+
 
+
close() - Method in interface com.amazon.carbonado.Query.Controller
+
+
Always called by query when finished, even when it fails.
+
+
close() - Method in class com.amazon.carbonado.Query.Timeout
+
 
+
close() - Method in class com.amazon.carbonado.raw.RawCursor
+
 
+
close() - Method in class com.amazon.carbonado.repo.jdbc.LoggingDataSource
+
 
+
close() - Method in class com.amazon.carbonado.repo.jdbc.SimpleDataSource
+
 
+
close() - Method in interface com.amazon.carbonado.Repository
+
+
Closes this repository reference, aborting any current + transactions.
+
+
close() - Method in class com.amazon.carbonado.spi.AbstractRepository
+
 
+
close() - Method in class com.amazon.carbonado.spi.RAFInputStream
+
 
+
close() - Method in class com.amazon.carbonado.spi.RAFOutputStream
+
 
+
close(boolean) - Method in class com.amazon.carbonado.txn.TransactionManager
+
+
Closes all transaction scopes.
+
+
ClosedFilter<S extends Storable> - Class in com.amazon.carbonado.filter
+
+
Filter which blocks any results from passing through.
+
+
clustered(boolean) - Method in class com.amazon.carbonado.info.StorableIndex
+
+
Returns a StorableIndex instance which is clustered or not.
+
+
CodeBuilderUtil - Class in com.amazon.carbonado.gen
+
+
Collection of useful utilities for generating Carbonado code.
+
+
CodeBuilderUtil() - Constructor for class com.amazon.carbonado.gen.CodeBuilderUtil
+
 
+
com.amazon.carbonado - package com.amazon.carbonado
+
+
Main user-level interfaces, classes, and annotations for Carbonado.
+
+
com.amazon.carbonado.adapter - package com.amazon.carbonado.adapter
+
+
Contains annotations and implementations for supporting property adapters.
+
+
com.amazon.carbonado.capability - package com.amazon.carbonado.capability
+
+
Common capabilities for repositories.
+
+
com.amazon.carbonado.constraint - package com.amazon.carbonado.constraint
+
+
Contains annotations and implementations for supporting property constraints.
+
+
com.amazon.carbonado.cursor - package com.amazon.carbonado.cursor
+
+
Support for advanced processing of cursor results, including basic set + theory operations.
+
+
com.amazon.carbonado.filter - package com.amazon.carbonado.filter
+
+
Contains classes for representing query filters.
+
+
com.amazon.carbonado.gen - package com.amazon.carbonado.gen
+
+
Storable code generation support intended for use by repository implementations.
+
+
com.amazon.carbonado.info - package com.amazon.carbonado.info
+
+
Introspection support for Storables.
+
+
com.amazon.carbonado.layout - package com.amazon.carbonado.layout
+
+
Support for recording the evolution of a storable's layout, used internally + by some repositories.
+
+
com.amazon.carbonado.lob - package com.amazon.carbonado.lob
+
+
Support for LOB property types, which are Large OBjects.
+
+
com.amazon.carbonado.qe - package com.amazon.carbonado.qe
+
+
Support for implementing a Query Engine.
+
+
com.amazon.carbonado.raw - package com.amazon.carbonado.raw
+
+
Provides support for repositories that encode/decode storables in a raw + binary format.
+
+
com.amazon.carbonado.repo.indexed - package com.amazon.carbonado.repo.indexed
+
+
Repository implementation that adds index support for repositories that have + little or no index support.
+
+
com.amazon.carbonado.repo.jdbc - package com.amazon.carbonado.repo.jdbc
+
+
Repository implementation that connects to an external SQL database via + JDBC.
+
+
com.amazon.carbonado.repo.logging - package com.amazon.carbonado.repo.logging
+
+
Repository implementation which logs activity against it.
+
+
com.amazon.carbonado.repo.map - package com.amazon.carbonado.repo.map
+
+
Volatile repository implementation backed by a concurrent map.
+
+
com.amazon.carbonado.repo.replicated - package com.amazon.carbonado.repo.replicated
+
+
Repository implementation that supports replication between two + repositories.
+
+
com.amazon.carbonado.repo.sleepycat - package com.amazon.carbonado.repo.sleepycat
+
+
Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.
+
+
com.amazon.carbonado.sequence - package com.amazon.carbonado.sequence
+
+
Support for generating sequences of values, intended for creating surrogate + keys.
+
+
com.amazon.carbonado.spi - package com.amazon.carbonado.spi
+
+
Service Provider Interface for Carbonado.
+
+
com.amazon.carbonado.synthetic - package com.amazon.carbonado.synthetic
+
+
Support for dynamic creation of storables, intended for internal use by + repository implementations.
+
+
com.amazon.carbonado.txn - package com.amazon.carbonado.txn
+
+
Provides support for managing transactions.
+
+
com.amazon.carbonado.util - package com.amazon.carbonado.util
+
+
Utilities used by Carbonado but which have no dependencies on + Carbonado.
+
+
commit() - Method in interface com.amazon.carbonado.Transaction
+
+
If currently in a transaction, commits all changes to the storage layer + since the last commit within the transaction.
+
+
commit() - Method in class com.amazon.carbonado.txn.TransactionPair
+
 
+
COMMIT_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Transaction API method name
+
+
commitTxn(Txn) - Method in class com.amazon.carbonado.txn.TransactionManager
+
+
Commits and closes the given internal transaction.
+
+
CommonMethodNames - Class in com.amazon.carbonado.gen
+
+
Collection of constant method names for the public API.
+
+
CommonMethodNames() - Constructor for class com.amazon.carbonado.gen.CommonMethodNames
+
 
+
CommonsLog - Class in com.amazon.carbonado.repo.logging
+
+
Log implementation that uses Jakarta Commons Logging at debug level.
+
+
CommonsLog(Log) - Constructor for class com.amazon.carbonado.repo.logging.CommonsLog
+
 
+
CommonsLog(Class) - Constructor for class com.amazon.carbonado.repo.logging.CommonsLog
+
 
+
compact(Class<S>) - Method in interface com.amazon.carbonado.repo.sleepycat.CompactionCapability
+
+
Compact an entire BDB backed storage.
+
+
CompactionCapability - Interface in com.amazon.carbonado.repo.sleepycat
+
+
Capability to compact a BDB database.
+
+
CompactionCapability.Result<S extends Storable> - Interface in com.amazon.carbonado.repo.sleepycat
+
 
+
comparator() - Method in class com.amazon.carbonado.cursor.GroupedCursor
+
+
Returns the comparator used to identify group boundaries.
+
+
comparator() - Method in class com.amazon.carbonado.cursor.SortedCursor
+
+
Returns a comparator representing the effective sort order of this cursor.
+
+
Comparators - Class in com.amazon.carbonado.util
+
+
Collection of utility comparators.
+
+
Comparators() - Constructor for class com.amazon.carbonado.util.Comparators
+
 
+
compare(Class, Class) - Method in class com.amazon.carbonado.util.ConversionComparator
+
+
Evaluates two types, to see which one is nearest to the from type.
+
+
compareKeysPartially(byte[], byte[]) - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Returns <0 if key1 is less, 0 if equal (at least partially), + >0 if key1 is greater.
+
+
compareNext() - Method in class com.amazon.carbonado.cursor.SymmetricDifferenceCursor
+
+
Returns 0 if no next element available, <0 if next element is + from left source cursor, and >0 if next element is from right + source cursor.
+
+
compareTo(SyntheticProperty) - Method in class com.amazon.carbonado.synthetic.SyntheticProperty
+
+
Comparable implementation.
+
+
CompositeScore<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
Evaluates an index for how well it matches a query's desired filtering and + ordering.
+
+
compress(byte[], int) - Static method in class com.amazon.carbonado.raw.GzipCompressor
+
+
Encodes into compressed form.
+
+
CompressedEncodingStrategy<S extends Storable> - Class in com.amazon.carbonado.raw
+
+
Extension of GenericEncodingStrategy that allows for compression.
+
+
CompressedEncodingStrategy(Class<S>, StorableIndex<S>, CompressionType) - Constructor for class com.amazon.carbonado.raw.CompressedEncodingStrategy
+
 
+
CompressedStorableCodecFactory - Class in com.amazon.carbonado.raw
+
+
Extension of GenericStorableCodecFactory that allows for compression.
+
+
CompressedStorableCodecFactory(Map<String, CompressionType>) - Constructor for class com.amazon.carbonado.raw.CompressedStorableCodecFactory
+
 
+
CompressionType - Enum in com.amazon.carbonado.raw
+
+
Available compression types for any particular storable.
+
+
concat(Class<S>, String) - Method in class com.amazon.carbonado.qe.OrderingList
+
+
Returns a list which concatenates this one with the given property.
+
+
concat(OrderedProperty<S>) - Method in class com.amazon.carbonado.qe.OrderingList
+
+
Returns a list which concatenates this one with the given property.
+
+
concat(OrderingList<S>) - Method in class com.amazon.carbonado.qe.OrderingList
+
+
Returns a list which concatenates this one with the other one.
+
+
ConfigurationException - Exception in com.amazon.carbonado
+
+
Indicates that a Repository could not be + instantiated given the configuration information provided to a RepositoryBuilder.
+
+
ConfigurationException() - Constructor for exception com.amazon.carbonado.ConfigurationException
+
 
+
ConfigurationException(Throwable) - Constructor for exception com.amazon.carbonado.ConfigurationException
+
 
+
ConfigurationException(String) - Constructor for exception com.amazon.carbonado.ConfigurationException
+
 
+
ConfigurationException(String, Throwable) - Constructor for exception com.amazon.carbonado.ConfigurationException
+
 
+
conjunctiveNormalForm() - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns an equivalent filter that is in conjunctive normal form.
+
+
conjunctiveNormalFormSplit() - Method in class com.amazon.carbonado.filter.ClosedFilter
+
 
+
conjunctiveNormalFormSplit() - Method in class com.amazon.carbonado.filter.Filter
+
+
Splits the filter from its conjunctive normal form.
+
+
conjunctiveNormalFormSplit() - Method in class com.amazon.carbonado.filter.OpenFilter
+
 
+
conjunctiveNormalFormSplit() - Method in class com.amazon.carbonado.filter.PropertyFilter
+
 
+
constant(Object) - Method in class com.amazon.carbonado.filter.PropertyFilter
+
+
Returns another PropertyFilter instance which is bound to the given constant value.
+
+
constant() - Method in class com.amazon.carbonado.filter.PropertyFilter
+
+
Returns the constant value of this PropertyFilter, which is valid only + if isConstant returns true.
+
+
constrain(double) - Method in class com.amazon.carbonado.constraint.FloatConstraint.Constraint
+
 
+
constrain(CharSequence) - Method in class com.amazon.carbonado.constraint.FloatConstraint.Constraint
+
 
+
constrain(char) - Method in class com.amazon.carbonado.constraint.FloatConstraint.Constraint
+
 
+
constrain(char[]) - Method in class com.amazon.carbonado.constraint.FloatConstraint.Constraint
+
 
+
constrain(long) - Method in class com.amazon.carbonado.constraint.IntegerConstraint.Constraint
+
 
+
constrain(double) - Method in class com.amazon.carbonado.constraint.IntegerConstraint.Constraint
+
 
+
constrain(CharSequence) - Method in class com.amazon.carbonado.constraint.IntegerConstraint.Constraint
+
 
+
constrain(char) - Method in class com.amazon.carbonado.constraint.IntegerConstraint.Constraint
+
 
+
constrain(char[]) - Method in class com.amazon.carbonado.constraint.IntegerConstraint.Constraint
+
 
+
constrain(CharSequence) - Method in class com.amazon.carbonado.constraint.LengthConstraint.Constraint
+
 
+
constrain(boolean[]) - Method in class com.amazon.carbonado.constraint.LengthConstraint.Constraint
+
 
+
constrain(byte[]) - Method in class com.amazon.carbonado.constraint.LengthConstraint.Constraint
+
 
+
constrain(short[]) - Method in class com.amazon.carbonado.constraint.LengthConstraint.Constraint
+
 
+
constrain(char[]) - Method in class com.amazon.carbonado.constraint.LengthConstraint.Constraint
+
 
+
constrain(int[]) - Method in class com.amazon.carbonado.constraint.LengthConstraint.Constraint
+
 
+
constrain(long[]) - Method in class com.amazon.carbonado.constraint.LengthConstraint.Constraint
+
 
+
constrain(float[]) - Method in class com.amazon.carbonado.constraint.LengthConstraint.Constraint
+
 
+
constrain(double[]) - Method in class com.amazon.carbonado.constraint.LengthConstraint.Constraint
+
 
+
constrain(Object[]) - Method in class com.amazon.carbonado.constraint.LengthConstraint.Constraint
+
 
+
constrain(CharSequence) - Method in class com.amazon.carbonado.constraint.TextConstraint.Constraint
+
 
+
constrain(String) - Method in class com.amazon.carbonado.constraint.TextConstraint.Constraint
+
 
+
constrain(char) - Method in class com.amazon.carbonado.constraint.TextConstraint.Constraint
+
 
+
constrain(char[]) - Method in class com.amazon.carbonado.constraint.TextConstraint.Constraint
+
 
+
CONSTRAINT_FIELD_ELEMENT - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Constraint field names are propertyName + "$constraint$" + number
+
+
ConstraintDefinition - Annotation Type in com.amazon.carbonado.constraint
+
+
Allows annotations to be defined that restrict property values.
+
+
ConstraintException - Exception in com.amazon.carbonado
+
+
A ConstraintException is thrown if the Repository storage layer + detects any kind of constraint violation.
+
+
ConstraintException() - Constructor for exception com.amazon.carbonado.ConstraintException
+
 
+
ConstraintException(String) - Constructor for exception com.amazon.carbonado.ConstraintException
+
 
+
ConstraintException(String, Throwable) - Constructor for exception com.amazon.carbonado.ConstraintException
+
 
+
ConstraintException(Throwable) - Constructor for exception com.amazon.carbonado.ConstraintException
+
 
+
contains(QueryHint) - Method in class com.amazon.carbonado.qe.QueryHints
+
+
Returns false if hint is not provided.
+
+
containsKey(Object) - Method in class com.amazon.carbonado.gen.StorablePropertyMap
+
 
+
continueCheck() - Method in interface com.amazon.carbonado.Query.Controller
+
+
Periodically called by query to determine if it should continue.
+
+
continueCheck() - Method in class com.amazon.carbonado.Query.Timeout
+
 
+
ControllerCursor<S> - Class in com.amazon.carbonado.cursor
+
+
Wraps another cursor and periodically calls a controller.
+
+
ConversionComparator - Class in com.amazon.carbonado.util
+
+
Compares type conversions, finding the one that is nearest.
+
+
ConversionComparator(Class) - Constructor for class com.amazon.carbonado.util.ConversionComparator
+
 
+
conversionNotSupported(Object, Class, Class) - Method in class com.amazon.carbonado.util.Converter
+
 
+
convert(Object, Class<T>) - Method in class com.amazon.carbonado.util.Converter
+
 
+
convert(byte, Class<T>) - Method in class com.amazon.carbonado.util.Converter
+
 
+
convert(short, Class<T>) - Method in class com.amazon.carbonado.util.Converter
+
 
+
convert(int, Class<T>) - Method in class com.amazon.carbonado.util.Converter
+
 
+
convert(long, Class<T>) - Method in class com.amazon.carbonado.util.Converter
+
 
+
convert(float, Class<T>) - Method in class com.amazon.carbonado.util.Converter
+
 
+
convert(double, Class<T>) - Method in class com.amazon.carbonado.util.Converter
+
 
+
convert(boolean, Class<T>) - Method in class com.amazon.carbonado.util.Converter
+
 
+
convert(char, Class<T>) - Method in class com.amazon.carbonado.util.Converter
+
 
+
convertBlob(Blob, JDBCBlobLoader) - Method in interface com.amazon.carbonado.repo.jdbc.JDBCSupport
+
 
+
convertClob(Clob, JDBCClobLoader) - Method in interface com.amazon.carbonado.repo.jdbc.JDBCSupport
+
 
+
Converter - Class in com.amazon.carbonado.util
+
+
General purpose type converter.
+
+
Converter() - Constructor for class com.amazon.carbonado.util.Converter
+
 
+
convertValue(CodeBuilder, Class, Class) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Converts a value on the stack.
+
+
copy() - Method in interface com.amazon.carbonado.Storable
+
+
Returns an exact shallow copy of this object, including the state.
+
+
COPY_ALL_PROPERTIES - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
COPY_DIRTY_PROPERTIES - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
COPY_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
COPY_PRIMARY_KEY_PROPERTIES - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
COPY_UNEQUAL_PROPERTIES - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
COPY_VERSION_PROPERTY - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
copyAllProperties(S, T) - Method in class com.amazon.carbonado.gen.StorableCopier
+
 
+
copyAllProperties(S) - Method in interface com.amazon.carbonado.Storable
+
+
Copies all supported properties, skipping any that are uninitialized.
+
+
copyDirtyProperties(S, T) - Method in class com.amazon.carbonado.gen.StorableCopier
+
 
+
copyDirtyProperties(S) - Method in interface com.amazon.carbonado.Storable
+
+
Copies all supported non-primary key properties which are + dirty.
+
+
copyFromMaster(Storable, S) - Method in interface com.amazon.carbonado.repo.indexed.IndexEntryAccessor
+
+
Sets all the properties of the given index entry, using the applicable + properties of the given master.
+
+
copyFromMaster(Storable, S) - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceAccess
+
+
Sets all the properties of the given reference, using the applicable + properties of the given master.
+
+
copyFromMaster(Storable, S) - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder
+
+
Deprecated. +
call getReferenceAccess
+
+
+
copyInto(Collection<? super S>) - Method in class com.amazon.carbonado.cursor.AbstractCursor
+
 
+
copyInto(Collection<? super S>, int) - Method in class com.amazon.carbonado.cursor.AbstractCursor
+
 
+
copyInto(Collection<? super S>) - Method in interface com.amazon.carbonado.Cursor
+
+
Copies all remaining next elements into the given collection.
+
+
copyInto(Collection<? super S>, int) - Method in interface com.amazon.carbonado.Cursor
+
+
Copies a limited amount of remaining next elements into the given + collection.
+
+
copyInto(Collection<? super S>) - Method in class com.amazon.carbonado.cursor.EmptyCursor
+
+
Performs no copy and always returns 0.
+
+
copyInto(Collection<? super S>, int) - Method in class com.amazon.carbonado.cursor.EmptyCursor
+
+
Performs no copy and always returns 0.
+
+
copyInto(Collection<? super S>) - Method in class com.amazon.carbonado.cursor.SingletonCursor
+
 
+
copyInto(Collection<? super S>, int) - Method in class com.amazon.carbonado.cursor.SingletonCursor
+
 
+
copyPrimaryKeyProperties(S, T) - Method in class com.amazon.carbonado.gen.StorableCopier
+
 
+
copyPrimaryKeyProperties(S) - Method in interface com.amazon.carbonado.Storable
+
+
Copies all supported primary key properties, skipping any that are + uninitialized.
+
+
copyToMasterPrimaryKey(Storable, S) - Method in interface com.amazon.carbonado.repo.indexed.IndexEntryAccessor
+
+
Sets all the primary key properties of the given master, using the + applicable properties of the given index entry.
+
+
copyToMasterPrimaryKey(Storable, S) - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceAccess
+
+
Sets all the primary key properties of the given master, using the + applicable properties of the given reference.
+
+
copyToMasterPrimaryKey(Storable, S) - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder
+
+
Deprecated. +
call getReferenceAccess
+
+
+
copyUnequalProperties(S, T) - Method in class com.amazon.carbonado.gen.StorableCopier
+
 
+
copyUnequalProperties(S) - Method in interface com.amazon.carbonado.Storable
+
+
Copies all supported non-primary key properties which are unequal, + skipping any that are uninitialized.
+
+
copyVersionProperty(S, T) - Method in class com.amazon.carbonado.gen.StorableCopier
+
 
+
copyVersionProperty(S) - Method in interface com.amazon.carbonado.Storable
+
+
Copies the optional version property, unless it is uninitialized.
+
+
CorruptEncodingException - Exception in com.amazon.carbonado
+
+
A CorruptEncodingException is caused when decoding an encoded record fails.
+
+
CorruptEncodingException() - Constructor for exception com.amazon.carbonado.CorruptEncodingException
+
 
+
CorruptEncodingException(String) - Constructor for exception com.amazon.carbonado.CorruptEncodingException
+
 
+
CorruptEncodingException(String, Throwable) - Constructor for exception com.amazon.carbonado.CorruptEncodingException
+
 
+
CorruptEncodingException(Throwable) - Constructor for exception com.amazon.carbonado.CorruptEncodingException
+
 
+
CorruptEncodingException(int, int) - Constructor for exception com.amazon.carbonado.CorruptEncodingException
+
 
+
count(FilterValues<S>) - Method in class com.amazon.carbonado.qe.AbstractQueryExecutor
+
+
Counts results by opening a cursor and skipping entries.
+
+
count(FilterValues<S>, Query.Controller) - Method in class com.amazon.carbonado.qe.AbstractQueryExecutor
+
+
Counts results by opening a cursor and skipping entries.
+
+
count(FilterValues<S>) - Method in class com.amazon.carbonado.qe.DelegatedQueryExecutor
+
 
+
count(FilterValues<S>, Query.Controller) - Method in class com.amazon.carbonado.qe.DelegatedQueryExecutor
+
 
+
count() - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always returns zero.
+
+
count(Query.Controller) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always returns zero.
+
+
count(FilterValues<S>) - Method in class com.amazon.carbonado.qe.FullScanQueryExecutor
+
 
+
count(FilterValues<S>, Query.Controller) - Method in class com.amazon.carbonado.qe.FullScanQueryExecutor
+
 
+
count(FilterValues<S>) - Method in interface com.amazon.carbonado.qe.QueryExecutor
+
+
Counts the query results using the given filter values.
+
+
count(FilterValues<S>, Query.Controller) - Method in interface com.amazon.carbonado.qe.QueryExecutor
+
+
Counts the query results using the given filter values.
+
+
count(FilterValues<S>) - Method in class com.amazon.carbonado.qe.SortedQueryExecutor
+
 
+
count(FilterValues<S>, Query.Controller) - Method in class com.amazon.carbonado.qe.SortedQueryExecutor
+
 
+
count() - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
count(Query.Controller) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
count() - Method in interface com.amazon.carbonado.Query
+
+
Returns a count of all results matched by this query.
+
+
count(Query.Controller) - Method in interface com.amazon.carbonado.Query
+
+
Returns a count of all results matched by this query.
+
+
countAll() - Method in interface com.amazon.carbonado.qe.FullScanQueryExecutor.Support
+
+
Counts all Storables.
+
+
countAll(Query.Controller) - Method in interface com.amazon.carbonado.qe.FullScanQueryExecutor.Support
+
+
Counts all Storables.
+
+
create(DataSource) - Static method in class com.amazon.carbonado.repo.jdbc.LoggingDataSource
+
+
Wraps the given DataSource which logs to the default log.
+
+
create(DataSource, Log) - Static method in class com.amazon.carbonado.repo.jdbc.LoggingDataSource
+
+
Wraps the given DataSource which logs to the given log.
+
+
create(String) - Method in class com.amazon.carbonado.sequence.SequenceValueProducerPool
+
 
+
create(Class) - Method in class com.amazon.carbonado.spi.StoragePool
+
 
+
create(K) - Method in class com.amazon.carbonado.util.AbstractPool
+
+
Return a new value instance.
+
+
createBogus() - Method in class com.amazon.carbonado.spi.BelatedRepositoryCreator
+
 
+
createBogus() - Method in class com.amazon.carbonado.spi.BelatedStorageCreator
+
 
+
createBogus() - Method in class com.amazon.carbonado.util.BelatedCreator
+
+
Create instance of bogus object.
+
+
createCodec(Class<S>, StorableIndex, boolean, Layout) - Method in class com.amazon.carbonado.raw.CustomStorableCodecFactory
+
 
+
createCodec(Class<S>, StorableIndex, boolean, Layout, RawSupport) - Method in class com.amazon.carbonado.raw.CustomStorableCodecFactory
+
 
+
createCodec(Class<S>, boolean, Layout) - Method in class com.amazon.carbonado.raw.CustomStorableCodecFactory
+
 
+
createCodec(Class<S>, boolean, Layout, RawSupport) - Method in class com.amazon.carbonado.raw.CustomStorableCodecFactory
+
 
+
createCodec(Class<S>, StorableIndex, boolean, Layout) - Method in class com.amazon.carbonado.raw.GenericStorableCodecFactory
+
 
+
createCodec(Class<S>, StorableIndex, boolean, Layout, RawSupport) - Method in class com.amazon.carbonado.raw.GenericStorableCodecFactory
+
 
+
createCodec(Class<S>, StorableIndex, boolean, Layout) - Method in interface com.amazon.carbonado.raw.StorableCodecFactory
+
 
+
createCodec(Class<S>, StorableIndex, boolean, Layout, RawSupport) - Method in interface com.amazon.carbonado.raw.StorableCodecFactory
+
 
+
createComparator(Class<S>, String...) - Static method in class com.amazon.carbonado.cursor.SortedCursor
+
+
Convenience method to create a comparator which orders storables by the + given order-by properties.
+
+
createComparator(OrderedProperty<S>...) - Static method in class com.amazon.carbonado.cursor.SortedCursor
+
+
Convenience method to create a comparator which orders storables by the + given properties.
+
+
createComparator(List<OrderedProperty<S>>) - Static method in class com.amazon.carbonado.cursor.SortedCursor
+
+
Convenience method to create a comparator which orders storables by the + given properties.
+
+
createdNotification(T) - Method in class com.amazon.carbonado.util.BelatedCreator
+
+
Notification that createReal has produced the real object.
+
+
createExecutor() - Method in class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result
+
+
Creates a QueryExecutor based on this result.
+
+
createExecutor() - Method in class com.amazon.carbonado.qe.UnionQueryAnalyzer.Result
+
+
Creates a QueryExecutor based on this result.
+
+
createMap(Class<S>, S) - Static method in class com.amazon.carbonado.gen.StorablePropertyMap
+
 
+
createNewBlob(int) - Method in class com.amazon.carbonado.spi.LobEngine
+
+
Returns a new Blob whose length is zero.
+
+
createNewClob(int) - Method in class com.amazon.carbonado.spi.LobEngine
+
+
Returns a new Clob whose length is zero.
+
+
createQuery(Filter<S>, FilterValues<S>, OrderingList<S>, QueryHints) - Method in class com.amazon.carbonado.qe.QueryEngine
+
 
+
createQuery(Filter<S>, FilterValues<S>, OrderingList<S>, QueryHints) - Method in class com.amazon.carbonado.qe.StandardQueryFactory
+
+
Implement this method to return query implementations.
+
+
createReal() - Method in class com.amazon.carbonado.spi.BelatedRepositoryCreator
+
 
+
createReal() - Method in class com.amazon.carbonado.spi.BelatedStorageCreator
+
 
+
createReal() - Method in class com.amazon.carbonado.util.BelatedCreator
+
+
Create instance of real object.
+
+
createSequenceValueProducer(String) - Method in class com.amazon.carbonado.sequence.SequenceValueProducerPool
+
 
+
createSequenceValueProducer(String) - Method in class com.amazon.carbonado.spi.AbstractRepository
+
+
Called upon to create a new SequenceValueProducer instance.
+
+
createSortBuffer() - Method in class com.amazon.carbonado.qe.SortedQueryExecutor.ArraySortSupport
+
+
Returns a new ArraySortBuffer.
+
+
createSortBuffer(Query.Controller) - Method in class com.amazon.carbonado.qe.SortedQueryExecutor.ArraySortSupport
+
+
Returns a new ArraySortBuffer.
+
+
createSortBuffer() - Method in class com.amazon.carbonado.qe.SortedQueryExecutor.MergeSortSupport
+
+
Returns a new MergeSortBuffer.
+
+
createSortBuffer(Query.Controller) - Method in class com.amazon.carbonado.qe.SortedQueryExecutor.MergeSortSupport
+
+
Returns a new MergeSortBuffer.
+
+
createSortBuffer() - Method in interface com.amazon.carbonado.qe.SortedQueryExecutor.Support
+
+
Implementation must return an empty buffer for sorting.
+
+
createSortBuffer(Query.Controller) - Method in interface com.amazon.carbonado.qe.SortedQueryExecutor.Support
+
+
Implementation must return an empty buffer for sorting.
+
+
createStorableClassFile(ClassInjector, Class<S>, boolean, String) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Define a classfile appropriate for most Storables.
+
+
createStorage(Class<S>) - Method in class com.amazon.carbonado.spi.AbstractRepository
+
+
Called upon to create a new Storage instance.
+
+
createStorage(Class<S>) - Method in class com.amazon.carbonado.spi.StoragePool
+
 
+
createStrategy(Class<S>, StorableIndex<S>, LayoutOptions) - Method in class com.amazon.carbonado.raw.CompressedStorableCodecFactory
+
 
+
createStrategy(Class<S>, StorableIndex<S>) - Method in class com.amazon.carbonado.raw.GenericStorableCodecFactory
+
+
Override to return a different EncodingStrategy.
+
+
createStrategy(Class<S>, StorableIndex<S>, LayoutOptions) - Method in class com.amazon.carbonado.raw.GenericStorableCodecFactory
+
+
Override to return a different EncodingStrategy.
+
+
createTxn(Txn, IsolationLevel) - Method in class com.amazon.carbonado.txn.TransactionManager
+
+
Creates an internal transaction representation, with the optional parent + transaction.
+
+
createTxn(Txn, IsolationLevel, int, TimeUnit) - Method in class com.amazon.carbonado.txn.TransactionManager
+
+
Creates an internal transaction representation, with the optional parent + transaction.
+
+
Cursor<S> - Interface in com.amazon.carbonado
+
+
Represents the results of a Query's fetch + operation.
+
+
CustomStorableCodec<S extends Storable> - Class in com.amazon.carbonado.raw
+
+
Allows codecs to be defined for storables that have a custom encoding.
+
+
CustomStorableCodec(Class<S>, boolean) - Constructor for class com.amazon.carbonado.raw.CustomStorableCodec
+
 
+
CustomStorableCodec(Class<S>, boolean, RawSupport<S>) - Constructor for class com.amazon.carbonado.raw.CustomStorableCodec
+
 
+
CustomStorableCodec.InstanceFactory - Interface in com.amazon.carbonado.raw
+
 
+
CustomStorableCodecFactory - Class in com.amazon.carbonado.raw
+
+
Factory for custom storable codecs.
+
+
CustomStorableCodecFactory() - Constructor for class com.amazon.carbonado.raw.CustomStorableCodecFactory
+
 
+
+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.

+ + diff --git a/apidocs/index-files/index-4.html b/apidocs/index-files/index-4.html new file mode 100644 index 0000000..c1e3fdb --- /dev/null +++ b/apidocs/index-files/index-4.html @@ -0,0 +1,622 @@ + + + + + + +D-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  + + +

D

+
+
databaseName(String) - Method in interface com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder.DatabaseHook
+
+
Returns an appropriate database name for the given type.
+
+
DataDecoder - Class in com.amazon.carbonado.raw
+
+
A very low-level class that decodes key components encoded by methods of + DataEncoder.
+
+
DataDecoder() - Constructor for class com.amazon.carbonado.raw.DataDecoder
+
 
+
DataEncoder - Class in com.amazon.carbonado.raw
+
+
A very low-level class that supports encoding of primitive data.
+
+
DataEncoder() - Constructor for class com.amazon.carbonado.raw.DataEncoder
+
 
+
DateTimeAdapter - Annotation Type in com.amazon.carbonado.adapter
+
+
Converts Joda-Time datetime objects to and from other forms.
+
+
DateTimeAdapter.Adapter - Class in com.amazon.carbonado.adapter
+
+
Adapter implementation for DateTimeAdapter.
+
+
DateTimeAdapter.Adapter(Class<?>, String, DateTimeAdapter) - Constructor for class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
DateTimeAdapter.Adapter(Class<?>, String, DateTimeZone) - Constructor for class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
decode(byte[]) - Method in class com.amazon.carbonado.layout.LayoutOptions
+
 
+
decode(byte[], int, BigInteger[]) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a BigInteger.
+
+
decode(byte[], int, BigDecimal[]) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a BigDecimal.
+
+
decode(byte[], int, byte[][]) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes the given byte array.
+
+
decode(S, int, byte[]) - Method in class com.amazon.carbonado.raw.GenericStorableCodec
+
 
+
decode(S, byte[]) - Method in interface com.amazon.carbonado.raw.GenericStorableCodec.Decoder
+
 
+
decode(byte[], int, BigInteger[]) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes the given BigInteger as originally encoded for ascending order.
+
+
decode(byte[], int, BigDecimal[]) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes the given BigDecimal as originally encoded for ascending order.
+
+
decode(byte[], int, byte[][]) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes the given byte array as originally encoded for ascending order.
+
+
decode(S, int, byte[]) - Method in interface com.amazon.carbonado.raw.RawSupport
+
+
Used for decoding different generations of Storable.
+
+
decode(S, int, byte[]) - Method in interface com.amazon.carbonado.raw.StorableCodec
+
+
Used for decoding different generations of Storable.
+
+
DECODE_DATA_METHOD_NAME - Static variable in class com.amazon.carbonado.raw.RawStorableGenerator
+
+
Name of protected abstract method in generated storable
+
+
DECODE_KEY_METHOD_NAME - Static variable in class com.amazon.carbonado.raw.RawStorableGenerator
+
+
Name of protected abstract method in generated storable
+
+
decodeBoolean(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a boolean from exactly 1 byte.
+
+
decodeBooleanDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a boolean from exactly 1 byte, as encoded for descending order.
+
+
decodeBooleanObj(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a Boolean object from exactly 1 byte.
+
+
decodeBooleanObjDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a Boolean object from exactly 1 byte, as encoded for descending + order.
+
+
decodeByte(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a signed byte from exactly 1 byte.
+
+
decodeByteDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a signed byte from exactly 1 byte, as encoded for descending + order.
+
+
decodeByteObj(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a signed Byte object from exactly 1 or 2 bytes.
+
+
decodeByteObjDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a signed Byte object from exactly 1 or 2 bytes, as encoded for + descending order.
+
+
decodeChar(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a char from exactly 2 bytes.
+
+
decodeCharacterObj(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a Character object from exactly 1 or 3 bytes.
+
+
decodeCharacterObjDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a Character object from exactly 1 or 3 bytes, as encoded for + descending order.
+
+
decodeCharDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a char from exactly 2 bytes, as encoded for descending order.
+
+
decodeData(S, byte[]) - Method in class com.amazon.carbonado.raw.CustomStorableCodec
+
+
Decode the data into properties of the storable.
+
+
decodeDesc(byte[], int, BigInteger[]) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes the given BigInteger as originally encoded for descending order.
+
+
decodeDesc(byte[], int, BigDecimal[]) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes the given BigDecimal as originally encoded for descending order.
+
+
decodeDesc(byte[], int, byte[][]) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes the given byte array as originally encoded for descending order.
+
+
decodeDouble(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a double from exactly 8 bytes.
+
+
decodeDoubleBits(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
 
+
decodeDoubleDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a double from exactly 8 bytes, as encoded for descending order.
+
+
decodeDoubleObj(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a Double object from exactly 8 bytes.
+
+
decodeDoubleObjDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a Double object from exactly 8 bytes.
+
+
decodeFloat(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a float from exactly 4 bytes.
+
+
decodeFloatBits(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
 
+
decodeFloatDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a float from exactly 4 bytes, as encoded for descending order.
+
+
decodeFloatObj(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a Float object from exactly 4 bytes.
+
+
decodeFloatObjDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a Float object from exactly 4 bytes.
+
+
decodeInt(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a signed integer from exactly 4 bytes.
+
+
decodeIntDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a signed integer from exactly 4 bytes, as encoded for descending + order.
+
+
decodeIntegerObj(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a signed Integer object from exactly 1 or 5 bytes.
+
+
decodeIntegerObjDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a signed Integer object from exactly 1 or 5 bytes, as encoded + for descending order.
+
+
decodeLong(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a signed long from exactly 8 bytes.
+
+
decodeLongDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a signed long from exactly 8 bytes, as encoded for descending + order.
+
+
decodeLongObj(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a signed Long object from exactly 1 or 9 bytes.
+
+
decodeLongObjDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a signed Long object from exactly 1 or 9 bytes, as encoded for + descending order.
+
+
decodePrimaryKey(S, byte[]) - Method in class com.amazon.carbonado.raw.CustomStorableCodec
+
+
Decode the primary key into properties of the storable.
+
+
decodeShort(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a signed short from exactly 2 bytes.
+
+
decodeShortDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a signed short from exactly 2 bytes, as encoded for descending + order.
+
+
decodeShortObj(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a signed Short object from exactly 1 or 3 bytes.
+
+
decodeShortObjDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a signed Short object from exactly 1 or 3 bytes, as encoded for + descending order.
+
+
decodeSingle(byte[], int, int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes the given byte array which was encoded by DataEncoder.encodeSingle(byte[], int, int).
+
+
decodeSingleDesc(byte[]) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes the given byte array which was encoded by KeyEncoder.encodeSingleDesc(byte[]).
+
+
decodeSingleDesc(byte[], int, int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes the given byte array which was encoded by KeyEncoder.encodeSingleDesc(byte[]).
+
+
decodeSingleNullable(byte[]) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes the given byte array which was encoded by DataEncoder.encodeSingleNullable(byte[]).
+
+
decodeSingleNullable(byte[], int, int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes the given byte array which was encoded by DataEncoder.encodeSingleNullable(byte[]).
+
+
decodeSingleNullableDesc(byte[]) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes the given byte array which was encoded by KeyEncoder.encodeSingleNullableDesc(byte[]).
+
+
decodeSingleNullableDesc(byte[], int, int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes the given byte array which was encoded by KeyEncoder.encodeSingleNullableDesc(byte[]).
+
+
decodeString(byte[], int, String[]) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes an encoded string from the given byte array.
+
+
decodeString(byte[], int, String[]) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes an encoded string from the given byte array.
+
+
decodeStringDesc(byte[], int, String[]) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes an encoded string from the given byte array as originally + encoded for descending order.
+
+
decompress(byte[], int) - Static method in class com.amazon.carbonado.raw.GzipCompressor
+
+
Decodes from compressed form.
+
+
decrement(byte[]) - Static method in class com.amazon.carbonado.raw.RawUtil
+
+
Subtracts one from an unsigned integer, represented as a byte array.
+
+
DEFAULT_INCREMENT - Static variable in class com.amazon.carbonado.sequence.SequenceValueGenerator
+
 
+
DEFAULT_INITIAL_VALUE - Static variable in class com.amazon.carbonado.sequence.SequenceValueGenerator
+
 
+
DEFAULT_RESERVE_AMOUNT - Static variable in class com.amazon.carbonado.sequence.SequenceValueGenerator
+
 
+
defineCopyBridges(ClassFile, Class) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Add copy bridge methods for all classes/interfaces between the leaf + (genericised class) and the root (genericised baseclass).
+
+
definePrepareBridges(ClassFile, Class) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Add prepare bridge methods for all classes/interfaces between the leaf + (genericised class) and the root (genericised baseclass).
+
+
definePrepareMethod(ClassFile, Class, TypeDesc) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Defines a Storable prepare method, which assumes that a support field + exists and a single-argument constructor exists which accepts a support + instance.
+
+
definePrepareMethod(ClassFile, Class, TypeDesc, String, TypeDesc) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Defines a Storable prepare method, which assumes that a support field + exists and a single-argument constructor exists which accepts a support + instance.
+
+
definePropertyBeanMethods(ClassFile, SyntheticProperty) - Method in class com.amazon.carbonado.synthetic.SyntheticStorableBuilder
+
+
Add the get & set methods for this property
+
+
DelegatedQueryExecutor<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
QueryExecutor which delegates by executing a Query on a Storage.
+
+
DelegatedQueryExecutor(Storage<S>, QueryExecutor<S>) - Constructor for class com.amazon.carbonado.qe.DelegatedQueryExecutor
+
 
+
DelegatedQueryExecutor(Storage<S>, Filter<S>, OrderingList<S>) - Constructor for class com.amazon.carbonado.qe.DelegatedQueryExecutor
+
 
+
DelegatedQueryExecutorFactory<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
QueryExecutorFactory which produces executors which delegate via DelegatedQueryExecutor.
+
+
DelegatedQueryExecutorFactory(Storage<S>) - Constructor for class com.amazon.carbonado.qe.DelegatedQueryExecutorFactory
+
 
+
DelegateStorableGenerator<S extends Storable> - Class in com.amazon.carbonado.gen
+
+
Generates and caches concrete implementations of Storable types + which delegate to DelegateSupport.
+
+
DelegateSupport<S extends Storable> - Interface in com.amazon.carbonado.gen
+
+
Provides runtime support for Storable classes generated by DelegateStorableGenerator.
+
+
delete() - Method in interface com.amazon.carbonado.Storable
+
+
Deletes this object from the storage layer by its primary key, + regardless of whether this object has actually been loaded or not.
+
+
DELETE_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
deleteAll() - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Does nothing.
+
+
deleteAll(Query.Controller) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Does nothing.
+
+
deleteAll() - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
deleteAll(Query.Controller) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
deleteAll() - Method in interface com.amazon.carbonado.Query
+
+
Deletes zero or more matching objects.
+
+
deleteAll(Query.Controller) - Method in interface com.amazon.carbonado.Query
+
+
Deletes zero or more matching objects.
+
+
deleteLob(long) - Method in class com.amazon.carbonado.spi.LobEngine
+
+
Deletes Lob data, freeing up all space consumed by it.
+
+
deleteLob(Lob) - Method in class com.amazon.carbonado.spi.LobEngine
+
+
Deletes Lob data, freeing up all space consumed by it.
+
+
deleteOne() - Method in class com.amazon.carbonado.qe.AbstractQuery
+
 
+
deleteOne(Query.Controller) - Method in class com.amazon.carbonado.qe.AbstractQuery
+
 
+
deleteOne() - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always throws PersistNoneException.
+
+
deleteOne(Query.Controller) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always throws PersistNoneException.
+
+
deleteOne() - Method in interface com.amazon.carbonado.Query
+
+
Deletes one matching object.
+
+
deleteOne(Query.Controller) - Method in interface com.amazon.carbonado.Query
+
+
Deletes one matching object.
+
+
Derived - Annotation Type in com.amazon.carbonado
+
+
Identifies a Storable property which is not directly persisted, but + is instead derived from other property values.
+
+
detach() - Method in interface com.amazon.carbonado.Transaction
+
+
Detaches this transaction from the current thread.
+
+
detach() - Method in class com.amazon.carbonado.txn.TransactionPair
+
 
+
DetachedStorableFactory<S extends Storable> - Class in com.amazon.carbonado.gen
+
+
Creates Storable instances which are basic data containers.
+
+
DetachedStorableFactory(Class<S>) - Constructor for class com.amazon.carbonado.gen.DetachedStorableFactory
+
 
+
detachLocalScope() - Method in class com.amazon.carbonado.txn.TransactionManager
+
+
Detaches the thread-local TransactionScope from the current thread.
+
+
detachNotification(Txn) - Method in class com.amazon.carbonado.txn.TransactionManager
+
+
Called to notify internal method that transaction is detached.
+
+
DifferenceCursor<S> - Class in com.amazon.carbonado.cursor
+
+
Wraps two Cursors and performs an asymmetric set difference + operation.
+
+
DifferenceCursor(Cursor<S>, Cursor<S>, Comparator<S>) - Constructor for class com.amazon.carbonado.cursor.DifferenceCursor
+
 
+
Direction - Enum in com.amazon.carbonado.info
+
+
Describes a property sorting direction.
+
+
direction(Direction) - Method in class com.amazon.carbonado.info.OrderedProperty
+
 
+
disableKeyAndValue() - Method in class com.amazon.carbonado.raw.RawCursor
+
+
An optimization hint which disables key and value acquisition.
+
+
disableValue() - Method in class com.amazon.carbonado.raw.RawCursor
+
+
An optimization hint which disables just value acquisition.
+
+
disjunctiveNormalForm() - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns an equivalent filter that is in disjunctive normal form.
+
+
disjunctiveNormalFormSplit() - Method in class com.amazon.carbonado.filter.ClosedFilter
+
 
+
disjunctiveNormalFormSplit() - Method in class com.amazon.carbonado.filter.Filter
+
+
Splits the filter from its disjunctive normal form.
+
+
disjunctiveNormalFormSplit() - Method in class com.amazon.carbonado.filter.OpenFilter
+
 
+
disjunctiveNormalFormSplit() - Method in class com.amazon.carbonado.filter.PropertyFilter
+
 
+
DO_TRY_DELETE_MASTER_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.MasterStorableGenerator
+
+
Name of protected abstract method in generated storable
+
+
DO_TRY_DELETE_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Name of protected abstract method in generated storable
+
+
DO_TRY_INSERT_MASTER_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.MasterStorableGenerator
+
+
Name of protected abstract method in generated storable
+
+
DO_TRY_INSERT_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Name of protected abstract method in generated storable
+
+
DO_TRY_LOAD_MASTER_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.MasterStorableGenerator
+
+
Name of protected abstract method in generated storable
+
+
DO_TRY_LOAD_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Name of protected abstract method in generated storable
+
+
DO_TRY_UPDATE_MASTER_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.MasterStorableGenerator
+
+
Name of protected abstract method in generated storable
+
+
DO_TRY_UPDATE_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Name of protected abstract method in generated storable
+
+
doFire(Throwable) - Method in class com.amazon.carbonado.util.ThrowUnchecked
+
+
Deprecated.
+ 
+
doTryDelete(S) - Method in interface com.amazon.carbonado.gen.DelegateSupport
+
 
+
doTryInsert(S) - Method in interface com.amazon.carbonado.gen.DelegateSupport
+
 
+
doTryLoad(S) - Method in interface com.amazon.carbonado.gen.DelegateSupport
+
 
+
doTryUpdate(S) - Method in interface com.amazon.carbonado.gen.DelegateSupport
+
 
+
+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.

+ + diff --git a/apidocs/index-files/index-5.html b/apidocs/index-files/index-5.html new file mode 100644 index 0000000..96ebc50 --- /dev/null +++ b/apidocs/index-files/index-5.html @@ -0,0 +1,764 @@ + + + + + + +E-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  + + +

E

+
+
EmptyCursor<S> - Class in com.amazon.carbonado.cursor
+
+
Special cursor implementation that is empty.
+
+
emptyHints() - Static method in class com.amazon.carbonado.qe.QueryHints
+
 
+
emptyList() - Static method in class com.amazon.carbonado.qe.OrderingList
+
+
Returns a canonical empty instance.
+
+
EmptyQuery<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
Special query implementation that fetches nothing.
+
+
EmptyQuery(QueryFactory<S>, OrderingList<S>) - Constructor for class com.amazon.carbonado.qe.EmptyQuery
+
 
+
EmptyQuery(QueryFactory<S>, String) - Constructor for class com.amazon.carbonado.qe.EmptyQuery
+
 
+
EmptyQuery(QueryFactory<S>, String...) - Constructor for class com.amazon.carbonado.qe.EmptyQuery
+
 
+
enableKeyAndValue() - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Enable key and value acquisition again, after they have been + disabled.
+
+
encode() - Method in class com.amazon.carbonado.layout.LayoutOptions
+
 
+
encode(int, byte[], int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given signed integer into exactly 4 bytes.
+
+
encode(Integer, byte[], int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given signed Integer object into exactly 1 or 5 bytes.
+
+
encode(long, byte[], int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given signed long into exactly 8 bytes.
+
+
encode(Long, byte[], int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given signed Long object into exactly 1 or 9 bytes.
+
+
encode(byte, byte[], int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given signed byte into exactly 1 byte.
+
+
encode(Byte, byte[], int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given signed Byte object into exactly 1 or 2 bytes.
+
+
encode(short, byte[], int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given signed short into exactly 2 bytes.
+
+
encode(Short, byte[], int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given signed Short object into exactly 1 or 3 bytes.
+
+
encode(char, byte[], int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given character into exactly 2 bytes.
+
+
encode(Character, byte[], int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given Character object into exactly 1 or 3 bytes.
+
+
encode(boolean, byte[], int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given boolean into exactly 1 byte.
+
+
encode(Boolean, byte[], int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given Boolean object into exactly 1 byte.
+
+
encode(float, byte[], int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given float into exactly 4 bytes.
+
+
encode(Float, byte[], int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given Float object into exactly 4 bytes.
+
+
encode(double, byte[], int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given double into exactly 8 bytes.
+
+
encode(Double, byte[], int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given Double object into exactly 8 bytes.
+
+
encode(BigInteger, byte[], int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given optional BigInteger into a variable amount of + bytes.
+
+
encode(BigDecimal, byte[], int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given optional BigDecimal into a variable amount of + bytes.
+
+
encode(byte[], byte[], int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given optional byte array into a variable amount of + bytes.
+
+
encode(byte[], int, int, byte[], int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given optional byte array into a variable amount of + bytes.
+
+
encode(String, byte[], int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given optional String into a variable amount of bytes.
+
+
encode(BigInteger, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given optional BigInteger into a variable amount of + bytes.
+
+
encode(BigDecimal, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given optional BigDecimal into a variable amount of + bytes.
+
+
encode(byte[], byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given optional unsigned byte array into a variable amount of + bytes.
+
+
encode(byte[], int, int, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given optional unsigned byte array into a variable amount of + bytes.
+
+
encode(String, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given optional String into a variable amount of bytes.
+
+
ENCODE_DATA_METHOD_NAME - Static variable in class com.amazon.carbonado.raw.RawStorableGenerator
+
+
Name of protected abstract method in generated storable
+
+
ENCODE_KEY_METHOD_NAME - Static variable in class com.amazon.carbonado.raw.RawStorableGenerator
+
+
Name of protected abstract method in generated storable
+
+
encodeData(S) - Method in class com.amazon.carbonado.raw.CustomStorableCodec
+
+
Encode all properties of the storable excluding the primary key.
+
+
encodeDesc(int, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given signed integer into exactly 4 bytes for descending + order.
+
+
encodeDesc(Integer, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given signed Integer object into exactly 1 or 5 bytes for + descending order.
+
+
encodeDesc(long, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given signed long into exactly 8 bytes for descending order.
+
+
encodeDesc(Long, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given signed Long object into exactly 1 or 9 bytes for + descending order.
+
+
encodeDesc(byte, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given signed byte into exactly 1 byte for descending order.
+
+
encodeDesc(Byte, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given signed Byte object into exactly 1 or 2 bytes for + descending order.
+
+
encodeDesc(short, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given signed short into exactly 2 bytes for descending + order.
+
+
encodeDesc(Short, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given signed Short object into exactly 1 or 3 bytes for + descending order.
+
+
encodeDesc(char, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given character into exactly 2 bytes for descending order.
+
+
encodeDesc(Character, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given Character object into exactly 1 or 3 bytes for + descending order.
+
+
encodeDesc(boolean, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given boolean into exactly 1 byte for descending order.
+
+
encodeDesc(Boolean, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given Boolean object into exactly 1 byte for descending + order.
+
+
encodeDesc(float, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given float into exactly 4 bytes for descending order.
+
+
encodeDesc(Float, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given Float object into exactly 4 bytes for descending + order.
+
+
encodeDesc(double, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given double into exactly 8 bytes for descending order.
+
+
encodeDesc(Double, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given Double object into exactly 8 bytes for descending + order.
+
+
encodeDesc(BigInteger, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given optional BigInteger into a variable amount of bytes + for descending order.
+
+
encodeDesc(BigDecimal, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given optional BigDecimal into a variable amount of bytes + for descending order.
+
+
encodeDesc(byte[], byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given optional unsigned byte array into a variable amount of + bytes for descending order.
+
+
encodeDesc(byte[], int, int, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given optional unsigned byte array into a variable amount of + bytes for descending order.
+
+
encodeDesc(String, byte[], int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given optional String into a variable amount of bytes for + descending order.
+
+
encodePrimaryKey(S) - Method in class com.amazon.carbonado.raw.CustomStorableCodec
+
 
+
encodePrimaryKey(Object[]) - Method in class com.amazon.carbonado.raw.CustomStorableCodec
+
 
+
encodePrimaryKey(S) - Method in class com.amazon.carbonado.raw.GenericStorableCodec
+
 
+
encodePrimaryKey(S, int, int) - Method in class com.amazon.carbonado.raw.GenericStorableCodec
+
 
+
encodePrimaryKey(Object[]) - Method in class com.amazon.carbonado.raw.GenericStorableCodec
+
 
+
encodePrimaryKey(Object[], int, int) - Method in class com.amazon.carbonado.raw.GenericStorableCodec
+
 
+
encodePrimaryKey(S) - Method in interface com.amazon.carbonado.raw.StorableCodec
+
+
Encode a key by extracting all the primary key properties from the given + storable.
+
+
encodePrimaryKey(S, int, int) - Method in interface com.amazon.carbonado.raw.StorableCodec
+
+
Encode a key by extracting all the primary key properties from the given + storable.
+
+
encodePrimaryKey(Object[]) - Method in interface com.amazon.carbonado.raw.StorableCodec
+
+
Encode a key by extracting all the primary key properties from the given + storable.
+
+
encodePrimaryKey(Object[], int, int) - Method in interface com.amazon.carbonado.raw.StorableCodec
+
+
Encode a key by extracting all the primary key properties from the given + storable.
+
+
encodePrimaryKeyPrefix() - Method in class com.amazon.carbonado.raw.GenericStorableCodec
+
 
+
encodePrimaryKeyPrefix() - Method in interface com.amazon.carbonado.raw.StorableCodec
+
+
Encode the primary key for when there are no values, but there may be a + prefix.
+
+
encodeSearchKey(S) - Method in interface com.amazon.carbonado.raw.GenericStorableCodec.SearchKeyFactory
+
+
Build a search key by extracting all the desired properties from the + given storable.
+
+
encodeSearchKey(S, int, int) - Method in interface com.amazon.carbonado.raw.GenericStorableCodec.SearchKeyFactory
+
+
Build a search key by extracting all the desired properties from the + given storable.
+
+
encodeSearchKey(Object[]) - Method in interface com.amazon.carbonado.raw.GenericStorableCodec.SearchKeyFactory
+
+
Build a search key by supplying property values without a storable.
+
+
encodeSearchKey(Object[], int, int) - Method in interface com.amazon.carbonado.raw.GenericStorableCodec.SearchKeyFactory
+
+
Build a search key by supplying property values without a storable.
+
+
encodeSearchKeyPrefix() - Method in interface com.amazon.carbonado.raw.GenericStorableCodec.SearchKeyFactory
+
+
Returns the search key for when there are no values.
+
+
encodeSingle(byte[], int, int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given byte array for use when there is only a single + property, whose type is a byte array.
+
+
encodeSingleDesc(byte[]) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given byte array for use when there is only a single + required property, descending order, whose type is a byte array.
+
+
encodeSingleDesc(byte[], int, int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given byte array for use when there is only a single + required property, descending order, whose type is a byte array.
+
+
encodeSingleNullable(byte[]) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given byte array for use when there is only a single + nullable property, whose type is a byte array.
+
+
encodeSingleNullable(byte[], int, int) - Static method in class com.amazon.carbonado.raw.DataEncoder
+
+
Encodes the given byte array for use when there is only a single + nullable property, whose type is a byte array.
+
+
encodeSingleNullableDesc(byte[]) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given byte array for use when there is only a single + nullable property, descending order, whose type is a byte array.
+
+
encodeSingleNullableDesc(byte[], int, int) - Static method in class com.amazon.carbonado.raw.KeyEncoder
+
+
Encodes the given byte array for use when there is only a single + nullable property, descending order, whose type is a byte array.
+
+
endBackup() - Method in interface com.amazon.carbonado.repo.sleepycat.HotBackupCapability.Backup
+
+
Resume normal operation.
+
+
enter(IsolationLevel) - Method in class com.amazon.carbonado.txn.TransactionScope
+
+
Enters a new transaction scope which becomes the active transaction.
+
+
ENTER_TRANSACTION_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Repository API method name
+
+
entered(Transaction, Transaction) - Method in interface com.amazon.carbonado.txn.TransactionMonitor
+
+
Called by a thread which has just entered a transaction.
+
+
enterTop(IsolationLevel) - Method in class com.amazon.carbonado.txn.TransactionScope
+
+
Enters a new top-level transaction scope which becomes the active + transaction.
+
+
enterTopTransaction(IsolationLevel) - Method in interface com.amazon.carbonado.Repository
+
+
Causes the current thread to enter a top-level transaction scope + with an explict isolation level.
+
+
enterTopTransaction(IsolationLevel) - Method in class com.amazon.carbonado.spi.AbstractRepository
+
 
+
enterTransaction(IsolationLevel) - Method in class com.amazon.carbonado.qe.StandardQuery
+
+
Enter a transaction as needed by the standard delete operation, or null + if transactions are not supported.
+
+
enterTransaction() - Method in interface com.amazon.carbonado.Repository
+
+
Causes the current thread to enter a transaction scope.
+
+
enterTransaction(IsolationLevel) - Method in interface com.amazon.carbonado.Repository
+
+
Causes the current thread to enter a transaction scope with an explict + isolation level.
+
+
enterTransaction() - Method in class com.amazon.carbonado.spi.AbstractRepository
+
 
+
enterTransaction(IsolationLevel) - Method in class com.amazon.carbonado.spi.AbstractRepository
+
 
+
entrySet() - Method in class com.amazon.carbonado.gen.StorablePropertyMap
+
 
+
EnvironmentCapability - Interface in com.amazon.carbonado.repo.sleepycat
+
+
Capability to provide direct access to the underlying BDB environment.
+
+
EQUAL_PRIMARY_KEYS_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
EQUAL_PROPERTIES_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
equalLayouts(Layout) - Method in class com.amazon.carbonado.layout.Layout
+
+
Returns true if the given layout matches this one.
+
+
equalPrimaryKeys(Object) - Method in interface com.amazon.carbonado.Storable
+
+
True if the supported properties which participate in the primary key + are equal.
+
+
equalProperties(Object) - Method in interface com.amazon.carbonado.Storable
+
+
True if all supported properties for this object are equal.
+
+
equals(Object) - Method in class com.amazon.carbonado.filter.AndFilter
+
 
+
equals(Object) - Method in class com.amazon.carbonado.filter.ClosedFilter
+
 
+
equals(Object) - Method in class com.amazon.carbonado.filter.ExistsFilter
+
 
+
equals(Object) - Method in class com.amazon.carbonado.filter.Filter
+
 
+
equals(Object) - Method in class com.amazon.carbonado.filter.Filter.NotJoined
+
 
+
equals(Object) - Method in class com.amazon.carbonado.filter.FilterValues
+
 
+
equals(Object) - Method in class com.amazon.carbonado.filter.OpenFilter
+
 
+
equals(Object) - Method in class com.amazon.carbonado.filter.OrFilter
+
 
+
equals(Object) - Method in class com.amazon.carbonado.filter.PropertyFilter
+
 
+
equals(Object) - Method in class com.amazon.carbonado.info.ChainedProperty
+
 
+
equals(Object) - Method in class com.amazon.carbonado.info.OrderedProperty
+
 
+
equals(Object) - Method in class com.amazon.carbonado.info.StorableIndex
+
 
+
equals(Object) - Method in class com.amazon.carbonado.layout.Layout
+
 
+
equals(Object) - Method in class com.amazon.carbonado.layout.LayoutProperty
+
 
+
equals(Object) - Method in class com.amazon.carbonado.lob.AbstractBlob
+
 
+
equals(Object) - Method in class com.amazon.carbonado.lob.AbstractClob
+
 
+
equals(Object) - Method in interface com.amazon.carbonado.lob.Lob
+
+
Two Lobs are considered equal if the object instances are the same or if + they point to the same content.
+
+
equals(Object) - Method in class com.amazon.carbonado.qe.AbstractQuery
+
 
+
equals(Object) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
 
+
equals(Object) - Method in class com.amazon.carbonado.qe.OrderingList
+
 
+
equals(Object) - Method in class com.amazon.carbonado.qe.QueryHints
+
 
+
equals(Object) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
equals(Object) - Method in interface com.amazon.carbonado.Query
+
 
+
equals(Object) - Method in class com.amazon.carbonado.raw.CompressedEncodingStrategy
+
 
+
equals(Object) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
 
+
equals(Object) - Method in interface com.amazon.carbonado.Storable
+
+
True if all properties and fields are equal, but ignoring the state.
+
+
equals(Object) - Method in class com.amazon.carbonado.synthetic.SyntheticProperty
+
 
+
EQUALS_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
errorCheck(Collection<String>) - Method in class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder
+
 
+
errorCheck(Collection<String>) - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
 
+
errorCheck(Collection<String>) - Method in class com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder
+
 
+
errorCheck(Collection<String>) - Method in class com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder
+
 
+
errorCheck(Collection<String>) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
 
+
errorCheck(Collection<String>) - Method in class com.amazon.carbonado.spi.AbstractRepositoryBuilder
+
+
This method is called by assertReady, and subclasses must override to + perform custom checks.
+
+
evaluate(StorableIndex<S>, Filter<S>, OrderingList<S>) - Static method in class com.amazon.carbonado.qe.CompositeScore
+
+
Evaluates the given index for its filtering and ordering capabilities + against the given filter and order-by properties.
+
+
evaluate(OrderedProperty<S>[], boolean, boolean, Filter<S>, OrderingList<S>) - Static method in class com.amazon.carbonado.qe.CompositeScore
+
+
Evaluates the given index properties for its filtering and ordering + capabilities against the given filter and order-by properties.
+
+
evaluate(StorableIndex<S>, Filter<S>) - Static method in class com.amazon.carbonado.qe.FilteringScore
+
+
Evaluates the given index for its filtering capabilities against the + given filter.
+
+
evaluate(OrderedProperty<S>[], boolean, boolean, Filter<S>) - Static method in class com.amazon.carbonado.qe.FilteringScore
+
+
Evaluates the given index properties for its filtering capabilities + against the given filter.
+
+
evaluate(StorableIndex<S>, Filter<S>, OrderingList<S>) - Static method in class com.amazon.carbonado.qe.OrderingScore
+
+
Evaluates the given index for its ordering capabilities against the + given filter and order-by properties.
+
+
evaluate(OrderedProperty<S>[], boolean, boolean, Filter<S>, OrderingList<S>) - Static method in class com.amazon.carbonado.qe.OrderingScore
+
+
Evaluates the given index properties for its ordering capabilities + against the given filter and order-by properties.
+
+
EVOLUTION_NONE - Static variable in class com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo
+
+
Evolution strategy code
+
+
EVOLUTION_STANDARD - Static variable in class com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo
+
+
Evolution strategy code
+
+
examine(Class<S>) - Static method in class com.amazon.carbonado.info.StorableIntrospector
+
+
Examines the given class and returns a StorableInfo describing it.
+
+
examine(Class<S>, DataSource, String, String) - Static method in class com.amazon.carbonado.repo.jdbc.JDBCStorableIntrospector
+
+
Examines the given class and returns a JDBCStorableInfo describing it.
+
+
ExceptionTransformer - Class in com.amazon.carbonado.spi
+
+
Supports transforming arbitrary exceptions into appropriate repository + exceptions.
+
+
ExceptionTransformer() - Constructor for class com.amazon.carbonado.spi.ExceptionTransformer
+
 
+
execute() - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Call
+
+
Executes the call without expecting a reply.
+
+
execute(Runnable) - Static method in class com.amazon.carbonado.spi.RepairExecutor
+
 
+
execute(Runnable) - Method in class com.amazon.carbonado.util.TaskQueueThread
+
+
Enqueue a task to run.
+
+
execute(Runnable, long) - Method in class com.amazon.carbonado.util.TaskQueueThread
+
+
Enqueue a task to run.
+
+
executeAsync() - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Call
+
+
Executes the call without expecting a reply.
+
+
executor(Filter<S>, OrderingList<S>, QueryHints) - Method in class com.amazon.carbonado.qe.DelegatedQueryExecutorFactory
+
 
+
executor(Filter<S>, OrderingList<S>, QueryHints) - Method in class com.amazon.carbonado.qe.QueryEngine
+
 
+
executor(Filter<S>, OrderingList<S>, QueryHints) - Method in class com.amazon.carbonado.qe.QueryExecutorCache
+
+
Returns an executor from the cache.
+
+
executor(Filter<S>, OrderingList<S>, QueryHints) - Method in interface com.amazon.carbonado.qe.QueryExecutorFactory
+
+
Returns an executor that handles the given query specification.
+
+
executor() - Method in class com.amazon.carbonado.qe.StandardQuery
+
+
Returns the executor in use by this query.
+
+
executor(Filter<S>, OrderingList<S>, QueryHints) - Method in class com.amazon.carbonado.qe.UnionQueryAnalyzer
+
+
Returns an executor that handles the given query specification.
+
+
executorFactory() - Method in class com.amazon.carbonado.qe.StandardQuery
+
+
Return a QueryExecutorFactory which is used to get an executor.
+
+
exists() - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always returns false.
+
+
exists(Query.Controller) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always returns false.
+
+
exists() - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
exists(Query.Controller) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
exists() - Method in interface com.amazon.carbonado.Query
+
+
Returns true if any results are matched by this query.
+
+
exists(Query.Controller) - Method in interface com.amazon.carbonado.Query
+
+
Returns true if any results are matched by this query.
+
+
ExistsFilter<S extends Storable> - Class in com.amazon.carbonado.filter
+
+
Filter tree node that performs an existence or non-existence test against a + join property.
+
+
exit() - Method in interface com.amazon.carbonado.Transaction
+
+
Closes the current transaction, aborting all changes since the last + commit.
+
+
exit() - Method in class com.amazon.carbonado.txn.TransactionPair
+
 
+
EXIT_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Transaction API method name
+
+
exited(Transaction, Transaction) - Method in interface com.amazon.carbonado.txn.TransactionMonitor
+
+
Called by a thread which has just exited a transaction.
+
+
extraDataDecoding(CodeAssembler, LocalVariable, int, int) - Method in class com.amazon.carbonado.raw.CompressedEncodingStrategy
+
 
+
extraDataDecoding(CodeAssembler, LocalVariable, int, int) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Second phase decoding, which does nothing by default.
+
+
extraDataEncoding(CodeAssembler, LocalVariable, int, int) - Method in class com.amazon.carbonado.raw.CompressedEncodingStrategy
+
 
+
extraDataEncoding(CodeAssembler, LocalVariable, int, int) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Second phase encoding, which does nothing by default.
+
+
+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.

+ + diff --git a/apidocs/index-files/index-6.html b/apidocs/index-files/index-6.html new file mode 100644 index 0000000..46aa04c --- /dev/null +++ b/apidocs/index-files/index-6.html @@ -0,0 +1,588 @@ + + + + + + +F-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  + + +

F

+
+
failedDelete(S, Object) - Method in class com.amazon.carbonado.capability.ResyncCapability.Listener
+
+
Called when a delete operation failed because an exception was + thrown.
+
+
failedDelete(S, Object) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
failedDelete(S, Object) - Method in class com.amazon.carbonado.Trigger
+
+
Called when an delete operation failed because the record was missing or + an exception was thrown.
+
+
failedInsert(S, Object) - Method in class com.amazon.carbonado.capability.ResyncCapability.Listener
+
+
Called when an insert operation failed because an exception was + thrown.
+
+
failedInsert(S, Object) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
failedInsert(S, Object) - Method in class com.amazon.carbonado.Trigger
+
+
Called when an insert operation failed due to a unique constraint + violation or an exception was thrown.
+
+
failedUpdate(S, Object) - Method in class com.amazon.carbonado.capability.ResyncCapability.Listener
+
+
Called when an update operation failed because an exception was + thrown.
+
+
failedUpdate(S, Object) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
failedUpdate(S, Object) - Method in class com.amazon.carbonado.Trigger
+
+
Called when an update operation failed because the record was missing or + an exception was thrown.
+
+
fetch(FilterValues<S>) - Method in class com.amazon.carbonado.qe.DelegatedQueryExecutor
+
 
+
fetch(FilterValues<S>, Query.Controller) - Method in class com.amazon.carbonado.qe.DelegatedQueryExecutor
+
 
+
fetch() - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always returns an EmptyCursor.
+
+
fetch(Query.Controller) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always returns an EmptyCursor.
+
+
fetch(FilterValues<S>) - Method in class com.amazon.carbonado.qe.FilteredQueryExecutor
+
 
+
fetch(FilterValues<S>, Query.Controller) - Method in class com.amazon.carbonado.qe.FilteredQueryExecutor
+
 
+
fetch(FilterValues<S>) - Method in class com.amazon.carbonado.qe.FullScanQueryExecutor
+
 
+
fetch(FilterValues<S>, Query.Controller) - Method in class com.amazon.carbonado.qe.FullScanQueryExecutor
+
 
+
fetch(FilterValues<S>) - Method in class com.amazon.carbonado.qe.IndexedQueryExecutor
+
 
+
fetch(FilterValues<S>, Query.Controller) - Method in class com.amazon.carbonado.qe.IndexedQueryExecutor
+
 
+
fetch(FilterValues<S>) - Method in class com.amazon.carbonado.qe.IterableQueryExecutor
+
 
+
fetch(FilterValues<S>, Query.Controller) - Method in class com.amazon.carbonado.qe.IterableQueryExecutor
+
 
+
fetch(FilterValues<T>) - Method in class com.amazon.carbonado.qe.JoinedQueryExecutor
+
 
+
fetch(FilterValues<T>, Query.Controller) - Method in class com.amazon.carbonado.qe.JoinedQueryExecutor
+
 
+
fetch(FilterValues<S>) - Method in class com.amazon.carbonado.qe.KeyQueryExecutor
+
 
+
fetch(FilterValues<S>, Query.Controller) - Method in class com.amazon.carbonado.qe.KeyQueryExecutor
+
 
+
fetch(FilterValues<S>) - Method in interface com.amazon.carbonado.qe.QueryExecutor
+
+
Returns a new cursor using the given filter values.
+
+
fetch(FilterValues<S>, Query.Controller) - Method in interface com.amazon.carbonado.qe.QueryExecutor
+
+
Returns a new cursor using the given filter values.
+
+
fetch(FilterValues<S>) - Method in class com.amazon.carbonado.qe.SortedQueryExecutor
+
 
+
fetch(FilterValues<S>, Query.Controller) - Method in class com.amazon.carbonado.qe.SortedQueryExecutor
+
 
+
fetch() - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
fetch(Query.Controller) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
fetch(FilterValues<S>) - Method in class com.amazon.carbonado.qe.UnionQueryExecutor
+
 
+
fetch(FilterValues<S>, Query.Controller) - Method in class com.amazon.carbonado.qe.UnionQueryExecutor
+
 
+
fetch() - Method in interface com.amazon.carbonado.Query
+
+
Fetches results for this query.
+
+
fetch(Query.Controller) - Method in interface com.amazon.carbonado.Query
+
+
Fetches results for this query.
+
+
FETCH_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Query API method name
+
+
fetchAfter(T) - Method in class com.amazon.carbonado.qe.AbstractQuery
+
 
+
fetchAfter(T, Query.Controller) - Method in class com.amazon.carbonado.qe.AbstractQuery
+
 
+
fetchAfter(T) - Method in interface com.amazon.carbonado.Query
+
+
Fetches results for this query after a given starting point, which is + useful for re-opening a cursor.
+
+
fetchAfter(T, Query.Controller) - Method in interface com.amazon.carbonado.Query
+
+
Fetches results for this query after a given starting point, which is + useful for re-opening a cursor.
+
+
FetchAheadCursor<S> - Class in com.amazon.carbonado.cursor
+
+
Cursor implementation which fetches records in advance, in order to release locks.
+
+
FetchAheadCursor(Cursor<S>, int) - Constructor for class com.amazon.carbonado.cursor.FetchAheadCursor
+
 
+
fetchAll() - Method in interface com.amazon.carbonado.qe.FullScanQueryExecutor.Support
+
+
Perform a full scan of all Storables.
+
+
fetchAll(Query.Controller) - Method in interface com.amazon.carbonado.qe.FullScanQueryExecutor.Support
+
+
Perform a full scan of all Storables.
+
+
FetchDeadlockException - Exception in com.amazon.carbonado
+
+
Thrown if a fetch operation fails because it was selected to resolve a + deadlock.
+
+
FetchDeadlockException() - Constructor for exception com.amazon.carbonado.FetchDeadlockException
+
 
+
FetchDeadlockException(String) - Constructor for exception com.amazon.carbonado.FetchDeadlockException
+
 
+
FetchDeadlockException(String, Throwable) - Constructor for exception com.amazon.carbonado.FetchDeadlockException
+
 
+
FetchDeadlockException(Throwable) - Constructor for exception com.amazon.carbonado.FetchDeadlockException
+
 
+
FetchException - Exception in com.amazon.carbonado
+
+
A FetchException is caused by a failure when selecting records from a Repository.
+
+
FetchException() - Constructor for exception com.amazon.carbonado.FetchException
+
 
+
FetchException(String) - Constructor for exception com.amazon.carbonado.FetchException
+
 
+
FetchException(String, Throwable) - Constructor for exception com.amazon.carbonado.FetchException
+
 
+
FetchException(Throwable) - Constructor for exception com.amazon.carbonado.FetchException
+
 
+
fetchFromIndexEntryQuery(StorableIndex<S>, Query<?>) - Method in interface com.amazon.carbonado.qe.IndexedQueryExecutor.Support
+
+
Fetch Storables referenced by the given index entry query.
+
+
fetchFromIndexEntryQuery(StorableIndex<S>, Query<?>, Query.Controller) - Method in interface com.amazon.carbonado.qe.IndexedQueryExecutor.Support
+
+
Fetch Storables referenced by the given index entry query.
+
+
FetchInterruptedException - Exception in com.amazon.carbonado
+
+
Thrown from a fetch operation that was canceled.
+
+
FetchInterruptedException() - Constructor for exception com.amazon.carbonado.FetchInterruptedException
+
 
+
FetchInterruptedException(String) - Constructor for exception com.amazon.carbonado.FetchInterruptedException
+
 
+
FetchInterruptedException(String, Throwable) - Constructor for exception com.amazon.carbonado.FetchInterruptedException
+
 
+
FetchInterruptedException(Throwable) - Constructor for exception com.amazon.carbonado.FetchInterruptedException
+
 
+
FetchMultipleException - Exception in com.amazon.carbonado
+
+
A FetchMultipleException is thrown when a fetch operation returned more + than one record when at most one was expected.
+
+
FetchMultipleException() - Constructor for exception com.amazon.carbonado.FetchMultipleException
+
 
+
FetchMultipleException(String) - Constructor for exception com.amazon.carbonado.FetchMultipleException
+
 
+
FetchMultipleException(String, Throwable) - Constructor for exception com.amazon.carbonado.FetchMultipleException
+
 
+
FetchMultipleException(Throwable) - Constructor for exception com.amazon.carbonado.FetchMultipleException
+
 
+
FetchNoneException - Exception in com.amazon.carbonado
+
+
A FetchNoneException is thrown when a fetch operation returned no records + when at least one was expected.
+
+
FetchNoneException() - Constructor for exception com.amazon.carbonado.FetchNoneException
+
 
+
FetchNoneException(String) - Constructor for exception com.amazon.carbonado.FetchNoneException
+
 
+
FetchNoneException(String, Throwable) - Constructor for exception com.amazon.carbonado.FetchNoneException
+
 
+
FetchNoneException(Throwable) - Constructor for exception com.amazon.carbonado.FetchNoneException
+
 
+
fetchOne(StorableIndex<S>, Object[]) - Method in interface com.amazon.carbonado.qe.KeyQueryExecutor.Support
+
+
Select at most one Storable referenced by an index.
+
+
fetchOne(StorableIndex<S>, Object[], Query.Controller) - Method in interface com.amazon.carbonado.qe.KeyQueryExecutor.Support
+
+
Select at most one Storable referenced by an index.
+
+
fetchReply() - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Call
+
+
Executes the call and receive a reply.
+
+
fetchSlice(FilterValues<S>, long, Long) - Method in class com.amazon.carbonado.qe.AbstractQueryExecutor
+
+
Produces a slice via skip and limit cursors.
+
+
fetchSlice(FilterValues<S>, long, Long, Query.Controller) - Method in class com.amazon.carbonado.qe.AbstractQueryExecutor
+
+
Produces a slice via skip and limit cursors.
+
+
fetchSlice(FilterValues<S>, long, Long) - Method in class com.amazon.carbonado.qe.DelegatedQueryExecutor
+
 
+
fetchSlice(FilterValues<S>, long, Long, Query.Controller) - Method in class com.amazon.carbonado.qe.DelegatedQueryExecutor
+
 
+
fetchSlice(long, Long) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always returns an EmptyCursor.
+
+
fetchSlice(long, Long, Query.Controller) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always returns an EmptyCursor.
+
+
fetchSlice(FilterValues<S>, long, Long) - Method in interface com.amazon.carbonado.qe.QueryExecutor
+
+
Returns a new cursor using the given filter values and slice.
+
+
fetchSlice(FilterValues<S>, long, Long, Query.Controller) - Method in interface com.amazon.carbonado.qe.QueryExecutor
+
+
Returns a new cursor using the given filter values and slice.
+
+
fetchSlice(long, Long) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
fetchSlice(long, Long, Query.Controller) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
fetchSlice(long, Long) - Method in interface com.amazon.carbonado.Query
+
+
Fetches a slice of results for this query, as defined by a numerical + range.
+
+
fetchSlice(long, Long, Query.Controller) - Method in interface com.amazon.carbonado.Query
+
+
Fetches a slice of results for this query, as defined by a numerical + range.
+
+
fetchSubset(StorableIndex<S>, Object[], BoundaryType, Object, BoundaryType, Object, boolean, boolean) - Method in interface com.amazon.carbonado.qe.IndexedQueryExecutor.Support
+
+
Perform an index scan of a subset of Storables referenced by an + index.
+
+
fetchSubset(StorableIndex<S>, Object[], BoundaryType, Object, BoundaryType, Object, boolean, boolean, Query.Controller) - Method in interface com.amazon.carbonado.qe.IndexedQueryExecutor.Support
+
+
Perform an index scan of a subset of Storables referenced by an + index.
+
+
FetchTimeoutException - Exception in com.amazon.carbonado
+
+
Thrown if a fetch operation fails because lock acquisition timed out.
+
+
FetchTimeoutException() - Constructor for exception com.amazon.carbonado.FetchTimeoutException
+
 
+
FetchTimeoutException(String) - Constructor for exception com.amazon.carbonado.FetchTimeoutException
+
 
+
FetchTimeoutException(String, Throwable) - Constructor for exception com.amazon.carbonado.FetchTimeoutException
+
 
+
FetchTimeoutException(Throwable) - Constructor for exception com.amazon.carbonado.FetchTimeoutException
+
 
+
FileBlob - Class in com.amazon.carbonado.lob
+
+
Implementation of a Blob which is backed by a File.
+
+
FileBlob(File) - Constructor for class com.amazon.carbonado.lob.FileBlob
+
 
+
fillInStackTrace() - Method in exception com.amazon.carbonado.Trigger.Abort
+
+
Override to remove the stack trace.
+
+
Filter<S extends Storable> - Class in com.amazon.carbonado.filter
+
+
An immutable tree structure representing a query result filter.
+
+
Filter.NotJoined - Class in com.amazon.carbonado.filter
+
+
Result from calling Filter.notJoinedFrom(java.lang.String).
+
+
FilteredCursor<S> - Class in com.amazon.carbonado.cursor
+
+
Wraps another cursor and applies custom filtering to reduce the set of + results.
+
+
FilteredCursor(Cursor<S>) - Constructor for class com.amazon.carbonado.cursor.FilteredCursor
+
 
+
FilteredQueryExecutor<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
QueryExecutor which wraps another and filters results.
+
+
FilteredQueryExecutor(QueryExecutor<S>, Filter<S>) - Constructor for class com.amazon.carbonado.qe.FilteredQueryExecutor
+
 
+
filterFor(Class<S>, String) - Static method in class com.amazon.carbonado.filter.Filter
+
+
Returns a cached filter instance that operates on the given type and + filter expression.
+
+
FilteringScore<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
Evaluates an index for how well it matches a query's desired filtering.
+
+
FilterValues<S extends Storable> - Class in com.amazon.carbonado.filter
+
+
Assigns values to Filter placeholders.
+
+
findAdaptMethod(Class, Class) - Method in class com.amazon.carbonado.info.StorablePropertyAdapter
+
+
Returns an adapt method that supports the given conversion, or null if + none.
+
+
findAdaptMethodsFrom(Class) - Method in class com.amazon.carbonado.info.StorablePropertyAdapter
+
+
Returns all the adapt methods that convert from the given type.
+
+
findAdaptMethodsTo(Class) - Method in class com.amazon.carbonado.info.StorablePropertyAdapter
+
+
Returns all the adapt methods that convert to the given type.
+
+
findKeyIndex(StorableKey<S>) - Method in class com.amazon.carbonado.qe.StorableIndexSet
+
+
Finds the best index to represent the given key.
+
+
findPrimaryKeyIndex(StorableInfo<S>) - Method in class com.amazon.carbonado.qe.StorableIndexSet
+
+
Finds the best index to represent the primary key.
+
+
finish() - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Reply
+
+
Finish the reply.
+
+
finish() - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Request
+
+
Reply and immediately finish, without sending any data to caller.
+
+
finishGroup() - Method in class com.amazon.carbonado.cursor.GroupedCursor
+
+
This method is called when a group is finished, and it can return an + aggregate.
+
+
fire(Throwable) - Static method in class com.amazon.carbonado.util.ThrowUnchecked
+
+
Deprecated.
+
Throws the given exception, even though it may be checked.
+
+
fireCause(Throwable) - Static method in class com.amazon.carbonado.util.ThrowUnchecked
+
+
Deprecated.
+
Throws the cause of the given exception, even though it may be + checked.
+
+
fireDeclared(Throwable, Class...) - Static method in class com.amazon.carbonado.util.ThrowUnchecked
+
+
Deprecated.
+
Throws the given exception if it is unchecked or an instance of any of + the given declared types.
+
+
fireDeclaredCause(Throwable, Class...) - Static method in class com.amazon.carbonado.util.ThrowUnchecked
+
+
Deprecated.
+
Throws the cause of the given exception if it is unchecked or an + instance of any of the given declared types.
+
+
fireDeclaredRootCause(Throwable, Class...) - Static method in class com.amazon.carbonado.util.ThrowUnchecked
+
+
Deprecated.
+
Throws the root cause of the given exception if it is unchecked or an + instance of any of the given declared types.
+
+
fireFirstDeclared(Throwable, Class...) - Static method in class com.amazon.carbonado.util.ThrowUnchecked
+
+
Deprecated.
+
Throws the either the original exception or the first found cause if it + matches one of the given declared types or is unchecked.
+
+
fireFirstDeclaredCause(Throwable, Class...) - Static method in class com.amazon.carbonado.util.ThrowUnchecked
+
+
Deprecated.
+
Throws the first found cause that matches one of the given declared + types or is unchecked.
+
+
fireRootCause(Throwable) - Static method in class com.amazon.carbonado.util.ThrowUnchecked
+
+
Deprecated.
+
Throws the root cause of the given exception, even though it may be + checked.
+
+
FloatConstraint - Annotation Type in com.amazon.carbonado.constraint
+
+
Limits the value of a property to be a member of a specific set.
+
+
FloatConstraint.Constraint - Class in com.amazon.carbonado.constraint
+
+
Constraint implementation for FloatConstraint.
+
+
FloatConstraint.Constraint(Class<?>, String, FloatConstraint) - Constructor for class com.amazon.carbonado.constraint.FloatConstraint.Constraint
+
 
+
FloatConstraint.Constraint(Class<?>, String, double, double, double[], double[]) - Constructor for class com.amazon.carbonado.constraint.FloatConstraint.Constraint
+
 
+
flush() - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Call
+
+
Flushes all the data sent so far.
+
+
flush() - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Reply
+
+
Flushes all the data sent so far.
+
+
forceCheckpoint() - Method in interface com.amazon.carbonado.repo.sleepycat.CheckpointCapability
+
+
Forces a checkpoint to run now, even if checkpointer is suspended or + disabled.
+
+
forString(String) - Static method in enum com.amazon.carbonado.repo.sleepycat.BDBProduct
+
 
+
from(Class<S>) - Static method in class com.amazon.carbonado.gen.StorableCopier
+
 
+
fromCharacter(char) - Static method in enum com.amazon.carbonado.info.Direction
+
+
Returns ASCENDING for '+', DESCENDING for '-', UNSPECIFIED for anything + else.
+
+
fullComparator() - Static method in class com.amazon.carbonado.qe.CompositeScore
+
+
Returns a comparator which determines which CompositeScores are + better.
+
+
fullComparator(QueryHints) - Static method in class com.amazon.carbonado.qe.CompositeScore
+
+
Returns a comparator which determines which CompositeScores are + better.
+
+
fullComparator() - Static method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns a comparator which determines which FilteringScores are + better.
+
+
fullComparator() - Static method in class com.amazon.carbonado.qe.OrderingScore
+
+
Returns a comparator which determines which OrderingScores are + better.
+
+
FullScanQueryExecutor<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
QueryExecutor which fully scans all Storables of a given type.
+
+
FullScanQueryExecutor(FullScanQueryExecutor.Support<S>) - Constructor for class com.amazon.carbonado.qe.FullScanQueryExecutor
+
 
+
FullScanQueryExecutor.Support<S extends Storable> - Interface in com.amazon.carbonado.qe
+
+
Provides support for FullScanQueryExecutor.
+
+
+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.

+ + diff --git a/apidocs/index-files/index-7.html b/apidocs/index-files/index-7.html new file mode 100644 index 0000000..d2b4ac9 --- /dev/null +++ b/apidocs/index-files/index-7.html @@ -0,0 +1,2226 @@ + + + + + + +G-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  + + +

G

+
+
gatherAllBridgeTypes(Set<Class>, Class) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Collect a set of all the interfaces and recursively all superclasses for the leaf + (genericised class) and root (genericised base class).
+
+
gatherAllDataProperties() - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Returns all non-derived data properties for storable.
+
+
gatherAllKeyProperties() - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Returns all key properties as ordered properties, possibly with + unspecified directions.
+
+
gatherAllProperties() - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Returns all non-join, non-derived properties for storable.
+
+
GenericEncodingStrategy<S extends Storable> - Class in com.amazon.carbonado.raw
+
+
Generates bytecode instructions for encoding/decoding Storable properties + to/from raw bytes.
+
+
GenericEncodingStrategy(Class<S>, StorableIndex<S>) - Constructor for class com.amazon.carbonado.raw.GenericEncodingStrategy
+
 
+
GenericEncodingStrategy(Class<S>, StorableIndex<S>, int, int, int, int) - Constructor for class com.amazon.carbonado.raw.GenericEncodingStrategy
+
 
+
GenericInstanceFactory - Interface in com.amazon.carbonado.raw
+
+
Can be used with QuickConstructorGenerator + for instantiating generic storable instances.
+
+
GenericPropertyInfo - Interface in com.amazon.carbonado.raw
+
+
Minimal information required by GenericEncodingStrategy to encode + and decode a storable property.
+
+
GenericStorableCodec<S extends Storable> - Class in com.amazon.carbonado.raw
+
+
Generic codec that supports any kind of storable by auto-generating and + caching storable implementations.
+
+
GenericStorableCodec.Decoder<S extends Storable> - Interface in com.amazon.carbonado.raw
+
+
Used for decoding different generations of Storable.
+
+
GenericStorableCodec.SearchKeyFactory<S extends Storable> - Interface in com.amazon.carbonado.raw
+
+
Creates custom raw search keys for Storable types.
+
+
GenericStorableCodecFactory - Class in com.amazon.carbonado.raw
+
+
Factory for generic codec that supports any kind of storable by + auto-generating and caching storable implementations.
+
+
GenericStorableCodecFactory() - Constructor for class com.amazon.carbonado.raw.GenericStorableCodecFactory
+
 
+
get(Object) - Method in class com.amazon.carbonado.gen.StorablePropertyMap
+
 
+
get(StorableProperty<S>) - Static method in class com.amazon.carbonado.info.ChainedProperty
+
+
Returns a canonical instance which has no chain.
+
+
get(StorableProperty<S>, StorableProperty<?>...) - Static method in class com.amazon.carbonado.info.ChainedProperty
+
+
Returns a canonical instance.
+
+
get(StorableProperty<S>, StorableProperty<?>[], boolean[]) - Static method in class com.amazon.carbonado.info.ChainedProperty
+
+
Returns a canonical instance.
+
+
get(StorableProperty<S>, Direction) - Static method in class com.amazon.carbonado.info.OrderedProperty
+
+
Returns a canonical instance.
+
+
get(ChainedProperty<S>, Direction) - Static method in class com.amazon.carbonado.info.OrderedProperty
+
+
Returns a canonical instance.
+
+
get(Class<S>, String) - Static method in class com.amazon.carbonado.qe.OrderingList
+
+
Returns a canonical instance composed of the given ordering.
+
+
get(Class<S>, String...) - Static method in class com.amazon.carbonado.qe.OrderingList
+
+
Returns a canonical instance composed of the given orderings.
+
+
get(OrderedProperty<S>...) - Static method in class com.amazon.carbonado.qe.OrderingList
+
+
Returns a canonical instance composed of the given orderings.
+
+
get(List<OrderedProperty<S>>) - Static method in class com.amazon.carbonado.qe.OrderingList
+
+
Returns a canonical instance composed of the given orderings.
+
+
get(int) - Method in class com.amazon.carbonado.qe.OrderingList
+
 
+
get(QueryHint) - Method in class com.amazon.carbonado.qe.QueryHints
+
+
Returns null if hint is not provided.
+
+
get(String) - Method in class com.amazon.carbonado.sequence.SequenceValueProducerPool
+
+
Returns a SequenceValueProducer instance for the given name, which is + lazily created and pooled.
+
+
get(K) - Method in class com.amazon.carbonado.util.AbstractPool
+
+
Returns a value for the given key, which is lazily created and + pooled.
+
+
get(int) - Method in class com.amazon.carbonado.util.BelatedCreator
+
+
Returns real or bogus object.
+
+
get(K) - Method in class com.amazon.carbonado.util.SoftValuedCache
+
+
Deprecated.
+ 
+
GET_PROPERTY_VALUE - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
GET_TRANSACTION_ISOLATION_LEVEL_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Repository API method name
+
+
getAbstractClass(Class<S>, EnumSet<MasterFeature>) - Static method in class com.amazon.carbonado.gen.MasterStorableGenerator
+
+
Returns an abstract implementation of the given Storable type, which + is fully thread-safe.
+
+
getAbstractClass(Class<S>) - Static method in class com.amazon.carbonado.gen.StorableGenerator
+
+
Returns an abstract implementation of the given Storable type, which is + fully thread-safe.
+
+
getAbstractClass(Class<S>, boolean) - Static method in class com.amazon.carbonado.raw.RawStorableGenerator
+
+
Returns an abstract implementation of the given Storable type, which is + fully thread-safe.
+
+
getAccessorAnnotationDescriptors() - Method in class com.amazon.carbonado.synthetic.SyntheticProperty
+
+
Returns all the added accessor annotation descriptors in an unmodifiable list.
+
+
getActualRepositoryBuilder() - Method in class com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder
+
+
Returns the Repository that all calls are wrapped to.
+
+
getAdapter() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns this property's adapter, or null if none.
+
+
getAdapter() - Method in class com.amazon.carbonado.synthetic.SyntheticProperty
+
 
+
getAdapterConstructor() - Method in class com.amazon.carbonado.info.StorablePropertyAdapter
+
+
Returns the constructor for the adapter class.
+
+
getAdapterInstance() - Method in class com.amazon.carbonado.info.StorablePropertyAdapter
+
+
Returns an instance of the adapter, for which an adapt method is applied to.
+
+
getAdapterParams() - Method in class com.amazon.carbonado.layout.LayoutProperty
+
+
Parameters for adapter, or null if property has no explicit adapter.
+
+
getAdapterParams() - Method in interface com.amazon.carbonado.layout.StoredLayoutProperty
+
+
Parameters for adapter, or null if property has no explicit adapter.
+
+
getAdapterTypeName() - Method in class com.amazon.carbonado.layout.LayoutProperty
+
+
Adapter type name is a fully qualified Java class name.
+
+
getAdapterTypeName() - Method in interface com.amazon.carbonado.layout.StoredLayoutProperty
+
+
Adapter type name is a fully qualified Java class name.
+
+
getAdaptMethod(int) - Method in class com.amazon.carbonado.info.StorablePropertyAdapter
+
+
Returns a specific adapt method.
+
+
getAdaptMethodCount() - Method in class com.amazon.carbonado.info.StorablePropertyAdapter
+
+
Returns the count of all defined adapt methods.
+
+
getAdaptMethods() - Method in class com.amazon.carbonado.info.StorablePropertyAdapter
+
+
Returns a new array with all the adapt methods in it.
+
+
getAlias(int) - Method in interface com.amazon.carbonado.info.StorableInfo
+
+
Returns a specific alias for the Storable.
+
+
getAlias(int) - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns a specific alias for this property.
+
+
getAliasCount() - Method in interface com.amazon.carbonado.info.StorableInfo
+
+
Returns the count of aliases for the Storable.
+
+
getAliasCount() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns the count of aliases for this property.
+
+
getAliases() - Method in interface com.amazon.carbonado.info.StorableInfo
+
+
Returns a new array with all the alias names in it.
+
+
getAliases() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns a new array with all the alias names in it.
+
+
getAllIndexes() - Method in interface com.amazon.carbonado.qe.StorageAccess
+
+
Returns all the available indexes.
+
+
getAllProperties() - Method in interface com.amazon.carbonado.info.StorableInfo
+
+
Returns all the storable properties in an unmodifiable map.
+
+
getAllProperties() - Method in class com.amazon.carbonado.layout.Layout
+
+
Returns all the properties of this layout, in their proper order.
+
+
getAllProperties() - Method in class com.amazon.carbonado.raw.CustomStorableCodec
+
+
Convenient access to all the storable properties.
+
+
getAllProperties() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableInfo
+
 
+
getAlternateKey(int) - Method in interface com.amazon.carbonado.info.StorableInfo
+
+
Returns a specific alternate key for the Storable.
+
+
getAlternateKeyCount() - Method in interface com.amazon.carbonado.info.StorableInfo
+
+
Returns the count of alternate keys for the Storable.
+
+
getAlternateKeys() - Method in interface com.amazon.carbonado.info.StorableInfo
+
+
Returns a new array with all the alternate keys in it.
+
+
getAnnotatedMethod() - Method in class com.amazon.carbonado.info.StorablePropertyAnnotation
+
+
Returns the method that has the annotation.
+
+
getAnnotation() - Method in class com.amazon.carbonado.info.StorablePropertyAdapter
+
+
Returns the annotation that applied this adapter, or null if none.
+
+
getAnnotation() - Method in class com.amazon.carbonado.info.StorablePropertyAnnotation
+
+
Returns the actual annotation instance, which may be null if annotation + was automatically applied.
+
+
getAnnotation() - Method in class com.amazon.carbonado.info.StorablePropertyConstraint
+
+
Returns the annotation that applied this constraint.
+
+
getAnnotationType() - Method in class com.amazon.carbonado.info.StorablePropertyAnnotation
+
+
Returns the type of annotation that was applied to the property method.
+
+
getAppliedAdapter() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableProperty
+
+
Returns the adapter that needs to be applied to properties returned from + ResultSets and set into PreparedStatements.
+
+
getArrangementScore() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns a value which indicates how well the index property order + matches the property filter specification order.
+
+
getAssignedValue(PropertyFilter<S>) - Method in class com.amazon.carbonado.filter.FilterValues
+
+
Returns the value assigned to the given PropertyFilter, throwing an + exception if not assigned.
+
+
getBDBProduct() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns the BDB product to use, which is JE by default.
+
+
getBDBProduct() - Method in interface com.amazon.carbonado.repo.sleepycat.EnvironmentCapability
+
 
+
getBeanName() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns the bean name of this property, which is derived from the read + and write method names.
+
+
getBindID() - Method in class com.amazon.carbonado.filter.PropertyFilter
+
+
Bind ID is used to distinguish this PropertyFilter instance from another + against the same property.
+
+
getBlankParameterCount() - Method in class com.amazon.carbonado.filter.FilterValues
+
+
Returns the amount of values yet to be assigned.
+
+
getBlankParameterCount() - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always returns zero.
+
+
getBlankParameterCount() - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
getBlankParameterCount() - Method in interface com.amazon.carbonado.Query
+
+
Returns the amount of blank parameters that need to be filled in.
+
+
getBlob(S, String, long) - Method in interface com.amazon.carbonado.raw.RawSupport
+
+
Returns the Blob for the given locator, returning null if not found.
+
+
getBlobValue(long) - Method in class com.amazon.carbonado.spi.LobEngine
+
+
Loads a Blob value, without checking if it exists or not.
+
+
getBlockCount() - Method in class com.amazon.carbonado.spi.StoredLob
+
+
Returns number of blocks required to store Lob.
+
+
getBlockNumber() - Method in class com.amazon.carbonado.spi.StoredLob.Block
+
+
First block number is logically zero, but subtract 0x80000000 to get + actual number.
+
+
getBlockSize() - Method in class com.amazon.carbonado.spi.StoredLob
+
 
+
getBoxedType() - Method in class com.amazon.carbonado.filter.PropertyFilter
+
+
Returns the type of the ChainedProperty property, boxed into an object + if primitive.
+
+
getCachePercent() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns the percent of JVM heap used by the repository cache, or + null if default should be selected.
+
+
getCacheSize() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns the repository cache size, or null if default should be + selected.
+
+
getCapability(Class<C>) - Method in interface com.amazon.carbonado.Repository
+
+
Requests a specific capability of this Repository.
+
+
getCapability(Class<C>) - Method in class com.amazon.carbonado.spi.AbstractRepository
+
+
Default implementation checks if Repository implements Capability + interface, and if so, returns the Repository.
+
+
getCatalog() - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
Returns the optional catalog to search for metadata.
+
+
getCatalogName() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableInfo
+
+
Returns the optional catalog name for the Storable.
+
+
getChainCount() - Method in class com.amazon.carbonado.info.ChainedProperty
+
+
Returns amount of properties chained from prime property, which may be + zero.
+
+
getChainedProperty() - Method in class com.amazon.carbonado.filter.ExistsFilter
+
+
Returns the join property that is being checked for existence or + non-existence.
+
+
getChainedProperty() - Method in class com.amazon.carbonado.filter.PropertyFilter
+
 
+
getChainedProperty(int) - Method in class com.amazon.carbonado.info.ChainedProperty
+
 
+
getChainedProperty() - Method in class com.amazon.carbonado.info.OrderedProperty
+
 
+
getCharOctetLength() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableProperty
+
+
Returns the maximum amount of bytes for property value.
+
+
getCheckpointInterval() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
 
+
getCheckpointThresholdKB() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
 
+
getCheckpointThresholdMinutes() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
 
+
getChecksumEnabled() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns true if checksum verification is enabled.
+
+
getClassFile() - Method in class com.amazon.carbonado.synthetic.ClassFileBuilder
+
 
+
getClassNameProvider() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableBuilder
+
 
+
getClob(S, String, long) - Method in interface com.amazon.carbonado.raw.RawSupport
+
+
Returns the Clob for the given locator, returning null if not found.
+
+
getClobValue(long) - Method in class com.amazon.carbonado.spi.LobEngine
+
+
Loads a Clob value, without checking if it exists or not.
+
+
getClosedFilter(Class<S>) - Static method in class com.amazon.carbonado.filter.Filter
+
+
Returns a cached filter instance that operates on the given type, which + prevents any results from passing through.
+
+
getColumnName() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableProperty
+
+
Returns the table column for this property.
+
+
getColumnSize() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableProperty
+
+
The column size is either the maximum number of characters or the + numeric precision.
+
+
getComparator() - Method in interface com.amazon.carbonado.repo.indexed.IndexEntryAccessor
+
+
Returns a comparator for ordering index entries.
+
+
getComparator() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceAccess
+
+
Returns a comparator for ordering storable reference instances.
+
+
getComparator() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder
+
+
Deprecated. +
call getReferenceAccess
+
+
+
getCompositeScore() - Method in class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result
+
+
Returns the score on how well the selected index performs the + desired filtering and ordering.
+
+
getCompressionType() - Method in class com.amazon.carbonado.layout.LayoutOptions
+
 
+
getCompressionType(Class<? extends Storable>) - Method in class com.amazon.carbonado.raw.CompressedStorableCodecFactory
+
 
+
getCompressor(String) - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Return the compressor used for the given storable.
+
+
getConnection() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability
+
+
Any connection returned by this method must be closed by calling + yieldConnection.
+
+
getConnection() - Method in class com.amazon.carbonado.repo.jdbc.LoggingDataSource
+
 
+
getConnection(String, String) - Method in class com.amazon.carbonado.repo.jdbc.LoggingDataSource
+
 
+
getConnection() - Method in class com.amazon.carbonado.repo.jdbc.SimpleDataSource
+
 
+
getConnection(String, String) - Method in class com.amazon.carbonado.repo.jdbc.SimpleDataSource
+
 
+
getConstantKeyPrefixLength() - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Returns amount of prefix key bytes that encoding strategy instance + produces which are always the same.
+
+
getConstrainMethod() - Method in class com.amazon.carbonado.info.StorablePropertyConstraint
+
+
Returns the best matching property checking method in the validator.
+
+
getConstraint(int) - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns a specific constraint for this property.
+
+
getConstraintConstructor() - Method in class com.amazon.carbonado.info.StorablePropertyConstraint
+
+
Returns the constructor for the constraint class.
+
+
getConstraintCount() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns the count of constraints for this property.
+
+
getConstraints() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns a new array with all the constraints in it.
+
+
getCovariantTypes() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns additional types of this property, all of which are assignable + by the primary type.
+
+
getCoveringCount() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns number of covering property filters which are supported by the + evaluated index.
+
+
getCoveringFilter() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns the composite covering filter supported by the evaluated index, + or null if the covering count is zero.
+
+
getCoveringFilter() - Method in class com.amazon.carbonado.qe.IndexedQueryExecutor
+
 
+
getCoveringFilters() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns the covering filters which are supported by the evaluated index, + which is a subset of the remainder filters.
+
+
getCoveringRemainderFilter() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns the composite remainder filter without including the covering + filter.
+
+
getCreationDateTime() - Method in class com.amazon.carbonado.layout.Layout
+
+
Returns the date and time for when this layout generation was created.
+
+
getCreationHost() - Method in class com.amazon.carbonado.layout.Layout
+
+
Returns the host machine that created this generation.
+
+
getCreationHost() - Method in interface com.amazon.carbonado.layout.StoredLayout
+
+
Returns the host machine that created this generation.
+
+
getCreationTimestamp() - Method in interface com.amazon.carbonado.layout.StoredLayout
+
+
Returns the milliseconds from 1970-01-01T00:00:00Z when this record was + created.
+
+
getCreationTimestamp() - Method in interface com.amazon.carbonado.repo.indexed.StoredIndexInfo
+
+
Returns the milliseconds from 1970-01-01T00:00:00Z when this record was + created.
+
+
getCreationTimestamp() - Method in class com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo
+
+
Returns the milliseconds from 1970-01-01T00:00:00Z when this record was + created.
+
+
getCreationUser() - Method in class com.amazon.carbonado.layout.Layout
+
+
Returns the user that created this layout generation.
+
+
getCreationUser() - Method in interface com.amazon.carbonado.layout.StoredLayout
+
+
Returns the user that created this generation.
+
+
getCulpritIndex() - Method in exception com.amazon.carbonado.MalformedFilterException
+
+
Returns the index into the query filter string that is malformed, or a + negative value if not known.
+
+
getCurrentKey() - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Returns the contents of the current key being referenced, or null + otherwise.
+
+
getCurrentValue() - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Returns the contents of the current value being referenced, or null + otherwise.
+
+
getData() - Method in class com.amazon.carbonado.spi.StoredLob.Block
+
 
+
getDatabaseHook() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns the custom open database hook, or null if none.
+
+
getDatabaseName() - Method in class com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo
+
 
+
getDatabaseProductName() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability
+
+
Returns the name of the database product connected to.
+
+
getDatabasesTransactional() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns true if the databases are configured to be transactional, + false if configured to not be transactional, null if this override was never set
+
+
getDataFiles() - Method in interface com.amazon.carbonado.repo.sleepycat.HotBackupCapability.Backup
+
+
Returns all the data files to be copied.
+
+
getDataHome() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns the directory to store data files.
+
+
getDataHome() - Method in interface com.amazon.carbonado.repo.sleepycat.EnvironmentCapability
+
+
Returns the directory where data files are stored, which is the same as + the home directory by default.
+
+
getDataHomeFile() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns the optional directory to store data files.
+
+
getDataPrefixPadding() - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
 
+
getDataProperties() - Method in interface com.amazon.carbonado.info.StorableInfo
+
+
Returns a subset of the storable properties in an unmodifiable map + that define the basic data properties.
+
+
getDataProperties() - Method in class com.amazon.carbonado.layout.Layout
+
+
Returns all the non-primary key properties of this layout, in their + proper order.
+
+
getDataProperties() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableInfo
+
 
+
getDataSource() - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
Returns the source of JDBC connections, which defaults to a non-pooling + source if driver class, driver URL, username, and password are all + supplied.
+
+
getDataSourceCloseOnShutdown() - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
Returns true if DataSource is closed when the repository is closed or + shutdown.
+
+
getDataSourceLogging() - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
Returns true if debug logging is enabled.
+
+
getDataSuffixPadding() - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
 
+
getDataType() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableProperty
+
+
Returns the data type as defined by Types.
+
+
getDataTypeName() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableProperty
+
+
Returns the data type name.
+
+
getDeadlockCount() - Method in interface com.amazon.carbonado.repo.sleepycat.CompactionCapability.Result
+
 
+
getDecimalDigits() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableProperty
+
+
Returns the amount of fractional decimal digits.
+
+
getDecoder(int) - Method in class com.amazon.carbonado.raw.GenericStorableCodec
+
+
Deprecated. +
use direct decode method
+
+
+
getDefaultFetchSize() - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
Returns the default fetch size when running queries, or null if driver + default is used instead.
+
+
getDelegateClass(Class<S>, EnumSet<MasterFeature>) - Static method in class com.amazon.carbonado.gen.DelegateStorableGenerator
+
+
Delegate class has a constructor that accepts a DelegateSupport + instance.
+
+
getDeleteTrigger() - Method in interface com.amazon.carbonado.gen.TriggerSupport
+
+
Returns a trigger which must be run for all delete operations.
+
+
getDeleteTrigger() - Method in class com.amazon.carbonado.spi.TriggerManager
+
+
Returns a consolidated trigger to call for delete operations, or null if + none.
+
+
getDerivedFromProperties() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns a new array with all the derived-from properties, which is empty + if this is not a derived property.
+
+
getDerivedToProperties() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns a new array with all the properties which are derived from this + one.
+
+
getDirection() - Method in class com.amazon.carbonado.info.OrderedProperty
+
 
+
getDriverClassName() - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
Returns the driver class name, which may be null if a DataSource was provided.
+
+
getDriverURL() - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
Returns the connection URL, which may be null if a DataSource was + provided.
+
+
getEnclosingType() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns the enclosing type of this property.
+
+
getEnvironment() - Method in interface com.amazon.carbonado.repo.sleepycat.EnvironmentCapability
+
+
Returns the BDB environment object, which must be cast to the expected + type, depending on the BDB product and version being used.
+
+
getEnvironmentHome() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns the repository environment home directory.
+
+
getEnvironmentHomeFile() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns the repository environment home directory.
+
+
getEvolutionStrategy() - Method in class com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo
+
+
Returns EVOLUTION_NONE if evolution of records is not supported.
+
+
getExclusiveRangeEndFilters() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns the range end property filters supported by the evaluated + index whose operator is only RelOp.LT.
+
+
getExclusiveRangeStartFilters() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns the range start property filters supported by the evaluated + index whose operator is only RelOp.GT.
+
+
getExternalJoinElement(int) - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns a specific property in the joined class that participates in the + join.
+
+
getExternalJoinElement(int) - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableProperty
+
 
+
getExternalJoinElements() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns a new array with all the external join elements in it.
+
+
getExternalJoinElements() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableProperty
+
 
+
getExtraData() - Method in interface com.amazon.carbonado.layout.StoredLayout
+
+
Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records.
+
+
getExtraData() - Method in interface com.amazon.carbonado.layout.StoredLayoutEquivalence
+
 
+
getExtraData() - Method in interface com.amazon.carbonado.layout.StoredLayoutProperty
+
+
Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records.
+
+
getExtraData() - Method in interface com.amazon.carbonado.repo.indexed.StoredIndexInfo
+
+
Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records.
+
+
getExtraData() - Method in class com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo
+
+
Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records.
+
+
getFiles() - Method in interface com.amazon.carbonado.repo.sleepycat.HotBackupCapability.Backup
+
+
Deprecated. +
use getDataFiles and getLogFiles
+
+
+
getFilter() - Method in class com.amazon.carbonado.filter.FilterValues
+
+
Returns the Filter that this FilterValues instance applies to.
+
+
getFilter() - Method in exception com.amazon.carbonado.MalformedFilterException
+
+
Returns the malformed query filter.
+
+
getFilter() - Method in class com.amazon.carbonado.qe.DelegatedQueryExecutor
+
 
+
getFilter() - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always returns a ClosedFilter.
+
+
getFilter() - Method in class com.amazon.carbonado.qe.FilteredQueryExecutor
+
+
Returns the combined filter of the wrapped executor and the extra filter.
+
+
getFilter() - Method in class com.amazon.carbonado.qe.FullScanQueryExecutor
+
+
Returns an open filter.
+
+
getFilter() - Method in class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result
+
+
Returns combined handled and remainder filter for this result.
+
+
getFilter() - Method in class com.amazon.carbonado.qe.IndexedQueryExecutor
+
 
+
getFilter() - Method in class com.amazon.carbonado.qe.IterableQueryExecutor
+
+
Returns an open filter.
+
+
getFilter() - Method in class com.amazon.carbonado.qe.JoinedQueryExecutor
+
 
+
getFilter() - Method in class com.amazon.carbonado.qe.KeyQueryExecutor
+
 
+
getFilter() - Method in interface com.amazon.carbonado.qe.QueryExecutor
+
+
Returns the filter used by this QueryExecutor.
+
+
getFilter() - Method in class com.amazon.carbonado.qe.SortedQueryExecutor
+
 
+
getFilter() - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
getFilter() - Method in class com.amazon.carbonado.qe.UnionQueryExecutor
+
+
Returns the combined filter of the wrapped executors.
+
+
getFilter() - Method in interface com.amazon.carbonado.Query
+
+
Returns the query's filter.
+
+
getFilteringScore() - Method in class com.amazon.carbonado.qe.CompositeScore
+
+
Returns the score on how well the evaluated index performs the desired + filtering.
+
+
getFilterValues() - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always returns null.
+
+
getFilterValues() - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
getFilterValues() - Method in interface com.amazon.carbonado.Query
+
+
Returns the query's filter values, which is null if filter has no + parameters.
+
+
getForeignIndex() - Method in class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result
+
+
Returns the foreign index that was selected, or null if a local + index was selected.
+
+
getForeignProperty() - Method in class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result
+
+
Returns the simple or chained property that maps to the selected + foreign index.
+
+
getFreeOrdering() - Method in class com.amazon.carbonado.qe.OrderingScore
+
+
Returns potential ordering properties that the evaluated index can + handle, if arranged to immediately follow the handled orderings.
+
+
getFromStorageAdapter() - Method in interface com.amazon.carbonado.raw.GenericPropertyInfo
+
+
Returns the optional method used to adapt the property from the + storage supported type to the user visible type.
+
+
getFromStorageAdapter() - Method in class com.amazon.carbonado.raw.StorablePropertyInfo
+
 
+
getGeneration() - Method in class com.amazon.carbonado.layout.Layout
+
+
Returns the generation of this layout, where zero represents the first + generation.
+
+
getGeneration(int) - Method in class com.amazon.carbonado.layout.Layout
+
+
Returns the layout for a particular generation of this layout's type.
+
+
getGeneration() - Method in interface com.amazon.carbonado.layout.StoredLayout
+
+
Generation of storable, where 0 represents the first generation.
+
+
getGeneration() - Method in interface com.amazon.carbonado.layout.StoredLayoutEquivalence
+
+
Generation of storable, where 0 represents the first generation.
+
+
getGroupMembers() - Method in interface com.amazon.carbonado.capability.GroupAccessCapability
+
+
Return all replication group members, including this repository.
+
+
getHandledCount() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns the count of all handled property filters.
+
+
getHandledCount() - Method in class com.amazon.carbonado.qe.OrderingScore
+
+
Returns the number of desired orderings the evaluated index + supports.
+
+
getHandledFilter() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns the composite handled filter, or null if no matches at all.
+
+
getHandledOrdering() - Method in class com.amazon.carbonado.qe.OrderingScore
+
+
Returns the ordering properties that the evaluated index supports.
+
+
getHome() - Method in interface com.amazon.carbonado.repo.sleepycat.EnvironmentCapability
+
+
Returns the home directory for the BDB environment.
+
+
getIdentityCount() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns number of consecutive left-aligned index properties which match + property filters with an operator of RelOp.EQ.
+
+
getIdentityFilter() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns the composite identity filter, or null if no identity property + filters.
+
+
getIdentityFilters() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns the identity property filters supported by the evaluated + index.
+
+
getIdentityProperties() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableInfo
+
+
Returns auto-increment properties which are primary key members.
+
+
getInclusiveRangeEndFilters() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns the range end property filters supported by the evaluated + index whose operator is only RelOp.LE.
+
+
getInclusiveRangeStartFilters() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns the range start property filters supported by the evaluated + index whose operator is only RelOp.GE.
+
+
getIndex(int) - Method in interface com.amazon.carbonado.info.StorableInfo
+
+
Returns a specific index for the Storable.
+
+
getIndexCount() - Method in interface com.amazon.carbonado.info.StorableInfo
+
+
Returns the count of indexes defined for the Storable.
+
+
getIndexEntryAccessors(Class<S>) - Method in interface com.amazon.carbonado.repo.indexed.IndexEntryAccessCapability
+
+
Returns index entry accessors for the known indexes of the given + storable type.
+
+
getIndexEntryStorage() - Method in interface com.amazon.carbonado.repo.indexed.IndexEntryAccessor
+
+
Returns the index entry storage.
+
+
getIndexes() - Method in interface com.amazon.carbonado.info.StorableInfo
+
+
Returns a new array with all the indexes in it.
+
+
getIndexInfo(Class<S>) - Method in interface com.amazon.carbonado.capability.IndexInfoCapability
+
+
Returns information about the known indexes for the given storable + type.
+
+
getIndexInfo() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableInfo
+
 
+
getIndexName() - Method in interface com.amazon.carbonado.repo.indexed.StoredIndexInfo
+
+
Returns the index name, which is also a valid index name + descriptor.
+
+
getIndexNameDescriptor() - Method in class com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo
+
+
Returns the index name descriptor for the keys of this database.
+
+
getIndexPropertyCount() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns the amount of properties in the evaluated index.
+
+
getIndexPropertyCount() - Method in class com.amazon.carbonado.qe.OrderingScore
+
+
Returns the amount of properties in the evaluated index.
+
+
getIndexRepairThrottle() - Method in class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder
+
+
Returns the throttle parameter used when indexes are added, dropped or + bulk repaired.
+
+
getIndexRepairThrottle() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns the throttle parameter used when indexes are added, dropped or + bulk repaired.
+
+
getIndexSupport() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns true if indexes are supported, which is true by default.
+
+
getIndexTypeDescriptor() - Method in interface com.amazon.carbonado.repo.indexed.StoredIndexInfo
+
+
Returns the types of the index properties.
+
+
getIndexTypeDescriptor() - Method in class com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo
+
+
Returns the types of the index properties.
+
+
getInitialDatabaseConfig() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns the optional BDB specific database configuration to use + for all databases created.
+
+
getInitialEnvironmentConfig() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns the optional BDB specific environment configuration to use.
+
+
getInitializeLogging() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
 
+
getInitialValue() - Method in interface com.amazon.carbonado.sequence.StoredSequence
+
+
Returns the initial value for the sequence.
+
+
getInitialValue() - Method in interface com.amazon.carbonado.spi.StoredSequence
+
+
Deprecated.
+
Returns the initial value for the sequence.
+
+
getInjector() - Method in class com.amazon.carbonado.synthetic.ClassFileBuilder
+
 
+
getInsertTrigger() - Method in interface com.amazon.carbonado.gen.TriggerSupport
+
+
Returns a trigger which must be run for all insert operations.
+
+
getInsertTrigger() - Method in class com.amazon.carbonado.spi.TriggerManager
+
+
Returns a consolidated trigger to call for insert operations, or null if + none.
+
+
getInstance() - Static method in class com.amazon.carbonado.spi.ExceptionTransformer
+
+
Returns a generic instance.
+
+
getInstance(Class<?>, Class<F>) - Static method in class com.amazon.carbonado.util.QuickConstructorGenerator
+
+
Deprecated.
+
Returns a factory instance for one type of object.
+
+
getInternalJoinElement(int) - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns a specific property in this property's class that participates + in the join.
+
+
getInternalJoinElement(int) - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableProperty
+
 
+
getInternalJoinElements() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns a new array with all the internal join elements in it.
+
+
getInternalJoinElements() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableProperty
+
 
+
getIsolationLevel() - Method in interface com.amazon.carbonado.Transaction
+
+
Returns the isolation level of this transaction.
+
+
getIsolationLevel() - Method in class com.amazon.carbonado.txn.TransactionPair
+
 
+
getIsolationLevel() - Method in class com.amazon.carbonado.txn.TransactionScope
+
+
Returns the isolation level of the active transaction, or null if there + is no active transaction.
+
+
getJoinedType() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns the type of property this is joined to, or null if not joined.
+
+
getJoinElementCount() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns the count of properties that participate in this property's + join.
+
+
getKeepOldLogFiles() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns false by default.
+
+
getKeyPrefixPadding() - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
 
+
getKeySuffixPadding() - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
 
+
getLastBlockLength() - Method in class com.amazon.carbonado.spi.StoredLob
+
+
Returns expected length of last block.
+
+
getLastLogNumber() - Method in interface com.amazon.carbonado.repo.sleepycat.HotBackupCapability.Backup
+
+
Can be called after a backup has been performed to find the last log file + that has been backed up.
+
+
getLastProperty() - Method in class com.amazon.carbonado.info.ChainedProperty
+
+
Returns the last property in the chain, or the prime property if chain + is empty.
+
+
getLayoutID() - Method in class com.amazon.carbonado.layout.Layout
+
+
Returns a unique identifier for this layout.
+
+
getLayoutID() - Method in interface com.amazon.carbonado.layout.StoredLayout
+
 
+
getLayoutID() - Method in interface com.amazon.carbonado.layout.StoredLayoutProperty
+
 
+
getLayoutOptions(Class<? extends Storable>) - Method in class com.amazon.carbonado.raw.CompressedStorableCodecFactory
+
 
+
getLayoutOptions(Class<? extends Storable>) - Method in class com.amazon.carbonado.raw.GenericStorableCodecFactory
+
+
Returns null.
+
+
getLayoutOptions(Class<? extends Storable>) - Method in interface com.amazon.carbonado.raw.StorableCodecFactory
+
+
Optionally return additional information regarding storable encoding.
+
+
getLeftFilter() - Method in class com.amazon.carbonado.filter.BinaryOpFilter
+
 
+
getLength() - Method in interface com.amazon.carbonado.lob.Blob
+
+
Returns the length of this Blob, in bytes.
+
+
getLength() - Method in class com.amazon.carbonado.lob.BlobClob
+
 
+
getLength() - Method in class com.amazon.carbonado.lob.ByteArrayBlob
+
 
+
getLength() - Method in class com.amazon.carbonado.lob.CharArrayClob
+
 
+
getLength() - Method in interface com.amazon.carbonado.lob.Clob
+
+
Returns the length of this Clob, in characters.
+
+
getLength() - Method in class com.amazon.carbonado.lob.FileBlob
+
 
+
getLength() - Method in class com.amazon.carbonado.lob.StringClob
+
 
+
getLength() - Method in class com.amazon.carbonado.spi.StoredLob
+
 
+
getLevels() - Method in interface com.amazon.carbonado.repo.sleepycat.CompactionCapability.Result
+
 
+
getLoadTrigger() - Method in interface com.amazon.carbonado.gen.TriggerSupport
+
+
Returns a trigger which must be run for all load and fetch operations.
+
+
getLoadTrigger() - Method in class com.amazon.carbonado.spi.TriggerManager
+
+
Returns a consolidated trigger to call for load operations, or null if + none.
+
+
getLocalIndex() - Method in class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result
+
+
Returns the local index that was selected, or null if a foreign + index was selected.
+
+
getLocator() - Method in class com.amazon.carbonado.lob.BlobClob
+
 
+
getLocator() - Method in class com.amazon.carbonado.lob.ByteArrayBlob
+
+
Always returns null.
+
+
getLocator() - Method in class com.amazon.carbonado.lob.CharArrayClob
+
+
Always returns null.
+
+
getLocator() - Method in class com.amazon.carbonado.lob.FileBlob
+
+
Always returns null.
+
+
getLocator() - Method in interface com.amazon.carbonado.lob.Lob
+
+
Returns an object which identifies the Lob data, which may be null if + not supported.
+
+
getLocator() - Method in class com.amazon.carbonado.lob.StringClob
+
+
Always returns null.
+
+
getLocator(Blob) - Method in interface com.amazon.carbonado.raw.RawSupport
+
+
Returns the locator for the given Blob, returning zero if null.
+
+
getLocator(Clob) - Method in interface com.amazon.carbonado.raw.RawSupport
+
+
Returns the locator for the given Clob, returning zero if null.
+
+
getLocator(Lob) - Method in class com.amazon.carbonado.spi.LobEngine
+
+
Returns the locator for the given Lob, or zero if null.
+
+
getLocator() - Method in class com.amazon.carbonado.spi.StoredLob.Block
+
 
+
getLocator() - Method in class com.amazon.carbonado.spi.StoredLob
+
 
+
getLock() - Method in class com.amazon.carbonado.txn.TransactionScope
+
+
Returns lock used by TransactionScope.
+
+
getLockConflictDeadlockDetectMode() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns true if deadlock detection is run whenever a lock conflict occurs.
+
+
getLockTimeout() - Method in class com.amazon.carbonado.repo.map.MapRepositoryBuilder
+
+
Returns the lock timeout.
+
+
getLockTimeout() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns the lock timeout, in seconds.
+
+
getLockTimeoutInMicroseconds() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns the lock timeout, in microseconds, limited to max long value.
+
+
getLockTimeoutUnit() - Method in class com.amazon.carbonado.repo.map.MapRepositoryBuilder
+
+
Returns the lock timeout unit.
+
+
getLog() - Method in interface com.amazon.carbonado.repo.logging.LogAccessCapability
+
 
+
getLog() - Method in class com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder
+
+
Return the Log to use.
+
+
getLog() - Method in class com.amazon.carbonado.spi.AbstractRepository
+
+
Return the main Log object for this Repository.
+
+
getLogFileMaxSize() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns null if default size will be used.
+
+
getLogFiles() - Method in interface com.amazon.carbonado.repo.sleepycat.HotBackupCapability.Backup
+
+
Returns all the transaction log files to be copied, in the exact + order in which they must be copied.
+
+
getLogInMemory() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns false by default, indicating that transaction logs are persisted.
+
+
getLoginTimeout() - Method in class com.amazon.carbonado.repo.jdbc.LoggingDataSource
+
 
+
getLoginTimeout() - Method in class com.amazon.carbonado.repo.jdbc.SimpleDataSource
+
 
+
getLogRegionSize() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns the repository log region size, or null if the default + should be selected.
+
+
getLogWriter() - Method in class com.amazon.carbonado.repo.jdbc.LoggingDataSource
+
 
+
getLogWriter() - Method in class com.amazon.carbonado.repo.jdbc.SimpleDataSource
+
 
+
getMalformedType() - Method in exception com.amazon.carbonado.MalformedTypeException
+
 
+
getMasterClass() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceAccess
+
+
Returns the storable class which is referenced.
+
+
getMasterRepository() - Method in interface com.amazon.carbonado.capability.ResyncCapability
+
+
Returns the immediate master Repository, for manual comparison.
+
+
getMasterRepositoryBuilder() - Method in class com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder
+
 
+
getMatchedGeneration() - Method in interface com.amazon.carbonado.layout.StoredLayoutEquivalence
+
+
Generation of matched layout.
+
+
getMaxLocks() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
 
+
getMessage() - Method in exception com.amazon.carbonado.CorruptEncodingException
+
 
+
getMessage() - Method in exception com.amazon.carbonado.MalformedArgumentException
+
 
+
getMessage() - Method in exception com.amazon.carbonado.MalformedTypeException
+
+
Returns first message, prefixed with the malformed type.
+
+
getMessage() - Method in exception com.amazon.carbonado.MismatchException
+
 
+
getMessage() - Method in exception com.amazon.carbonado.UnsupportedTypeException
+
 
+
getMessages() - Method in exception com.amazon.carbonado.MalformedArgumentException
+
+
Multiple error messages may be embedded in a MalformedArgumentException.
+
+
getMessages() - Method in exception com.amazon.carbonado.MismatchException
+
+
Multiple error messages may be embedded in a MismatchException.
+
+
getName() - Method in interface com.amazon.carbonado.capability.IndexInfo
+
+
Returns the name of this index, or null if not applicable.
+
+
getName() - Method in interface com.amazon.carbonado.info.StorableInfo
+
+
Returns the name of the Storable described by this StorableInfo, + which is an abbreviated form of the type's class name.
+
+
getName() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns the name of this property, which is the same as the bean name + unless it has been renamed.
+
+
getName() - Method in class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder
+
 
+
getName() - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
 
+
getName() - Method in class com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder
+
 
+
getName() - Method in class com.amazon.carbonado.repo.map.MapRepositoryBuilder
+
 
+
getName() - Method in class com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder
+
 
+
getName() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
 
+
getName() - Method in interface com.amazon.carbonado.Repository
+
+
Returns the name of this repository.
+
+
getName() - Method in interface com.amazon.carbonado.RepositoryBuilder
+
+
Returns the name of the repository.
+
+
getName() - Method in interface com.amazon.carbonado.sequence.StoredSequence
+
 
+
getName() - Method in class com.amazon.carbonado.spi.AbstractRepository
+
 
+
getName() - Method in class com.amazon.carbonado.spi.IndexInfoImpl
+
 
+
getName() - Method in interface com.amazon.carbonado.spi.StoredSequence
+
+
Deprecated.
+ 
+
getName() - Method in interface com.amazon.carbonado.synthetic.SyntheticBuilder.ClassNameProvider
+
 
+
getName() - Method in class com.amazon.carbonado.synthetic.SyntheticProperty
+
 
+
getName() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableBuilder
+
+
Frequently used by the SyntheticBuilder.ClassNameProvider as a + basis for the generated classname
+
+
getName() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder
+
 
+
getNameDescriptor() - Method in class com.amazon.carbonado.info.StorableIndex
+
+
Converts this index into a parseable name descriptor string, whose + general format is:
+
+
getNextValue() - Method in interface com.amazon.carbonado.sequence.StoredSequence
+
+
Returns the pre-adjusted next value of the sequence.
+
+
getNextValue() - Method in interface com.amazon.carbonado.spi.StoredSequence
+
+
Deprecated.
+
Returns the pre-adjusted next value of the sequence.
+
+
getNotJoinedFilter() - Method in class com.amazon.carbonado.filter.Filter.NotJoined
+
+
Returns the filter which is no longer as from a join.
+
+
getNumber() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns the zero-based numerical position of this property within its + enclosing type.
+
+
getOpenFilter(Class<S>) - Static method in class com.amazon.carbonado.filter.Filter
+
+
Returns a cached filter instance that operates on the given type, which + allows all results to pass through.
+
+
getOperator() - Method in class com.amazon.carbonado.filter.PropertyFilter
+
 
+
getOptions() - Method in class com.amazon.carbonado.layout.Layout
+
+
Returns additional options, or null if none.
+
+
getOrderedProperties() - Method in class com.amazon.carbonado.info.StorableIndex
+
+
Returns a new array with all the properties in it, with directions + folded in.
+
+
getOrderedProperty(int) - Method in class com.amazon.carbonado.info.StorableIndex
+
+
Returns a specific property in this index, with the direction folded in.
+
+
getOrdering() - Method in class com.amazon.carbonado.qe.DelegatedQueryExecutor
+
 
+
getOrdering() - Method in class com.amazon.carbonado.qe.FilteredQueryExecutor
+
 
+
getOrdering() - Method in class com.amazon.carbonado.qe.FullScanQueryExecutor
+
+
Returns an empty list.
+
+
getOrdering() - Method in class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result
+
+
Returns combined handled and remainder orderings for this result.
+
+
getOrdering() - Method in class com.amazon.carbonado.qe.IndexedQueryExecutor
+
 
+
getOrdering() - Method in class com.amazon.carbonado.qe.IterableQueryExecutor
+
+
Returns an empty list.
+
+
getOrdering() - Method in class com.amazon.carbonado.qe.JoinedQueryExecutor
+
 
+
getOrdering() - Method in class com.amazon.carbonado.qe.KeyQueryExecutor
+
+
Returns an empty list.
+
+
getOrdering() - Method in interface com.amazon.carbonado.qe.QueryExecutor
+
+
Returns the result ordering of this QueryExecutor.
+
+
getOrdering() - Method in class com.amazon.carbonado.qe.SortedQueryExecutor
+
 
+
getOrdering() - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
getOrdering() - Method in class com.amazon.carbonado.qe.UnionQueryExecutor
+
 
+
getOrderingScore() - Method in class com.amazon.carbonado.qe.CompositeScore
+
+
Returns the score on how well the evaluated index performs the desired + ordering.
+
+
getOrdinal() - Method in interface com.amazon.carbonado.layout.StoredLayoutProperty
+
+
Ordinal defines the order in which this property appears in it enclosing + layout.
+
+
getOrdinalPosition() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableProperty
+
+
Returns the one-based index of the column in the table.
+
+
getPagesExamine() - Method in interface com.amazon.carbonado.repo.sleepycat.CompactionCapability.Result
+
 
+
getPagesFree() - Method in interface com.amazon.carbonado.repo.sleepycat.CompactionCapability.Result
+
 
+
getPagesTruncated() - Method in interface com.amazon.carbonado.repo.sleepycat.CompactionCapability.Result
+
 
+
getPanicHandler() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Return the panic handler to call if the database panics.
+
+
getParentLogger() - Method in class com.amazon.carbonado.repo.jdbc.LoggingDataSource
+
 
+
getParentLogger() - Method in class com.amazon.carbonado.repo.jdbc.SimpleDataSource
+
 
+
getPartitionKey() - Method in interface com.amazon.carbonado.info.StorableInfo
+
+
Returns the partition key for the Storable, or null if none exists.
+
+
getPassword() - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
Returns the optional password to use with DataSource.
+
+
getPreferenceScore() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns a value which indicates user index preference, based on the + original ordering of elements in the filter.
+
+
getPreparedStatementSetMethod() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableProperty
+
+
Returns the method to use to set this property (by index) into a + PreparedStatement.
+
+
getPreShutdownHook() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns the custom shutdown hook that runs before the repository has + finished running its own shutdown hooks, or null if none.
+
+
getPrimaryKey() - Method in interface com.amazon.carbonado.info.StorableInfo
+
+
Returns the primary key for the Storable, never null.
+
+
getPrimaryKeyIndex() - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Returns all key properties in the form of an index.
+
+
getPrimaryKeyIndex() - Method in class com.amazon.carbonado.raw.GenericStorableCodec
+
 
+
getPrimaryKeyIndex() - Method in interface com.amazon.carbonado.raw.StorableCodec
+
+
Returns the sequence and directions of properties that make up the + primary key.
+
+
getPrimaryKeyPrefixLength() - Method in class com.amazon.carbonado.raw.GenericStorableCodec
+
 
+
getPrimaryKeyPrefixLength() - Method in interface com.amazon.carbonado.raw.StorableCodec
+
+
Returns the number of prefix bytes in the primary key, which may be + zero.
+
+
getPrimaryKeyProperties() - Method in interface com.amazon.carbonado.info.StorableInfo
+
+
Returns a subset of the storable properties in an unmodifiable map + that define the primary key.
+
+
getPrimaryKeyProperties() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableInfo
+
 
+
getPrimeProperty() - Method in class com.amazon.carbonado.info.ChainedProperty
+
 
+
getProduct() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns the BDB product to use, which is JE by default.
+
+
getProperties() - Method in class com.amazon.carbonado.info.StorableIndex
+
+
Returns a new array with all the properties in it.
+
+
getProperties() - Method in interface com.amazon.carbonado.info.StorableKey
+
+
Returns all the properties of the key in a properly ordered, + unmodifiable set.
+
+
getProperties() - Method in class com.amazon.carbonado.synthetic.SyntheticPropertyList
+
+
Returns all the properties in this index, optionally prefixed with a '+' + or '-' to indicate direction.
+
+
getProperty(int) - Method in class com.amazon.carbonado.info.StorableIndex
+
+
Returns a specific property in this index.
+
+
getPropertyCount() - Method in class com.amazon.carbonado.info.StorableIndex
+
+
Returns the count of properties in this index.
+
+
getPropertyCount() - Method in class com.amazon.carbonado.synthetic.SyntheticPropertyList
+
+
Returns the count of properties in this index.
+
+
getPropertyDirection(int) - Method in class com.amazon.carbonado.info.StorableIndex
+
+
Returns the requested direction of a specific property in this index.
+
+
getPropertyDirections() - Method in interface com.amazon.carbonado.capability.IndexInfo
+
+
Returns the directions of all the properties in this index.
+
+
getPropertyDirections() - Method in class com.amazon.carbonado.info.StorableIndex
+
+
Returns a new array with all the property directions in it.
+
+
getPropertyDirections() - Method in class com.amazon.carbonado.spi.IndexInfoImpl
+
 
+
getPropertyList() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableBuilder
+
+
Frequently used by the SyntheticBuilder.ClassNameProvider as a + basis for the generated classname
+
+
getPropertyName() - Method in class com.amazon.carbonado.layout.LayoutProperty
+
 
+
getPropertyName() - Method in interface com.amazon.carbonado.layout.StoredLayoutProperty
+
 
+
getPropertyName() - Method in interface com.amazon.carbonado.raw.GenericPropertyInfo
+
 
+
getPropertyName() - Method in class com.amazon.carbonado.raw.StorablePropertyInfo
+
 
+
getPropertyNames() - Method in interface com.amazon.carbonado.capability.IndexInfo
+
+
Returns the properties in this index.
+
+
getPropertyNames() - Method in class com.amazon.carbonado.spi.IndexInfoImpl
+
 
+
getPropertyType() - Method in class com.amazon.carbonado.layout.LayoutProperty
+
 
+
getPropertyType(ClassLoader) - Method in class com.amazon.carbonado.layout.LayoutProperty
+
 
+
getPropertyType() - Method in interface com.amazon.carbonado.raw.GenericPropertyInfo
+
+
Returns the user specified property type.
+
+
getPropertyType() - Method in class com.amazon.carbonado.raw.StorablePropertyInfo
+
 
+
getPropertyTypeDescriptor() - Method in class com.amazon.carbonado.layout.LayoutProperty
+
+
Property type descriptor is a Java type descriptor.
+
+
getPropertyTypeDescriptor() - Method in interface com.amazon.carbonado.layout.StoredLayoutProperty
+
+
Property type descriptor is a Java type descriptor.
+
+
getPropertyValue(String) - Method in interface com.amazon.carbonado.Storable
+
+
Returns a Storable property value by name.
+
+
getQualifiedTableName() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableInfo
+
+
Returns the qualified table name for the Storable or null if + unsupported.
+
+
getQueryExecutorFactory() - Method in interface com.amazon.carbonado.qe.StorageAccess
+
+
Returns a QueryExecutorFactory instance for storage.
+
+
getRangeEndFilters() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns the range end property filters supported by the evaluated + index.
+
+
getRangeStartFilters() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns the range start property filters supported by the evaluated + index.
+
+
getReadMethod() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns a no-arg method used to read the property value, or null if + reading is not allowed.
+
+
getReadMethodName() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns the name of the read method, even if no read method was actually + declared.
+
+
getReadMethodName() - Method in class com.amazon.carbonado.raw.StorablePropertyInfo
+
 
+
getReadMethodName() - Method in class com.amazon.carbonado.synthetic.SyntheticProperty
+
+
Returns the name of the read method.
+
+
getReadOnly() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns true if repository should be opened read-only.
+
+
getReadWriteMembers() - Method in interface com.amazon.carbonado.capability.GroupMembers
+
+
Returns members intended for read and write access.
+
+
getReferenceAccess() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder
+
+
Build and return access to the generated storable reference class.
+
+
getReferenceClass() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceAccess
+
+
Returns the generated storable reference class.
+
+
getRemainderCount() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns number of property filters not supported by the evaluated index.
+
+
getRemainderCount() - Method in class com.amazon.carbonado.qe.OrderingScore
+
+
Returns the number of desired orderings the evaluated index does not + support.
+
+
getRemainderFilter() - Method in class com.amazon.carbonado.filter.Filter.NotJoined
+
+
Returns the filter which could not be separated.
+
+
getRemainderFilter() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns the composite remainder filter not supported by the evaluated + index, or null if no remainder.
+
+
getRemainderFilter() - Method in class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result
+
+
Remainder filter which overrides that in composite score.
+
+
getRemainderFilters() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns the filters not supported by the evaluated index.
+
+
getRemainderOrdering() - Method in class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result
+
+
Remainder orderings which override that in composite score.
+
+
getRemainderOrdering() - Method in class com.amazon.carbonado.qe.OrderingScore
+
+
Returns the ordering properties that the evaluated index does not + support.
+
+
getReplicaRepositoryBuilder() - Method in class com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder
+
 
+
getResultSetGetMethod() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableProperty
+
+
Returns the method to use to access this property (by index) from a + ResultSet.
+
+
getRightFilter() - Method in class com.amazon.carbonado.filter.BinaryOpFilter
+
 
+
getRootCause() - Method in exception com.amazon.carbonado.RepositoryException
+
+
Recursively calls getCause, until the root cause is found.
+
+
getRootRepository() - Method in interface com.amazon.carbonado.gen.StorableSupport
+
+
Returns the root parent Repository that the Storable came from.
+
+
getRootRepository() - Method in interface com.amazon.carbonado.qe.RepositoryAccess
+
 
+
getRunCheckpointer() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns true if checkpointer is run automatically.
+
+
getRunDeadlockDetector() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns true if deadlock detector is configured to run.
+
+
getRunFullRecovery() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns true if a full (catastrophic) recovery should be performed when + environment is opened.
+
+
getSchema() - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
Returns the optional schema to search for metadata.
+
+
getSchemaName() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableInfo
+
+
Returns the optional schema name for the Storable.
+
+
getSearchKeyFactory(OrderedProperty<S>[]) - Method in class com.amazon.carbonado.raw.GenericStorableCodec
+
+
Returns a search key factory, which is useful for implementing indexes + and queries.
+
+
getSequenceName() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns the property's sequence name, or null if none.
+
+
getSequenceSelectStatement() - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
Returns the native sequence select statement, which is null if the + default is chosen.
+
+
getSequenceValueProducer(String) - Method in interface com.amazon.carbonado.gen.MasterSupport
+
+
Returns a sequence value producer by name, or throw PersistException if not found.
+
+
getSequenceValueProducer(String) - Method in interface com.amazon.carbonado.sequence.SequenceCapability
+
+
Retrieve and/or generate a SequenceValueProducer for the given name.
+
+
getSequenceValueProducer(String) - Method in class com.amazon.carbonado.spi.AbstractRepository
+
 
+
getShutdownHook() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns the custom shutdown hook that runs after the repository has + finished running its own shutdown hooks, or null if none.
+
+
getSingleFileName() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns the single file that all BDB databases should reside in.
+
+
getStorable() - Method in exception com.amazon.carbonado.OptimisticLockException
+
+
Returns the Storable which was acted upon, or null if not available.
+
+
getStorableClass() - Method in class com.amazon.carbonado.raw.GenericStorableCodec
+
+
Returns a concrete Storable implementation, which is fully + thread-safe.
+
+
getStorableClass() - Method in interface com.amazon.carbonado.synthetic.SyntheticBuilder
+
 
+
getStorableClass() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableBuilder
+
 
+
getStorableClass() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder
+
 
+
getStorableCodecFactory() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns the storable codec factory used.
+
+
getStorableType() - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns the storable type that this filter operates on.
+
+
getStorableType() - Method in class com.amazon.carbonado.info.StorableIndex
+
+
Returns the type of storable this index applies to.
+
+
getStorableType() - Method in interface com.amazon.carbonado.info.StorableInfo
+
+
Returns the type of Storable described by this StorableInfo.
+
+
getStorableType() - Method in class com.amazon.carbonado.qe.AbstractQueryExecutor
+
 
+
getStorableType() - Method in class com.amazon.carbonado.qe.DelegatedQueryExecutor
+
 
+
getStorableType() - Method in class com.amazon.carbonado.qe.DelegatedQueryExecutorFactory
+
 
+
getStorableType() - Method in class com.amazon.carbonado.qe.EmptyQuery
+
 
+
getStorableType() - Method in interface com.amazon.carbonado.qe.FullScanQueryExecutor.Support
+
 
+
getStorableType() - Method in class com.amazon.carbonado.qe.IndexedQueryAnalyzer
+
 
+
getStorableType() - Method in class com.amazon.carbonado.qe.IndexedQueryExecutor
+
 
+
getStorableType() - Method in class com.amazon.carbonado.qe.KeyQueryExecutor
+
 
+
getStorableType() - Method in interface com.amazon.carbonado.qe.QueryExecutor
+
+
Returns the storable type that this executor operates on.
+
+
getStorableType() - Method in class com.amazon.carbonado.qe.QueryExecutorCache
+
 
+
getStorableType() - Method in interface com.amazon.carbonado.qe.QueryExecutorFactory
+
 
+
getStorableType() - Method in interface com.amazon.carbonado.qe.QueryFactory
+
 
+
getStorableType() - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
getStorableType() - Method in class com.amazon.carbonado.qe.StandardQueryFactory
+
 
+
getStorableType() - Method in interface com.amazon.carbonado.qe.StorageAccess
+
+
Returns the specific type of Storable managed by this object.
+
+
getStorableType() - Method in class com.amazon.carbonado.qe.UnionQueryAnalyzer
+
 
+
getStorableType() - Method in interface com.amazon.carbonado.Query
+
+
Returns the specific type of Storable managed by this object.
+
+
getStorableType() - Method in class com.amazon.carbonado.raw.CustomStorableCodec
+
 
+
getStorableType() - Method in class com.amazon.carbonado.raw.GenericStorableCodec
+
+
Returns the type of Storable that code is generated for.
+
+
getStorableType() - Method in interface com.amazon.carbonado.raw.StorableCodec
+
+
Returns the type of Storable produced by this codec.
+
+
getStorableType() - Method in interface com.amazon.carbonado.Storage
+
+
Returns the specific type of Storable managed by this object.
+
+
getStorableTypeName() - Method in class com.amazon.carbonado.layout.Layout
+
+
Storable type name is a fully qualified Java class name.
+
+
getStorableTypeName() - Method in interface com.amazon.carbonado.layout.StoredLayout
+
+
Storable type name is a fully qualified Java class name.
+
+
getStorableTypeName() - Method in interface com.amazon.carbonado.layout.StoredLayoutEquivalence
+
+
Storable type name is a fully qualified Java class name.
+
+
getStorableWithPrimaryKey() - Method in exception com.amazon.carbonado.CorruptEncodingException
+
+
If the decoder was able to extract the primary key, it will be available in the + returned Storable.
+
+
getStorage(Class<S>) - Method in class com.amazon.carbonado.spi.StoragePool
+
+
Returns a Storage instance for the given Storable type, which is lazily + created and pooled.
+
+
getStorageName(Class<? extends Storable>) - Method in class com.amazon.carbonado.raw.CustomStorableCodecFactory
+
+
Returns null to let repository decide what the name should be.
+
+
getStorageName(Class<? extends Storable>) - Method in class com.amazon.carbonado.raw.GenericStorableCodecFactory
+
+
Returns null to let repository decide what the name should be.
+
+
getStorageName(Class<? extends Storable>) - Method in interface com.amazon.carbonado.raw.StorableCodecFactory
+
+
Returns the preferred storage/database name for the given type.
+
+
getStorageType() - Method in interface com.amazon.carbonado.raw.GenericPropertyInfo
+
+
Returns the storage supported type.
+
+
getStorageType() - Method in class com.amazon.carbonado.raw.StorablePropertyInfo
+
 
+
getStorageTypePreferences() - Method in class com.amazon.carbonado.info.StorablePropertyAdapter
+
+
Returns the adapter's storage type preferences.
+
+
getSubFilter() - Method in class com.amazon.carbonado.filter.ExistsFilter
+
+
Returns the filter applied to the join, which might be open.
+
+
getSubResults() - Method in class com.amazon.carbonado.qe.UnionQueryAnalyzer.Result
+
+
Returns results for each sub-query to be executed in the union.
+
+
getSuppliedValues() - Method in class com.amazon.carbonado.filter.FilterValues
+
+
Returns all supplied values in this object.
+
+
getSuppliedValuesFor(Filter<S>) - Method in class com.amazon.carbonado.filter.FilterValues
+
+
Returns all supplied values in this object, as required by the given + Filter.
+
+
getSupport() - Method in class com.amazon.carbonado.raw.CustomStorableCodec
+
 
+
getSupport() - Method in class com.amazon.carbonado.raw.GenericStorableCodec
+
 
+
getSupport() - Method in interface com.amazon.carbonado.raw.StorableCodec
+
+
Returns the default RawSupport object that is supplied to + Storable instances produced by this codec.
+
+
getSupportTrigger(Class<S>, int) - Method in class com.amazon.carbonado.spi.LobEngine
+
+
Returns a Trigger for binding to this LobEngine.
+
+
getTableName() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableInfo
+
+
Returns the table name for the Storable or null if unsupported.
+
+
getTimeout() - Method in interface com.amazon.carbonado.Query.Controller
+
+
Returns a non-negative value if controller imposes an absolute upper + bound on query execution time.
+
+
getTimeout() - Method in class com.amazon.carbonado.Query.Timeout
+
 
+
getTimeoutUnit() - Method in interface com.amazon.carbonado.Query.Controller
+
+
Returns the unit for the timeout, if applicable.
+
+
getTimeoutUnit() - Method in class com.amazon.carbonado.Query.Timeout
+
 
+
getToStorageAdapter() - Method in interface com.amazon.carbonado.raw.GenericPropertyInfo
+
+
Returns the optional method used to adapt the property from the user + visible type to the storage supported type.
+
+
getToStorageAdapter() - Method in class com.amazon.carbonado.raw.StorablePropertyInfo
+
 
+
getTotalOrdering() - Method in class com.amazon.carbonado.qe.UnionQueryAnalyzer.Result
+
+
Returns a total ordering, if one was imposed.
+
+
getTransactionIsolationLevel() - Method in interface com.amazon.carbonado.Repository
+
+
Returns the isolation level of the current transaction, or null if there + is no transaction in the current thread.
+
+
getTransactionIsolationLevel() - Method in class com.amazon.carbonado.spi.AbstractRepository
+
 
+
getTransactionMaxActive() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns the maximum number of concurrent transactions, or null if the + default is used.
+
+
getTransactionNoSync() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns true if transactions are not written or flushed to disk.
+
+
getTransactionTimeout() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns the repository transaction timeout, in seconds.
+
+
getTransactionTimeoutInMicroseconds() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns the repository transaction timeout, in microseconds, limited to + max long value.
+
+
getTransactionWriteNoSync() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns true if transactions are not flushed to disk.
+
+
getTriggerFactories() - Method in interface com.amazon.carbonado.RepositoryBuilder
+
+
Returns all the TriggerFactories which were added.
+
+
getTriggerFactories() - Method in class com.amazon.carbonado.spi.AbstractRepositoryBuilder
+
 
+
getTriggerManagerFor(Class<S>) - Method in interface com.amazon.carbonado.spi.TriggerManagerCapability
+
+
Returns the TriggerManager for the given Storable type.
+
+
getTxn() - Method in class com.amazon.carbonado.txn.TransactionScope
+
+
Returns the implementation for the active transaction, or null if there + is no active transaction.
+
+
getType() - Method in class com.amazon.carbonado.filter.PropertyFilter
+
+
Returns the type of the ChainedProperty.
+
+
getType() - Method in class com.amazon.carbonado.info.ChainedProperty
+
+
Returns the type of the last property in the chain, or of the prime + property if the chain is empty.
+
+
getType() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns the primary type of this property.
+
+
getType() - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Returns the type of Storable that code is generated for.
+
+
getType() - Method in class com.amazon.carbonado.synthetic.SyntheticProperty
+
 
+
getType() - Method in exception com.amazon.carbonado.UnsupportedTypeException
+
 
+
getTypeDescriptor() - Method in class com.amazon.carbonado.info.StorableIndex
+
+
Converts this index into a parseable type descriptor string, which + basically consists of Java type descriptors appended together.
+
+
getUnusedOrdering() - Method in class com.amazon.carbonado.qe.OrderingScore
+
+
Returns unused ordering properties of the evaluated index because they + were filtered out.
+
+
getUpdateTrigger() - Method in interface com.amazon.carbonado.gen.TriggerSupport
+
+
Returns a trigger which must be run for all update operations.
+
+
getUpdateTrigger() - Method in class com.amazon.carbonado.spi.TriggerManager
+
+
Returns a consolidated trigger to call for update operations, or null if + none.
+
+
getUserName() - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
Returns the optional username to use with DataSource.
+
+
getUserProps() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder
+
 
+
getUserStorableTypeNames() - Method in interface com.amazon.carbonado.capability.StorableInfoCapability
+
+
Returns an array of storable type class names for user-level storables + known to the repository.
+
+
getValue(PropertyFilter<S>) - Method in class com.amazon.carbonado.filter.FilterValues
+
+
Returns the value assigned to the given PropertyFilter.
+
+
getValues() - Method in class com.amazon.carbonado.filter.FilterValues
+
+
Returns all values in this object, including those provided by filter + constants.
+
+
getValuesFor(Filter<S>) - Method in class com.amazon.carbonado.filter.FilterValues
+
+
Returns all values in this object, as required by the given Filter.
+
+
getVersion() - Method in interface com.amazon.carbonado.repo.sleepycat.EnvironmentCapability
+
+
Returns the major, minor, and patch version numbers.
+
+
getVersion() - Method in interface com.amazon.carbonado.sequence.StoredSequence
+
 
+
getVersion() - Method in class com.amazon.carbonado.spi.StoredLob.Block
+
 
+
getVersion() - Method in class com.amazon.carbonado.spi.StoredLob
+
 
+
getVersionNumber() - Method in interface com.amazon.carbonado.layout.StoredLayout
+
+
Record version number for this StoredTypeLayout instance.
+
+
getVersionNumber() - Method in interface com.amazon.carbonado.layout.StoredLayoutEquivalence
+
 
+
getVersionNumber() - Method in interface com.amazon.carbonado.layout.StoredLayoutProperty
+
+
Record version number for this StoredPropertyLayout instance.
+
+
getVersionNumber() - Method in interface com.amazon.carbonado.repo.indexed.StoredIndexInfo
+
+
Record version number for this StoredIndexInfo instance.
+
+
getVersionNumber() - Method in class com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo
+
+
Record version number for this StoredDatabaseInfo instance.
+
+
getVersionProperty() - Method in interface com.amazon.carbonado.info.StorableInfo
+
+
Returns the designated version property, or null if none.
+
+
getVersionProperty() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableInfo
+
 
+
getWrappedBlob() - Method in class com.amazon.carbonado.lob.BlobClob
+
 
+
getWrappedRepository() - Method in class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder
+
 
+
getWriteMethod() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns a one argument method used to write the property value, or null + if writing is not allowed.
+
+
getWriteMethodName() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns the name of the write method, even if no write method was + actually declared.
+
+
getWriteMethodName() - Method in class com.amazon.carbonado.raw.StorablePropertyInfo
+
 
+
getWriteMethodName() - Method in class com.amazon.carbonado.synthetic.SyntheticProperty
+
+
Returns the name of the write method.
+
+
GroupAccessCapability - Interface in com.amazon.carbonado.capability
+
+
Capability for gaining access to replication group members.
+
+
GroupedCursor<S,G> - Class in com.amazon.carbonado.cursor
+
+
Abstract cursor for aggregation and finding distinct data.
+
+
GroupedCursor(Cursor<S>, Comparator<S>) - Constructor for class com.amazon.carbonado.cursor.GroupedCursor
+
+
Create a GroupedCursor with an existing group comparator.
+
+
GroupedCursor(Cursor<S>, Class<S>, String...) - Constructor for class com.amazon.carbonado.cursor.GroupedCursor
+
+
Create a GroupedCursor using properties to define the group + comparator.
+
+
GroupMembers - Interface in com.amazon.carbonado.capability
+
 
+
GzipCompressor - Class in com.amazon.carbonado.raw
+
+
Raw-level data compression using gzip.
+
+
GzipCompressor() - Constructor for class com.amazon.carbonado.raw.GzipCompressor
+
 
+
+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.

+ + diff --git a/apidocs/index-files/index-8.html b/apidocs/index-files/index-8.html new file mode 100644 index 0000000..4d4be71 --- /dev/null +++ b/apidocs/index-files/index-8.html @@ -0,0 +1,273 @@ + + + + + + +H-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  + + +

H

+
+
handleNoSuchElement() - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Called right before throwing NoSuchElementException.
+
+
handleRequest(Repository, RemoteProcedure.Request<R, D>) - Method in interface com.amazon.carbonado.capability.RemoteProcedure
+
+
Request handler for remote procedure implementation.
+
+
handlesAnything() - Method in class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result
+
+
Returns true if the selected index does anything at all to filter + results or to order them.
+
+
HAS_DIRTY_PROPERTIES - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
hasAnyMatches() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns true if the identity count is greater than zero or if there is a + range match.
+
+
hasDirtyProperties() - Method in interface com.amazon.carbonado.Storable
+
+
Returns true if any non-primary key properties in this object are + dirty.
+
+
hashCode() - Method in class com.amazon.carbonado.filter.Filter
+
 
+
hashCode() - Method in class com.amazon.carbonado.filter.Filter.NotJoined
+
 
+
hashCode() - Method in class com.amazon.carbonado.filter.FilterValues
+
 
+
hashCode() - Method in class com.amazon.carbonado.info.ChainedProperty
+
 
+
hashCode() - Method in class com.amazon.carbonado.info.OrderedProperty
+
 
+
hashCode() - Method in class com.amazon.carbonado.info.StorableIndex
+
 
+
hashCode() - Method in class com.amazon.carbonado.layout.Layout
+
 
+
hashCode() - Method in class com.amazon.carbonado.layout.LayoutProperty
+
 
+
hashCode() - Method in class com.amazon.carbonado.lob.AbstractBlob
+
 
+
hashCode() - Method in class com.amazon.carbonado.lob.AbstractClob
+
 
+
hashCode() - Method in class com.amazon.carbonado.qe.AbstractQuery
+
 
+
hashCode() - Method in class com.amazon.carbonado.qe.EmptyQuery
+
 
+
hashCode() - Method in class com.amazon.carbonado.qe.OrderingList
+
 
+
hashCode() - Method in class com.amazon.carbonado.qe.QueryHints
+
 
+
hashCode() - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
hashCode() - Method in interface com.amazon.carbonado.Query
+
 
+
hashCode() - Method in class com.amazon.carbonado.raw.CompressedEncodingStrategy
+
 
+
hashCode() - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
 
+
hashCode() - Method in interface com.amazon.carbonado.Storable
+
 
+
hashCode() - Method in class com.amazon.carbonado.synthetic.SyntheticProperty
+
 
+
HASHCODE_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
hasLobs(Class<S>) - Static method in class com.amazon.carbonado.spi.LobEngine
+
 
+
hasNext() - Method in class com.amazon.carbonado.cursor.ControllerCursor
+
 
+
hasNext() - Method in class com.amazon.carbonado.cursor.DifferenceCursor
+
 
+
hasNext() - Method in class com.amazon.carbonado.cursor.EmptyCursor
+
+
Always returns false.
+
+
hasNext() - Method in class com.amazon.carbonado.cursor.FetchAheadCursor
+
 
+
hasNext() - Method in class com.amazon.carbonado.cursor.FilteredCursor
+
 
+
hasNext() - Method in class com.amazon.carbonado.cursor.GroupedCursor
+
 
+
hasNext() - Method in interface com.amazon.carbonado.Cursor
+
+
Returns true if this cursor has more elements.
+
+
hasNext() - Method in class com.amazon.carbonado.cursor.IntersectionCursor
+
 
+
hasNext() - Method in class com.amazon.carbonado.cursor.IteratorCursor
+
 
+
hasNext() - Method in class com.amazon.carbonado.cursor.LimitCursor
+
 
+
hasNext() - Method in class com.amazon.carbonado.cursor.MultiTransformedCursor
+
 
+
hasNext() - Method in class com.amazon.carbonado.cursor.SingletonCursor
+
 
+
hasNext() - Method in class com.amazon.carbonado.cursor.SkipCursor
+
 
+
hasNext() - Method in class com.amazon.carbonado.cursor.SortedCursor
+
 
+
hasNext() - Method in class com.amazon.carbonado.cursor.SymmetricDifferenceCursor
+
 
+
hasNext() - Method in class com.amazon.carbonado.cursor.ThrottledCursor
+
 
+
hasNext() - Method in class com.amazon.carbonado.cursor.TransformedCursor
+
 
+
hasNext() - Method in class com.amazon.carbonado.cursor.UnionCursor
+
 
+
hasNext() - Method in class com.amazon.carbonado.raw.RawCursor
+
 
+
hasProperty(String) - Method in interface com.amazon.carbonado.synthetic.SyntheticBuilder
+
+
Check to see if a particular property has already been added to the list of + properties to generate
+
+
hasProperty(String) - Method in class com.amazon.carbonado.synthetic.SyntheticStorableBuilder
+
 
+
hasProperty(String) - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder
+
 
+
hasRangeEnd() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns true if any property filter with an operator of RelOp.LT + or RelOp.LE matches an index property.
+
+
hasRangeMatch() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns true if there is both a range start and range end.
+
+
hasRangeStart() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns true if any property filter with an operator of RelOp.GT + or RelOp.GE matches an index property.
+
+
highestCommon(IsolationLevel) - Method in enum com.amazon.carbonado.IsolationLevel
+
+
Returns the highest common isolation level between this and the one + given.
+
+
HotBackupCapability - Interface in com.amazon.carbonado.repo.sleepycat
+
+
Capability for performing a backup of an active BDB environment.
+
+
HotBackupCapability.Backup - Interface in com.amazon.carbonado.repo.sleepycat
+
 
+
hours(long) - Static method in class com.amazon.carbonado.Query.Timeout
+
+
Return a new Timeout in hours.
+
+
+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.

+ + diff --git a/apidocs/index-files/index-9.html b/apidocs/index-files/index-9.html new file mode 100644 index 0000000..593671b --- /dev/null +++ b/apidocs/index-files/index-9.html @@ -0,0 +1,765 @@ + + + + + + +I-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  + + +

I

+
+
increaseIndent(int) - Method in class com.amazon.carbonado.qe.AbstractQueryExecutor
+
+
Adds a constant amount to the given indent level.
+
+
increment(byte[]) - Static method in class com.amazon.carbonado.raw.RawUtil
+
+
Adds one to an unsigned integer, represented as a byte array.
+
+
incrementVersion(CodeBuilder, TypeDesc) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Generates code to increment a version property value, already on the stack.
+
+
indent(Appendable, int) - Method in class com.amazon.carbonado.qe.AbstractQueryExecutor
+
+
Appends spaces to the given appendable.
+
+
Independent - Annotation Type in com.amazon.carbonado
+
+
A hint for a dependent Repository to allow a Storable property or type + to be undefined in the underlying schema.
+
+
Index - Annotation Type in com.amazon.carbonado
+
+
An Index annotation provides a hint to the storage layer allowing queries to be performed more quickly.
+
+
IndexedQueryAnalyzer<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
Analyzes a simple query specification and determines which index is best + suited for its execution.
+
+
IndexedQueryAnalyzer(Class<S>, RepositoryAccess) - Constructor for class com.amazon.carbonado.qe.IndexedQueryAnalyzer
+
 
+
IndexedQueryAnalyzer.Result - Class in com.amazon.carbonado.qe
+
 
+
IndexedQueryExecutor<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
QueryExecutor which utilizes an index.
+
+
IndexedQueryExecutor(IndexedQueryExecutor.Support<S>, StorableIndex<S>, CompositeScore<S>) - Constructor for class com.amazon.carbonado.qe.IndexedQueryExecutor
+
 
+
IndexedQueryExecutor.Support<S extends Storable> - Interface in com.amazon.carbonado.qe
+
+
Provides support for IndexedQueryExecutor.
+
+
IndexedRepositoryBuilder - Class in com.amazon.carbonado.repo.indexed
+
+
Repository builder for the indexed repository.
+
+
IndexedRepositoryBuilder() - Constructor for class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder
+
 
+
IndexEntryAccessCapability - Interface in com.amazon.carbonado.repo.indexed
+
+
Capability for gaining low-level access to index data, which can be used for + manual inspection and repair.
+
+
IndexEntryAccessor<S extends Storable> - Interface in com.amazon.carbonado.repo.indexed
+
+
Provides low-level access to index data, which can be used for manual + inspection and repair.
+
+
indexEntryQuery(StorableIndex<S>) - Method in interface com.amazon.carbonado.qe.IndexedQueryExecutor.Support
+
+
Returns an open query if the given index supports query access.
+
+
Indexes - Annotation Type in com.amazon.carbonado
+
+
The Indexes annotation is applied to a Storable for specifying all + the indexes it should have.
+
+
IndexInfo - Interface in com.amazon.carbonado.capability
+
+
General information about an index defined in a Storage.
+
+
IndexInfoCapability - Interface in com.amazon.carbonado.capability
+
+
Capability for getting information about physical indexes for storables.
+
+
IndexInfoImpl - Class in com.amazon.carbonado.spi
+
+
Basic implementation of an IndexInfo.
+
+
IndexInfoImpl(String, boolean, boolean, String[], Direction[]) - Constructor for class com.amazon.carbonado.spi.IndexInfoImpl
+
 
+
inferType(Class) - Static method in class com.amazon.carbonado.info.StorableIntrospector
+
+
Examines a class and determines what Storable type it implements.
+
+
initialFilterValues() - Method in class com.amazon.carbonado.filter.ClosedFilter
+
 
+
initialFilterValues() - Method in class com.amazon.carbonado.filter.ExistsFilter
+
 
+
initialFilterValues() - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns a FilterValues instance for assigning values to a + Filter.
+
+
initialFilterValues() - Method in class com.amazon.carbonado.filter.OpenFilter
+
 
+
initialVersion(CodeBuilder, TypeDesc, int) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Generates code to push an initial version property value on the stack.
+
+
insert() - Method in interface com.amazon.carbonado.Storable
+
+
Inserts a new persistent value for this object.
+
+
INSERT_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
instantiate(RawSupport, CustomStorableCodec) - Method in interface com.amazon.carbonado.raw.CustomStorableCodec.InstanceFactory
+
 
+
instantiate(RawSupport, byte[], byte[], CustomStorableCodec) - Method in interface com.amazon.carbonado.raw.CustomStorableCodec.InstanceFactory
+
 
+
instantiate() - Method in class com.amazon.carbonado.raw.CustomStorableCodec
+
 
+
instantiate(byte[], byte[]) - Method in class com.amazon.carbonado.raw.CustomStorableCodec
+
 
+
instantiate(RawSupport<S>) - Method in class com.amazon.carbonado.raw.CustomStorableCodec
+
 
+
instantiate(RawSupport<S>, byte[], byte[]) - Method in class com.amazon.carbonado.raw.CustomStorableCodec
+
 
+
instantiate(RawSupport) - Method in interface com.amazon.carbonado.raw.GenericInstanceFactory
+
 
+
instantiate(RawSupport, byte[]) - Method in interface com.amazon.carbonado.raw.GenericInstanceFactory
+
 
+
instantiate(RawSupport, byte[], byte[]) - Method in interface com.amazon.carbonado.raw.GenericInstanceFactory
+
 
+
instantiate() - Method in class com.amazon.carbonado.raw.GenericStorableCodec
+
+
Instantiate a Storable with no key or value defined yet.
+
+
instantiate(byte[]) - Method in class com.amazon.carbonado.raw.GenericStorableCodec
+
+
Instantiate a Storable with no value defined yet.
+
+
instantiate(byte[], byte[]) - Method in class com.amazon.carbonado.raw.GenericStorableCodec
+
+
Instantiate a Storable with a specific key and value.
+
+
instantiate(RawSupport<S>) - Method in class com.amazon.carbonado.raw.GenericStorableCodec
+
+
Instantiate a Storable with no key or value defined yet.
+
+
instantiate(RawSupport<S>, byte[], byte[]) - Method in class com.amazon.carbonado.raw.GenericStorableCodec
+
+
Instantiate a Storable with a specific key and value.
+
+
instantiate() - Method in interface com.amazon.carbonado.raw.StorableCodec
+
+
Instantiate a Storable with no key or value defined yet.
+
+
instantiate(byte[]) - Method in interface com.amazon.carbonado.raw.StorableCodec
+
+
Instantiate a Storable with no value defined yet.
+
+
instantiate(byte[], byte[]) - Method in interface com.amazon.carbonado.raw.StorableCodec
+
+
Instantiate a Storable with a specific key and value.
+
+
instantiate(RawSupport<S>) - Method in interface com.amazon.carbonado.raw.StorableCodec
+
+
Instantiate a Storable with no key or value defined yet.
+
+
instantiate(RawSupport<S>, byte[], byte[]) - Method in interface com.amazon.carbonado.raw.StorableCodec
+
+
Instantiate a Storable with a specific key and value.
+
+
instantiateCurrent() - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Returns a new Storable instance for the currently referenced entry.
+
+
IntegerConstraint - Annotation Type in com.amazon.carbonado.constraint
+
+
Limits the value of a property to be a member of a specific set.
+
+
IntegerConstraint.Constraint - Class in com.amazon.carbonado.constraint
+
+
Constraint implementation for IntegerConstraint.
+
+
IntegerConstraint.Constraint(Class<?>, String, IntegerConstraint) - Constructor for class com.amazon.carbonado.constraint.IntegerConstraint.Constraint
+
 
+
IntegerConstraint.Constraint(Class<?>, String, long, long, long[], long[]) - Constructor for class com.amazon.carbonado.constraint.IntegerConstraint.Constraint
+
 
+
IntersectionCursor<S> - Class in com.amazon.carbonado.cursor
+
+
Wraps two Cursors and performs a set intersection operation.
+
+
IntersectionCursor(Cursor<S>, Cursor<S>, Comparator<S>) - Constructor for class com.amazon.carbonado.cursor.IntersectionCursor
+
 
+
IS_ALT_KEY_INITIALIZED_PREFIX - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Name prefix of protected method in generated storable that returns false + if a specific alternate key is uninitialized.
+
+
IS_PARTITION_KEY_INITIALIZED_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Name of protected method in generated storable that returns false if any + partition keys are uninitialized.
+
+
IS_PK_INITIALIZED_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Name of protected method in generated storable that returns false if any + primary keys are uninitialized.
+
+
IS_PROPERTY_CLEAN - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
IS_PROPERTY_DIRTY - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
IS_PROPERTY_SUPPORTED - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
IS_PROPERTY_UNINITIALIZED - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
IS_REQUIRED_DATA_INITIALIZED_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Name of protected method in generated storable that returns false if any + non-nullable, non-pk properties are uninitialized.
+
+
IS_VERSION_INITIALIZED_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Name of protected method in generated storable that returns false if + version property is uninitialized.
+
+
isAllClustered() - Method in class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder
+
+
Returns true if all indexes should be identified as clustered.
+
+
isAllowed(S) - Method in class com.amazon.carbonado.cursor.FilteredCursor
+
 
+
isAlternateKeyMember() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns true if this property is a member of an alternate key.
+
+
isAssigned(PropertyFilter<S>) - Method in class com.amazon.carbonado.filter.FilterValues
+
+
Returns true if a value is assigned to the given PropertyFilter.
+
+
isAtLeast(IsolationLevel) - Method in enum com.amazon.carbonado.IsolationLevel
+
+
Returns true if this isolation level is at least as high as the one + given.
+
+
isAtMost(IsolationLevel) - Method in enum com.amazon.carbonado.IsolationLevel
+
+
Returns true if this isolation level is no higher than the one given.
+
+
isAuthoritative() - Method in interface com.amazon.carbonado.info.StorableInfo
+
 
+
isAutoIncrement() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableProperty
+
+
Returns true if property is declared as @Automatic and column is + designated as auto-increment.
+
+
isAutomatic() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns true of this property is given an automatic value upon insert.
+
+
isAutoShutdownEnabled() - Method in interface com.amazon.carbonado.capability.ShutdownCapability
+
+
Returns true if repository has a shutdown hook registered to + automatically call shutdown when the virtual machine exits.
+
+
isAutoShutdownEnabled() - Method in class com.amazon.carbonado.spi.AbstractRepository
+
 
+
isBound() - Method in class com.amazon.carbonado.filter.BinaryOpFilter
+
 
+
isBound() - Method in class com.amazon.carbonado.filter.ClosedFilter
+
 
+
isBound() - Method in class com.amazon.carbonado.filter.ExistsFilter
+
 
+
isBound() - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns true if all property filters are known to be properly + bound.
+
+
isBound() - Method in class com.amazon.carbonado.filter.OpenFilter
+
 
+
isBound() - Method in class com.amazon.carbonado.filter.PropertyFilter
+
 
+
isClosed() - Method in class com.amazon.carbonado.filter.ClosedFilter
+
+
Always returns true.
+
+
isClosed() - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns true if filter prevents any results from passing through.
+
+
isClosed() - Method in class com.amazon.carbonado.spi.AbstractRepository
+
 
+
isClosed() - Method in class com.amazon.carbonado.txn.TransactionManager
+
 
+
isClustered() - Method in interface com.amazon.carbonado.capability.IndexInfo
+
+
Returns true if index is clustered, which means it defines the physical + ordering of storables.
+
+
isClustered() - Method in class com.amazon.carbonado.info.StorableIndex
+
+
Returns true if index is known to be clustered, which means it defines + the physical ordering of storables.
+
+
isClustered() - Method in class com.amazon.carbonado.spi.IndexInfoImpl
+
 
+
isColumnNullable() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableProperty
+
 
+
isConsistent(Storable, S) - Method in interface com.amazon.carbonado.repo.indexed.IndexEntryAccessor
+
+
Returns true if the properties of the given index entry match those + contained in the master, exluding any version property.
+
+
isConsistent(Storable, S) - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceAccess
+
+
Returns true if the properties of the given reference match those + contained in the master, excluding any version property.
+
+
isConsistent(Storable, S) - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder
+
+
Deprecated. +
call getReferenceAccess
+
+
+
isConstant() - Method in class com.amazon.carbonado.filter.PropertyFilter
+
+
Returns true if this PropertyFilter has a constant value.
+
+
isConversionPossible(Class) - Method in class com.amazon.carbonado.util.ConversionComparator
+
+
Returns true if a coversion is possible to the given type.
+
+
isDerived() - Method in class com.amazon.carbonado.info.ChainedProperty
+
+
Returns true if any property in the chain is derived.
+
+
isDerived() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns true if this property is derived.
+
+
isDerived() - Method in interface com.amazon.carbonado.raw.GenericPropertyInfo
+
 
+
isDerived() - Method in class com.amazon.carbonado.raw.StorablePropertyInfo
+
 
+
isEmpty() - Method in class com.amazon.carbonado.gen.StorablePropertyMap
+
 
+
isEmpty() - Method in class com.amazon.carbonado.qe.QueryHints
+
 
+
isEmpty() - Method in class com.amazon.carbonado.util.SoftValuedCache
+
+
Deprecated.
+ 
+
isEnabled() - Method in class com.amazon.carbonado.repo.logging.CommonsLog
+
 
+
isEnabled() - Method in interface com.amazon.carbonado.repo.logging.Log
+
 
+
isExplicit() - Method in interface com.amazon.carbonado.synthetic.SyntheticBuilder.ClassNameProvider
+
+
SyntheticBuilder may choose to alter the class name to prevent a + class name collision.
+
+
isForceStoredSequence() - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
+
Returns true if native sequences should not be used.
+
+
isForUpdate() - Method in interface com.amazon.carbonado.Transaction
+
+
Returns true if this transaction is in update mode, which is adjusted by + calling Transaction.setForUpdate(boolean).
+
+
isForUpdate() - Method in class com.amazon.carbonado.txn.TransactionPair
+
 
+
isForUpdate() - Method in class com.amazon.carbonado.txn.TransactionScope
+
+
Returns true if an active transaction exists and it is for update.
+
+
isIndependent() - Method in interface com.amazon.carbonado.info.StorableInfo
+
 
+
isIndependent() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns true if this property has been designated independent.
+
+
isIndexClustered() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns true if evaluated index is clustered.
+
+
isIndexClustered() - Method in class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result
+
+
Returns true if local or foreign index is clustered.
+
+
isIndexClustered() - Method in class com.amazon.carbonado.qe.OrderingScore
+
+
Returns true if evaluated index is clustered.
+
+
isIndexRepairEnabled() - Method in class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder
+
 
+
isIndexRepairEnabled() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
 
+
isIndexUnique() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns true if evaluated index is unique.
+
+
isJoin() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns true if this property is joined in any way to another Storable.
+
+
isKeyMatch() - Method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns true if evaluated index is unique and each of its properties has + an identity match.
+
+
isLob() - Method in interface com.amazon.carbonado.raw.GenericPropertyInfo
+
 
+
isLob() - Method in class com.amazon.carbonado.raw.StorablePropertyInfo
+
 
+
isMaster() - Method in class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder
+
 
+
isMaster() - Method in class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder
+
 
+
isMaster() - Method in class com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder
+
 
+
isMaster() - Method in class com.amazon.carbonado.repo.map.MapRepositoryBuilder
+
 
+
isMaster() - Method in class com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder
+
 
+
isMaster() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
 
+
isMaster() - Method in interface com.amazon.carbonado.RepositoryBuilder
+
+
Returns true if repository should assume the role of master, which is + true by default.
+
+
isMultiversion() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns false by default because multiversion concurrency control (MVCC) + is not enabled.
+
+
isNotExists() - Method in class com.amazon.carbonado.filter.ExistsFilter
+
 
+
isNullable() - Method in class com.amazon.carbonado.info.ChainedProperty
+
+
Returns true if any property in the chain can be null.
+
+
isNullable() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns true if this property can be null.
+
+
isNullable() - Method in class com.amazon.carbonado.layout.LayoutProperty
+
+
Returns true of property can be set to null.
+
+
isNullable() - Method in interface com.amazon.carbonado.layout.StoredLayoutProperty
+
+
Returns true of property value can be set to null.
+
+
isNullable() - Method in interface com.amazon.carbonado.raw.GenericPropertyInfo
+
 
+
isNullable() - Method in class com.amazon.carbonado.raw.StorablePropertyInfo
+
 
+
isNullable() - Method in class com.amazon.carbonado.synthetic.SyntheticProperty
+
 
+
IsolationLevel - Enum in com.amazon.carbonado
+
+
Describes a transaction isolation level.
+
+
isOneToOneJoin() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns true if this property is one-to-one joined to another Storable.
+
+
isOpen() - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns true if filter allows all results to pass through.
+
+
isOpen() - Method in class com.amazon.carbonado.filter.OpenFilter
+
+
Always returns true.
+
+
isOuterJoin(int) - Method in class com.amazon.carbonado.info.ChainedProperty
+
+
Returns true if the property at the given index should be treated as an + outer join.
+
+
isPartitionKeyMember() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns true if this property is a member of a partition key.
+
+
isPrimary() - Method in interface com.amazon.carbonado.info.StorableKey
+
+
Returns true if this key is primary, false otherwise.
+
+
isPrimaryKeyMember() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns true if this property is a member of a primary key.
+
+
isPrimaryKeyMember() - Method in class com.amazon.carbonado.layout.LayoutProperty
+
+
Returns true if property is a member of the primary key.
+
+
isPrimaryKeyMember() - Method in interface com.amazon.carbonado.layout.StoredLayoutProperty
+
+
Returns true if property is a member of the primary key.
+
+
isPrivate() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
+
Returns true if BDB environment is private.
+
+
isPropertyClean(String) - Method in interface com.amazon.carbonado.Storable
+
+
Returns true if the given property of this Storable is clean.
+
+
isPropertyDirty(String) - Method in interface com.amazon.carbonado.Storable
+
+
Returns true if the given property of this Storable has been set, but no + load or store operation has been performed yet.
+
+
isPropertySupported(Class<Storable>, String) - Method in interface com.amazon.carbonado.capability.StorableInfoCapability
+
+
Returns true if the given property exists and is supported.
+
+
isPropertySupported(String) - Method in interface com.amazon.carbonado.gen.StorableSupport
+
+
Returns true if the given property exists and is supported.
+
+
isPropertySupported(String) - Method in interface com.amazon.carbonado.Storable
+
+
Returns true if the given property exists and is supported.
+
+
isPropertyUninitialized(String) - Method in interface com.amazon.carbonado.Storable
+
+
Returns true if the given property of this Storable has never been + loaded or set.
+
+
isPublicMethodFinal(Class, String, TypeDesc, TypeDesc[]) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Returns true if a public final method exists which matches the given + specification.
+
+
isQuery() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns true if this property is a query, which also implies that it is + a join property.
+
+
isReverseSplitOff() - Method in class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder
+
 
+
isSelectable() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableProperty
+
+
Returns true if property is both supported and not a join.
+
+
isSupported(Class<Storable>) - Method in interface com.amazon.carbonado.capability.StorableInfoCapability
+
+
Returns true if the given storable type is supported.
+
+
isSupported(Class<?>) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Returns true if the type of the given property type is supported.
+
+
isSupported(TypeDesc) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Returns true if the type of the given property type is supported.
+
+
isSupported() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableInfo
+
+
Returns false only if storable type is independent + and no matching table was found.
+
+
isSupported() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCStorableProperty
+
+
Returns false only if property is independent and no matching column was + found.
+
+
isTransactionForUpdate() - Method in interface com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability
+
+
Returns true if a transaction is in progress and it is for update.
+
+
isUnique() - Method in interface com.amazon.carbonado.capability.IndexInfo
+
+
Returns true if index entries are unique.
+
+
isUnique() - Method in class com.amazon.carbonado.info.StorableIndex
+
 
+
isUnique() - Method in class com.amazon.carbonado.spi.IndexInfoImpl
+
 
+
isUnique() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder
+
+
True if the generated derived class should be considered unique.
+
+
isUniqueConstraintError(SQLException) - Method in interface com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability
+
+
Examines the SQLSTATE code of the given SQL exception and determines if + it is a unique constaint violation.
+
+
isVersion() - Method in interface com.amazon.carbonado.info.StorableProperty
+
+
Returns true if this property is the designated version number for the + Storable.
+
+
isVersion() - Method in class com.amazon.carbonado.layout.LayoutProperty
+
+
Returns true if this property is the designated version number for the + Storable.
+
+
isVersion() - Method in interface com.amazon.carbonado.layout.StoredLayoutProperty
+
+
Returns true if this property is the designated version number for the + Storable.
+
+
isVersion() - Method in class com.amazon.carbonado.synthetic.SyntheticProperty
+
 
+
isVersioned() - Method in interface com.amazon.carbonado.synthetic.SyntheticBuilder
+
+
Returns true if a property with the version attribute has been addded
+
+
isVersioned() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableBuilder
+
 
+
isVersioned() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder
+
 
+
isWrapperFor(Class<?>) - Method in class com.amazon.carbonado.repo.jdbc.LoggingDataSource
+
 
+
isWrapperFor(Class<?>) - Method in class com.amazon.carbonado.repo.jdbc.SimpleDataSource
+
 
+
IterableQueryExecutor<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
QueryExecutor which fully scans an iterable collection.
+
+
IterableQueryExecutor(Class<S>, Iterable<S>) - Constructor for class com.amazon.carbonado.qe.IterableQueryExecutor
+
 
+
IterableQueryExecutor(Class<S>, Iterable<S>, Lock) - Constructor for class com.amazon.carbonado.qe.IterableQueryExecutor
+
 
+
iterator() - Method in class com.amazon.carbonado.cursor.MergeSortBuffer
+
 
+
IteratorCursor<S> - Class in com.amazon.carbonado.cursor
+
+
Adapts an Iterator into a Cursor.
+
+
IteratorCursor(Iterable<S>) - Constructor for class com.amazon.carbonado.cursor.IteratorCursor
+
 
+
IteratorCursor(Iterable<S>, Lock) - Constructor for class com.amazon.carbonado.cursor.IteratorCursor
+
 
+
IteratorCursor(Iterator<S>) - Constructor for class com.amazon.carbonado.cursor.IteratorCursor
+
 
+
+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.

+ + diff --git a/apidocs/index.html b/apidocs/index.html new file mode 100644 index 0000000..268292c --- /dev/null +++ b/apidocs/index.html @@ -0,0 +1,68 @@ + + + + + + +Carbonado 1.2.3 API + + + + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> + + + diff --git a/apidocs/overview-frame.html b/apidocs/overview-frame.html new file mode 100644 index 0000000..c2da151 --- /dev/null +++ b/apidocs/overview-frame.html @@ -0,0 +1,43 @@ + + + + + + +Overview List (Carbonado 1.2.3 API) + + + + +
All Classes
+
+

Packages

+ +
+

 

+ + 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.

+ + diff --git a/apidocs/overview-tree.html b/apidocs/overview-tree.html new file mode 100644 index 0000000..c7029d2 --- /dev/null +++ b/apidocs/overview-tree.html @@ -0,0 +1,717 @@ + + + + + + +Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Annotation Type Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/package-list b/apidocs/package-list new file mode 100644 index 0000000..a9351d7 --- /dev/null +++ b/apidocs/package-list @@ -0,0 +1,23 @@ +com.amazon.carbonado +com.amazon.carbonado.adapter +com.amazon.carbonado.capability +com.amazon.carbonado.constraint +com.amazon.carbonado.cursor +com.amazon.carbonado.filter +com.amazon.carbonado.gen +com.amazon.carbonado.info +com.amazon.carbonado.layout +com.amazon.carbonado.lob +com.amazon.carbonado.qe +com.amazon.carbonado.raw +com.amazon.carbonado.repo.indexed +com.amazon.carbonado.repo.jdbc +com.amazon.carbonado.repo.logging +com.amazon.carbonado.repo.map +com.amazon.carbonado.repo.replicated +com.amazon.carbonado.repo.sleepycat +com.amazon.carbonado.sequence +com.amazon.carbonado.spi +com.amazon.carbonado.synthetic +com.amazon.carbonado.txn +com.amazon.carbonado.util diff --git a/apidocs/resources/background.gif b/apidocs/resources/background.gif new file mode 100644 index 0000000..f471940 Binary files /dev/null and b/apidocs/resources/background.gif differ diff --git a/apidocs/resources/tab.gif b/apidocs/resources/tab.gif new file mode 100644 index 0000000..1a73a83 Binary files /dev/null and b/apidocs/resources/tab.gif differ diff --git a/apidocs/resources/titlebar.gif b/apidocs/resources/titlebar.gif new file mode 100644 index 0000000..17443b3 Binary files /dev/null and b/apidocs/resources/titlebar.gif differ diff --git a/apidocs/resources/titlebar_end.gif b/apidocs/resources/titlebar_end.gif new file mode 100644 index 0000000..3ad78d4 Binary files /dev/null and b/apidocs/resources/titlebar_end.gif differ diff --git a/apidocs/serialized-form.html b/apidocs/serialized-form.html new file mode 100644 index 0000000..8168f5c --- /dev/null +++ b/apidocs/serialized-form.html @@ -0,0 +1,903 @@ + + + + + + +Serialized Form (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Serialized Form

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/stylesheet.css b/apidocs/stylesheet.css new file mode 100644 index 0000000..0aeaa97 --- /dev/null +++ b/apidocs/stylesheet.css @@ -0,0 +1,474 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ +body { + background-color:#ffffff; + color:#353833; + font-family:Arial, Helvetica, sans-serif; + font-size:76%; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4c6b87; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4c6b87; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-size:1.3em; +} +h1 { + font-size:1.8em; +} +h2 { + font-size:1.5em; +} +h3 { + font-size:1.4em; +} +h4 { + font-size:1.3em; +} +h5 { + font-size:1.2em; +} +h6 { + font-size:1.1em; +} +ul { + list-style-type:disc; +} +code, tt { + font-size:1.2em; +} +dt code { + font-size:1.2em; +} +table tr td dt code { + font-size:1.2em; + vertical-align:top; +} +sup { + font-size:.6em; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:.8em; + z-index:200; + margin-top:-7px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + background-image:url(resources/titlebar.gif); + background-position:left top; + background-repeat:no-repeat; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-image:url(resources/background.gif); + background-repeat:repeat-x; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:1em; + margin:0; +} +.topNav { + background-image:url(resources/background.gif); + background-repeat:repeat-x; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; +} +.bottomNav { + margin-top:10px; + background-image:url(resources/background.gif); + background-repeat:repeat-x; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; +} +.subNav { + background-color:#dee3e9; + border-bottom:1px solid #9eadc0; + float:left; + width:100%; + overflow:hidden; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding:3px 6px; +} +ul.subNavList li{ + list-style:none; + float:left; + font-size:90%; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; +} +.navBarCell1Rev { + background-image:url(resources/tab.gif); + background-color:#a88834; + color:#FFFFFF; + margin: auto 5px; + border:1px solid #c9aa44; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader h1 { + font-size:1.3em; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 25px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:1.2em; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border-top:1px solid #9eadc0; + border-bottom:1px solid #9eadc0; + margin:0 0 6px -8px; + padding:2px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border-top:1px solid #9eadc0; + border-bottom:1px solid #9eadc0; + margin:0 0 6px -8px; + padding:2px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:1.0em; +} +.indexContainer h2 { + font-size:1.1em; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:1.1em; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:10px 0 10px 20px; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:25px; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #9eadc0; + background-color:#f9f9f9; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:1px solid #9eadc0; + border-top:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; + border-bottom:1px solid #9eadc0; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.contentContainer table, .classUseContainer table, .constantValuesContainer table { + border-bottom:1px solid #9eadc0; + width:100%; +} +.contentContainer ul li table, .classUseContainer ul li table, .constantValuesContainer ul li table { + width:100%; +} +.contentContainer .description table, .contentContainer .details table { + border-bottom:none; +} +.contentContainer ul li table th.colOne, .contentContainer ul li table th.colFirst, .contentContainer ul li table th.colLast, .classUseContainer ul li table th, .constantValuesContainer ul li table th, .contentContainer ul li table td.colOne, .contentContainer ul li table td.colFirst, .contentContainer ul li table td.colLast, .classUseContainer ul li table td, .constantValuesContainer ul li table td{ + vertical-align:top; + padding-right:20px; +} +.contentContainer ul li table th.colLast, .classUseContainer ul li table th.colLast,.constantValuesContainer ul li table th.colLast, +.contentContainer ul li table td.colLast, .classUseContainer ul li table td.colLast,.constantValuesContainer ul li table td.colLast, +.contentContainer ul li table th.colOne, .classUseContainer ul li table th.colOne, +.contentContainer ul li table td.colOne, .classUseContainer ul li table td.colOne { + padding-right:3px; +} +.overviewSummary caption, .packageSummary caption, .contentContainer ul.blockList li.blockList caption, .summary caption, .classUseContainer caption, .constantValuesContainer caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#FFFFFF; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + margin:0px; +} +caption a:link, caption a:hover, caption a:active, caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .packageSummary caption span, .contentContainer ul.blockList li.blockList caption span, .summary caption span, .classUseContainer caption span, .constantValuesContainer caption span { + white-space:nowrap; + padding-top:8px; + padding-left:8px; + display:block; + float:left; + background-image:url(resources/titlebar.gif); + height:18px; +} +.overviewSummary .tabEnd, .packageSummary .tabEnd, .contentContainer ul.blockList li.blockList .tabEnd, .summary .tabEnd, .classUseContainer .tabEnd, .constantValuesContainer .tabEnd { + width:10px; + background-image:url(resources/titlebar_end.gif); + background-repeat:no-repeat; + background-position:top right; + position:relative; + float:left; +} +ul.blockList ul.blockList li.blockList table { + margin:0 0 12px 0px; + width:100%; +} +.tableSubHeadingColor { + background-color: #EEEEFF; +} +.altColor { + background-color:#eeeeef; +} +.rowColor { + background-color:#ffffff; +} +.overviewSummary td, .packageSummary td, .contentContainer ul.blockList li.blockList td, .summary td, .classUseContainer td, .constantValuesContainer td { + text-align:left; + padding:3px 3px 3px 7px; +} +th.colFirst, th.colLast, th.colOne, .constantValuesContainer th { + background:#dee3e9; + border-top:1px solid #9eadc0; + border-bottom:1px solid #9eadc0; + text-align:left; + padding:3px 3px 3px 7px; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +td.colFirst, th.colFirst { + border-left:1px solid #9eadc0; + white-space:nowrap; +} +td.colLast, th.colLast { + border-right:1px solid #9eadc0; +} +td.colOne, th.colOne { + border-right:1px solid #9eadc0; + border-left:1px solid #9eadc0; +} +table.overviewSummary { + padding:0px; + margin-left:0px; +} +table.overviewSummary td.colFirst, table.overviewSummary th.colFirst, +table.overviewSummary td.colOne, table.overviewSummary th.colOne { + width:25%; + vertical-align:middle; +} +table.packageSummary td.colFirst, table.overviewSummary th.colFirst { + width:25%; + vertical-align:middle; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:.9em; +} +.block { + display:block; + margin:3px 0 0 0; +} +.strong { + font-weight:bold; +} diff --git a/docs/CarbonadoGuide.pdf b/docs/CarbonadoGuide.pdf new file mode 100644 index 0000000..847f161 Binary files /dev/null and b/docs/CarbonadoGuide.pdf differ -- cgit v1.2.3