com.amazon.carbonado.layout

Class Layout

java.lang.Object

com.amazon.carbonado.layout.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 Type	Method and Description
boolean	equalLayouts(Layout layout) Returns true if the given layout matches this one.
boolean	equals(java.lang.Object obj)
java.util.List<LayoutProperty>	getAllProperties() Returns all the properties of this layout, in their proper order.
org.joda.time.DateTime	getCreationDateTime() Returns the date and time for when this layout generation was created.
java.lang.String	getCreationHost() Returns the host machine that created this generation.
java.lang.String	getCreationUser() 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.
int	getGeneration() Returns the generation of this layout, where zero represents the first generation.
Layout	getGeneration(int generation) Returns the layout for a particular generation of this layout's type.
long	getLayoutID() Returns a unique identifier for this layout.
LayoutOptions	getOptions() Returns additional options, or null if none.
java.lang.String	getStorableTypeName() Storable type name is a fully qualified Java class name.
int	hashCode()
Layout	nextGeneration() Returns the next known generation of the storable's layout, or null if none.
Layout	previousGeneration() 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.String	toString()
void	writeTo(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

getAllProperties

public java.util.List<LayoutProperty> getAllProperties()
                                                throws FetchException

Returns all the 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

getGeneration

public Layout getGeneration(int generation)
                     throws FetchNoneException,
                            FetchException

Returns the layout for a particular generation of this layout's type.

Throws:

FetchNoneException - if generation not found

FetchException

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

writeTo

public void writeTo(java.io.OutputStream out)
             throws java.io.IOException,
                    RepositoryException

Write a layout to be read by LayoutFactory.readLayoutFrom(java.io.InputStream).

Throws:

java.io.IOException

RepositoryException

Since:

1.2.2