org.progeeks.hibernate
Class HibernateAnnotations

java.lang.Object
  org.progeeks.hibernate.HibernateAnnotations

public class HibernateAnnotations
extends java.lang.Object

Class providing the annotations types for meta-class annotations that are used to configure Hibernate persistance for the meta-class. These annotations are used to generate the Hibernate mapping configuration so that a meta-class and its hibernate mapping can be defined in one place.

The annotation types are grouped in this file solely to help with readability of the XML meta-class configuration. Assuming that the XML file specifies the org.progeeks.hibernate package as an import, the annotations in this file are specified as such:

<annotation-hibernateAnnotations.ClassAnnotationType>

These annotation classes contain basic documentation describing the properties as they affect the generator (and how default values are determined for some of them). However, it does not attempt to document the function of the general Hibernate configuration. For that documentation, see the Hibernate documentation at http://www.hibernate.org

Version:

$Revision: 1.6 $

Author:

Paul Wisneskey

Nested Class Summary

static class	HibernateAnnotations.AccessPropertyType Enumerated property type defining the valid values for the id and property annotations' access properties.
static class	HibernateAnnotations.CascadePropertyType Enumerated property type defining the valid values for the map property annotation's cascade property.
static interface	HibernateAnnotations.CLASS_ANNOTATION_PROPERTIES Constants for all of the property names in a class annotation object.
static class	HibernateAnnotations.FetchPropertyType Enumerated property type defining the valid values for the map property annotation's fetch property.
static interface	HibernateAnnotations.ID_ANNOTATION_PROPERTIES Constants for all of the property names in a id annotation object.
static interface	HibernateAnnotations.KEY_PROPERTIES Constrants for all of the property names in a key object.
static class	HibernateAnnotations.LazyPropertyType Enumerated property type defining the valid values for the map property annotation's lazy property.
static interface	HibernateAnnotations.MAP_ANNOTATION_PROPERTIES Constants for all of the property names in a map annotation object.
static class	HibernateAnnotations.OptimisticLockingPropertyType Enumerated property type defining the valid values for the class annotation's optimisticLocking property.
static class	HibernateAnnotations.PolymorphismPropertyType Enumerated property type defining the valid values for the class annotation's poloymorphism property.
static interface	HibernateAnnotations.PROPERTY_ANNOTATION_PROPERTIES Constants for all of the property names in a property annotation object.
static class	HibernateAnnotations.UnsavedValuePropertyType Enumerated property type defining the valid values for the id annotation's unsavedValue property.

Field Summary

static java.lang.String	CLASS_ANNOTATION_META_CLASS Name of the meta-class used for the class annotation objects.
static AnnotationType	ClassAnnotationType Annotation type for the meta-class annotation that specifies that the meta-class is a persistent class.
static java.lang.String	ID_ANNOTATION_META_CLASS Name of the meta-class used for the id annotation objects.
static AnnotationType	IdAnnotationType Annotation type for the meta-class property annotation that defines a property as the primary key property column of the database.
static java.lang.String	KEY_META_CLASS Name of the meta-class used for the key configuration objects.
static java.lang.String	MAP_ANNOTATION_META_CLASS Name of the meta-class used for the map annotation objects.
static AnnotationType	MapAnnotationType Annotation type for the meta-class property annotation that defines a peristent collection property of the meta-class.
static java.lang.String	PROPERTY_ANNOTATION_META_CLASS Name of the meta-class used for the property annotation objects.
static AnnotationType	PropertyAnnotationType Annotation type for the meta-class property annotation that defines a persistent property of the meta-class.

Method Summary

static void

createHibernateAnnotationMetaClasses(MetaClassRegistry registry) Creates the meta-class for all of the Hibernate annotation meta-objects in the supplied registry.

Methods inherited from class java.lang.Object

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

Field Detail

ClassAnnotationType

public static final AnnotationType ClassAnnotationType

Annotation type for the meta-class annotation that specifies that the meta-class is a persistent class.

IdAnnotationType

public static final AnnotationType IdAnnotationType

Annotation type for the meta-class property annotation that defines a property as the primary key property column of the database.

PropertyAnnotationType

public static final AnnotationType PropertyAnnotationType

Annotation type for the meta-class property annotation that defines a persistent property of the meta-class.

MapAnnotationType

public static final AnnotationType MapAnnotationType

Annotation type for the meta-class property annotation that defines a peristent collection property of the meta-class.

CLASS_ANNOTATION_META_CLASS

public static final java.lang.String CLASS_ANNOTATION_META_CLASS

Name of the meta-class used for the class annotation objects.

See Also:

Constant Field Values

ID_ANNOTATION_META_CLASS

public static final java.lang.String ID_ANNOTATION_META_CLASS

Name of the meta-class used for the id annotation objects.

See Also:

Constant Field Values

PROPERTY_ANNOTATION_META_CLASS

public static final java.lang.String PROPERTY_ANNOTATION_META_CLASS

Name of the meta-class used for the property annotation objects.

See Also:

Constant Field Values

MAP_ANNOTATION_META_CLASS

public static final java.lang.String MAP_ANNOTATION_META_CLASS

Name of the meta-class used for the map annotation objects.

See Also:

Constant Field Values

KEY_META_CLASS

public static final java.lang.String KEY_META_CLASS

Name of the meta-class used for the key configuration objects. Key objects are used to the define the foreign key in a joined table.

See Also:

Constant Field Values

Method Detail

createHibernateAnnotationMetaClasses

public static void createHibernateAnnotationMetaClasses(MetaClassRegistry registry)

Creates the meta-class for all of the Hibernate annotation meta-objects in the supplied registry.