SyntheticStorableBuilder (Carbonado 1.2.1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.amazon.carbonado.synthetic
Class SyntheticStorableBuilder

java.lang.Object
  com.amazon.carbonado.synthetic.SyntheticStorableBuilder

All Implemented Interfaces:: SyntheticBuilder

public class SyntheticStorableBuilder
extends Object
implements SyntheticBuilder
extends 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

Nested Class Summary

Nested classes/interfaces inherited from interface com.amazon.carbonado.synthetic.SyntheticBuilder
`SyntheticBuilder.ClassNameProvider`

Constructor Summary
`SyntheticStorableBuilder(String name, ClassLoader loader)`

Method Summary
`SyntheticKey`	`addAlternateKey()` Add an alternate key to be built.
`SyntheticIndex`	`addIndex()` Add an index to the set managed by this builder.
`SyntheticKey`	`addPrimaryKey()` Add a primary key to be built.
`SyntheticProperty`	`addProperty(String name, Class type)` Add a property to the set managed by this builder.
`SyntheticProperty`	`addProperty(SyntheticProperty prop)` Add an externally defined synthetic property to the list
`Class<? extends Storable>`	`build()` Convenience method to generate the class.
`protected boolean`	`definePropertyBeanMethods(ClassFile cf, SyntheticProperty property)` Add the get & set methods for this property
`SyntheticBuilder.ClassNameProvider`	`getClassNameProvider()`
`protected String`	`getName()` Frequently used by the `SyntheticBuilder.ClassNameProvider` as a basis for the generated classname
`protected List<SyntheticProperty>`	`getPropertyList()` Frequently used by the `SyntheticBuilder.ClassNameProvider` as a basis for the generated classname
`Class<? extends Storable>`	`getStorableClass()`
`boolean`	`hasProperty(String name)` Check to see if a particular property has already been added to the list of properties to generate
`boolean`	`isVersioned()` Returns true if a property with the version attribute has been addded
`ClassFileBuilder`	`prepare()`
`void`	`setClassNameProvider(SyntheticBuilder.ClassNameProvider classNameProvider)`
`void`	`setEvolvable(boolean evolvable)` By default, generated storable implements the Unevolvable marker interface, which can affect how it is encoded.
`String`	`toString()`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

SyntheticStorableBuilder

public SyntheticStorableBuilder(String name,
                                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

prepare

public ClassFileBuilder prepare()
                         throws SupportException

Specified by:: prepare in interface SyntheticBuilder

Returns:: ClassFileBuilder ready for further decoration or building
Throws:: SupportException

getStorableClass

public 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.