org.noorm.metadata

Class BeanMetaDataUtil

java.lang.Object

org.noorm.metadata.BeanMetaDataUtil

public class BeanMetaDataUtil
extends Object

Convenience class to provide access to Bean metadata. Other classes and functionalities like the BeanMapper require metadata information about the Bean, in particular information about the non-transient fields, which are annotated with the JDBCColumn annotation. Since declared fields and annotations are determined at compile time, they are cached here to improve performance.

Author:

Ulf Pietruschka / ulf.pietruschka@etenso.com Date: 26.07.11 Time: 11:37

Field Summary

Fields

Modifier and Type	Field and Description
static String	NOT_NULLABLE
static String	NOT_UPDATABLE
static String	SERIAL_VERSION_UID

Constructor Summary

Constructors

Constructor and Description
BeanMetaDataUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static Object	getBeanPropertyByName(Object pObject, String pPropertyName)
static Class	getBeanPropertyType(Object pObject, String pPropertyName)
static Map<String,JDBCColumn>	getColumnMetaData(Class pClass) Returns a Map containing a mapping from the Bean attribute names to their JDBCColumn annotations.
static Field[]	getDeclaredFieldsInclParent(Class pClass) Using Class.getDeclaredFields does not return fields declared in a potentially existing super-class.
static JDBCColumn	getJDBCColumnAnnotation(Field pField) Returns the annotations for a given field.
static Long	getPrimaryKeyValue(IBean pBean) Retrieves the value of the (primary) key of the bean passed to this method.
static void	setPrimaryKeyValue(IBean pBean, Number pPKValue) Sets the value of the (primary) key of the bean passed to this method.
static void	setVersionColumnValue(IBean pBean, Object pVersionColumnValue) Sets the value of the version column of the bean passed to this method.

Methods inherited from class java.lang.Object

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

Field Detail

NOT_UPDATABLE

public static final String NOT_UPDATABLE

See Also:

Constant Field Values

NOT_NULLABLE

public static final String NOT_NULLABLE

See Also:

Constant Field Values

SERIAL_VERSION_UID

public static final String SERIAL_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

BeanMetaDataUtil

public BeanMetaDataUtil()

Method Detail

getDeclaredFieldsInclParent

public static Field[] getDeclaredFieldsInclParent(Class pClass)

Using Class.getDeclaredFields does not return fields declared in a potentially existing super-class. This method extends the retrieval of declared fields to the super-class, if any. Note that there is no recursive mechanism to detect declarations of the super-class of the super-class.

Parameters:

pClass -

Returns:

all declared fields of the provided class and its super-class, if any.

getJDBCColumnAnnotation

public static JDBCColumn getJDBCColumnAnnotation(Field pField)

Returns the annotations for a given field. The results are stored in a local cache, since method Field.getDeclaredAnnotations has a VERY BAD performance.

Parameters:

pField - the field

Returns:

the annotations for the given field

getColumnMetaData

public static Map<String,JDBCColumn> getColumnMetaData(Class pClass)

Returns a Map containing a mapping from the Bean attribute names to their JDBCColumn annotations.

Parameters:

pClass - the Bean type

Returns:

a map containing all columns, resp. fields with their associated JDBCColumn.

getPrimaryKeyValue

public static Long getPrimaryKeyValue(IBean pBean)

Retrieves the value of the (primary) key of the bean passed to this method. The data is retrieved by reflection based on the bean metadata provided by the bean itself.

Parameters:

pBean - the bean instance.

Returns:

the primary key value for the passed bean.

getBeanPropertyType

public static Class getBeanPropertyType(Object pObject,
                        String pPropertyName)

getBeanPropertyByName

public static Object getBeanPropertyByName(Object pObject,
                           String pPropertyName)

setPrimaryKeyValue

public static void setPrimaryKeyValue(IBean pBean,
                      Number pPKValue)

Sets the value of the (primary) key of the bean passed to this method. The data is set by reflection based on the bean metadata provided by the bean itself.

Parameters:

pBean - the bean instance.

pPKValue - the value of the primary key.

setVersionColumnValue

public static void setVersionColumnValue(IBean pBean,
                         Object pVersionColumnValue)

Sets the value of the version column of the bean passed to this method. The data is set by reflection based on the bean metadata provided by the bean itself.

Parameters:

pBean - the bean instance.

pVersionColumnValue - the value of the version column.