com.amazon.carbonado.layout

Class LayoutFactory

java.lang.Object

com.amazon.carbonado.layout.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 Type	Field and Description
static int	VERSION

Constructor Summary

Constructors

Constructor and Description
LayoutFactory(Repository repo)

Method Summary

Methods

Modifier and Type	Method and Description
Layout	layoutFor(boolean readOnly, java.lang.Class<? extends Storable> type, LayoutOptions options) Returns the layout matching the current definition of the given type.
Layout	layoutFor(java.lang.Class<? extends Storable> type) Returns the layout matching the current definition of the given type.
Layout	layoutFor(java.lang.Class<? extends Storable> type, int generation) Returns the layout for a particular generation of the given type.
Layout	layoutFor(java.lang.Class<? extends Storable> type, LayoutOptions options) Returns the layout matching the current definition of the given type.
Layout	readLayoutFrom(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

Field Detail

VERSION

public static final int VERSION

See Also:

Constant Field Values

Constructor Detail

LayoutFactory

public LayoutFactory(Repository repo)
              throws RepositoryException

Throws:

SupportException - if underlying repository does not support the storables for persisting storable layouts

RepositoryException

Method Detail

layoutFor

public Layout layoutFor(java.lang.Class<? extends Storable> type)
                 throws FetchException,
                        PersistException

Returns the layout matching the current definition of the given type.

Specified by:

layoutFor in interface LayoutCapability

Throws:

PersistException - if type represents a new generation, but persisting this information failed

FetchException

layoutFor

public Layout layoutFor(java.lang.Class<? extends Storable> type,
               LayoutOptions options)
                 throws FetchException,
                        PersistException

Returns the layout matching the current definition of the given type.

Throws:

PersistException - if type represents a new generation, but persisting this information failed

FetchException

layoutFor

public Layout layoutFor(boolean readOnly,
               java.lang.Class<? extends Storable> type,
               LayoutOptions options)
                 throws FetchException,
                        PersistException

Returns the layout matching the current definition of the given type.

Parameters:

readOnly - if true, don't attempt to persist new generation because underlying repository is read-only

Throws:

PersistException - if type represents a new generation, but persisting this information failed

FetchException

layoutFor

public Layout layoutFor(java.lang.Class<? extends Storable> type,
               int generation)
                 throws FetchException,
                        FetchNoneException

Returns the layout for a particular generation of the given type.

Specified by:

layoutFor in interface LayoutCapability

Parameters:

generation - desired generation

Throws:

FetchNoneException - if generation not found

FetchException

readLayoutFrom

public Layout readLayoutFrom(java.io.InputStream in)
                      throws java.io.IOException,
                             RepositoryException

Read a layout as written by Layout.writeTo(java.io.OutputStream).

Throws:

java.io.IOException

RepositoryException

Since:

1.2.2