Package org.apache.empire.data.bean

Class BeanClass

java.lang.Object

org.apache.empire.data.bean.BeanClass

All Implemented Interfaces:

Entity

public abstract class BeanClass
extends Object
implements Entity

BeanObject This class defines Metadata for any type of java class. For each class you want to describe create one Metadata class and derive it from BeanClass. A metadata definition consists primarily of the class name and a list of properties.

Author:

Rainer

Field Summary

Fields

Modifier and Type	Field	Description
protected BeanDomain	domain

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BeanClass(String name)
protected	BeanClass(String name, BeanDomain dom)

Method Summary

Modifier and Type	Method	Description
protected final BeanProperty	addProp(String propname, DataType dataType, double size, boolean required)
protected final BeanProperty	addProp(String propname, DataType dataType, double size, boolean required, boolean readOnly)
protected final BeanProperty	addProp(String propname, DataType dataType, double size, boolean required, String controlType)
protected BeanProperty	addProp(String propname, DataType dataType, double size, boolean required, String controlType, boolean readOnly)
protected void	addProp(BeanProperty prop)
List<BeanProperty>	getColumns()	returns the list of key columns (if any)
BeanDomain	getDomain()	returns the domain this class belongs to (if any)
String	getEntityName()	returns the name of this class
Column[]	getKeyColumns()	returns the list of key columns (if any)
List<BeanProperty>	getProperties()	returns the list of properties for this class.
protected final void	setKeyColumn(Column keyColumn)	Sets the key to a single column
protected void	setKeyColumns(Column[] keyColumns)	Sets the list of key columns.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.empire.data.Entity

getBeanType, getColumn

Field Details

domain

protected BeanDomain domain

Constructor Details

BeanClass

protected BeanClass(String name)

BeanClass

protected BeanClass(String name,
 BeanDomain dom)

Method Details

addProp

protected void addProp(BeanProperty prop)

addProp

protected BeanProperty addProp(String propname,
 DataType dataType,
 double size,
 boolean required,
 String controlType,
 boolean readOnly)

addProp

protected final BeanProperty addProp(String propname,
 DataType dataType,
 double size,
 boolean required,
 String controlType)

addProp

protected final BeanProperty addProp(String propname,
 DataType dataType,
 double size,
 boolean required,
 boolean readOnly)

addProp

protected final BeanProperty addProp(String propname,
 DataType dataType,
 double size,
 boolean required)

setKeyColumns

protected void setKeyColumns(Column[] keyColumns)

Sets the list of key columns.

Parameters:

keyColumns - the list of key columns.

setKeyColumn

protected final void setKeyColumn(Column keyColumn)

Sets the key to a single column

Parameters:

keyColumn - the key column

getEntityName

public String getEntityName()

returns the name of this class

Specified by:

getEntityName in interface Entity

Returns:

the class name

getColumns

public List<BeanProperty> getColumns()

returns the list of key columns (if any)

Specified by:

getColumns in interface Entity

Returns:

the list of key columns or null.

getKeyColumns

public Column[] getKeyColumns()

returns the list of key columns (if any)

Specified by:

getKeyColumns in interface Entity

Returns:

the list of key columns or null.

getProperties

public List<BeanProperty> getProperties()

returns the list of properties for this class.

Returns:

the list of properties for this class.

getDomain

public BeanDomain getDomain()

returns the domain this class belongs to (if any)

Returns:

the domain this class belongs to or null.