Beans Module

Bean Module

The Bean Module contains the following classes:-

  • com.javelin.generator.beans.AbstractBeanWriter
  • com.javelin.generator.beans.BeanInterfaceWriter
  • com.javelin.generator.beans.BeanClassWriter
  • com.javelin.generator.beans.LazyBeanClassWriter
  • com.javelin.generator.beans.EnumeratedTypeWriter
  • com.javelin.generator.beans.ValidatorClassWriter
  • com.javelin.generator.beans.SessionInterfaceWriter
  • com.javelin.generator.beans.HomeInterfaceWriter
  • com.javelin.generator.beans.KeyClassWriter
  • com.javelin.generator.beans.ObjectClassWriter
  • com.javelin.generator.beans.ClassContextWriter

In order to use the Bean module you need to include the following writer:

$GENERATOR.AggregateWriter bean

 

Class Hierarchy

The top-level BeanWriter class hierarchy is illustrated below: -

 

Abstract Bean Writer (com.javelin.generator.beans.AbstractBeanWriter)

The abstract Bean Writer class is a utility method that all the BeanWriter classes extend. It contains a number of naming methods that are useful to the writers: -

  • public String getHomeInterfaceName()
  • public String getSessionInterfaceName()
  • public String getValidatorClassName()
  • public String getBeanClassName()
  • public String getLazyBeanClassName()
  • public String getKeyClassName()

BeanWriters have also have the following methods to help the writers understand their context: -

  • public String getInterfaceName() - get the JBeans interface name.
  • public boolean isInterface() - is this an Interface writer.

Bean Interface Writer(com.javelin.generator.beans.BeanInterfaceWriter)

The Bean Interface Writer writes the basic Bean interface that all Beans of that type must adhere to, and itself adheres to the Beans and JBeans standards.

By default the classes generated have the name and pattern: -

$INTERFACE=public interface $PACKAGE.$THIS extends $BEANS.Bean java.lang.Cloneable

Bean Class Writer(com.javelin.generator.beans.BeanClassWriter)

The Bean Class Writer writes a fully functional Bean that adheres to the Beans and JBeans standards. A full description of the Bean is described below.

By default the classes generated have the name and pattern: -

$BEANCLASS=public class $PACKAGE.$THIS extends $BEANS.AbstractBean implements $PACKAGE

Lazy Bean Class Writer(com.javelin.generator.beans.BeanClassWriter)

The Lazy Bean classes extend the normal Bean class. The added functionality is that when the Bean is loaded from its persisted state any foreign primary keys are set on the Lazy Bean. Then when it comes to get the Foreign Bean the Lazy bean class loads up the Foreign bean form the foreign beans Context. The foreign bean is then set on the parent Bean class, as if it had been loaded all the time.

The Lazy Bean class is used by the Jdbc and CJB Contexts.

By default the classes generated have the name and pattern: -

$LAZYBEAN=public class $PACKAGE.lazy.$THIS extends $PACKAGE

Enumerated Type Writer(com.javelin.generator.beans.EnumeratedTypeWriter)

The EnumeratedTypeWrite is used for writing out EnumeratedTypes.

By default the classes generated have the name and pattern: -

$ENUMERATEDTYPE=public class $PACKAGE.$THIS extends $BEANS.AbstractEnumeratedType

Object Class Writer(com.javelin.generator.beans.ObjectClassWriter)

The Object Class Writer is used to create simple objects based on a tables properties.

By default the classes generated have the name and pattern: -

$OBJECTINTERFACE=public interface $PACKAGE.$THIS

Session Interface Writer(com.javelin.generator.beans.SessionInterfaceWriter)

The Session Interface Writer is used to write out JBeans Session Interfaces.

By default the classes generated have the name and pattern: -

$SESSION=public interface $PACKAGE.$THIS extends $BEANS.BeanSession

Home Interface Writer(com.javelin.generator.beans.HomeInterfaceWriter)

The Home Interface Writer is used to write out JBeans Home Interfaces.

By default the classes generated have the name and pattern: -

$HOME=public interface $PACKAGE.$THIS extends $BEANS.BeanHome

Validator Class Writer(com.javelin.generator.beans.ValidatorClassWriter)

The Validator Class Writer is used to write outValidation Classes.

By default the classes generated have the name and pattern: -

$VALIDATOR=public class $PACKAGE.$THIS extends $BEANS.AbstractBeanValidator

Key Class Writer(com.javelin.generator.beans.KeyClassWriter)

The Key Class Writer is used to write out Compound Primary Key Classes.

By default the classes generated have the name and pattern: -

$KEYCLASS=public class $PACKAGE.$THIS implements java.io.Serializable