GenericStorableCodec (Carbonado 1.2.3 API)

java.lang.Object
+
- com.amazon.carbonado.raw.GenericStorableCodec<S>
+

+
+
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
+

+ +

Nested Class Summary

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GenericStorableCodec.Decoder<S extends Storable>` + Used for decoding different generations of Storable. +
`static interface`	`GenericStorableCodec.SearchKeyFactory<S extends Storable>` + Creates custom raw search keys for `Storable` types. +

+ +

+ + +

Method Summary

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

Methods
Modifier and Type	Method and Description
`void`	`decode(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. +
`int`	`getPrimaryKeyPrefixLength()` + 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. +
`S`	`instantiate()` + Instantiate a Storable with no key or value defined yet. +
`S`	`instantiate(byte[] key)` + Instantiate a Storable with no value defined yet. +
`S`	`instantiate(byte[] key, + byte[] value)` + Instantiate a Storable with a specific key and value. +
`S`	`instantiate(RawSupport<S> support)` + Instantiate a Storable with no key or value defined yet. +
`S`	`instantiate(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
    +
  + + + +
  - +
    instantiate
    +
```
public 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.
    +
    +
    Specified by:
    +
    instantiate in interface StorableCodec<S extends Storable>
    +
    Parameters:
    support - binds generated storable with a storage layer
    +
    Throws:
    +
    FetchException
    +
  + + + +
  - +
    getPrimaryKeyIndex
    +
```
public StorableIndex<S> getPrimaryKeyIndex()
```
    +
    Description copied from interface: StorableCodec
    +
    Returns the sequence and directions of properties that make up the + primary key.
    +
    +
    Specified by:
    +
    getPrimaryKeyIndex in interface StorableCodec<S extends Storable>
    +
    +
  + + + +
  - +
    getPrimaryKeyPrefixLength
    +
```
public int getPrimaryKeyPrefixLength()
```
    +
    Description copied from interface: StorableCodec
    +
    Returns the number of prefix bytes in the primary key, which may be + zero.
    +
    +
    Specified by:
    +
    getPrimaryKeyPrefixLength in interface StorableCodec<S extends Storable>
    +
    +
  + + + + + +
  - +
    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>
    +
    +
  + + + +
  - +
    getSupport
    +
```
public RawSupport<S> getSupport()
```
    +
    Description copied from interface: StorableCodec
    +
    Returns the default RawSupport object that is supplied to + Storable instances produced by this codec.
    +
    +
    Specified by:
    +
    getSupport in interface StorableCodec<S extends Storable>
    +
    Since:
    +
    1.2
    +
  + + + +
  - +
    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
    +
  + + + +
  - +
    getDecoder
    +
```
@Deprecated
+public GenericStorableCodec.Decoder<S> getDecoder(int generation)
+                                                            throws FetchNoneException,
+                                                                   FetchException
```
    +
    Deprecated. use direct decode method
    +
    Returns a data decoder for the given generation.
    +
    Throws:
    +
    FetchNoneException - if generation is unknown
    +
    FetchException
    +
  +
+

Class GenericStorableCodec<S extends Storable>

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getStorableType

instantiate

instantiate

instantiate

instantiate

instantiate

getPrimaryKeyIndex

getPrimaryKeyPrefixLength

encodePrimaryKey

encodePrimaryKey

encodePrimaryKey

encodePrimaryKey

encodePrimaryKeyPrefix

getSupport

getStorableClass

getSearchKeyFactory

decode

getDecoder