org.datanucleus.api.jdo.metadata

Class JDOAnnotationReader

java.lang.Object

org.datanucleus.metadata.annotations.AbstractAnnotationReader

org.datanucleus.api.jdo.metadata.JDOAnnotationReader

All Implemented Interfaces:

org.datanucleus.metadata.annotations.AnnotationReader

public class JDOAnnotationReader
extends org.datanucleus.metadata.annotations.AbstractAnnotationReader

Implementation for Annotation Reader for java annotations using the JDO definition.

Field Summary

Fields inherited from class org.datanucleus.metadata.annotations.AbstractAnnotationReader

LOCALISER, mgr, supportedPackages

Constructor Summary

Constructors

Constructor and Description
JDOAnnotationReader(org.datanucleus.metadata.MetaDataManager mgr) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	doesClassHaveNamedQueries(Class cls) Check if class has Query annotations (for classes that are not persistable but provide named query definitions.
protected boolean	isClassPersistenceAware(Class cls) Check if class is persistence aware, by looking at annotations
protected org.datanucleus.metadata.annotations.AnnotationObject	isClassPersistenceCapable(Class cls) Check if class is persistence capable, by looking at annotations
protected org.datanucleus.metadata.AbstractClassMetaData	processClassAnnotations(org.datanucleus.metadata.PackageMetaData pmd, Class cls, org.datanucleus.metadata.annotations.AnnotationObject[] annotations, org.datanucleus.ClassLoaderResolver clr) Method to process the "class" level annotations and create the outline ClassMetaData object.
protected org.datanucleus.metadata.AbstractMemberMetaData	processMemberAnnotations(org.datanucleus.metadata.AbstractClassMetaData cmd, org.datanucleus.metadata.annotations.Member member, org.datanucleus.metadata.annotations.AnnotationObject[] annotations, boolean propertyAccessor) Convenience method to process the annotations for a field/property.
protected void	processMethodAnnotations(org.datanucleus.metadata.AbstractClassMetaData cmd, Method method) Method to take the passed in outline ClassMetaData and process the annotations for method adding any necessary MetaData to the ClassMetaData.
protected void	processNamedQueries(org.datanucleus.metadata.AbstractClassMetaData cmd, Class cls, org.datanucleus.metadata.annotations.AnnotationObject[] annotations) Convenience method to process @Queries, @Query.

Methods inherited from class org.datanucleus.metadata.annotations.AbstractAnnotationReader

getAnnotationObjectsForAnnotations, getClassAnnotationsForClass, getFieldAnnotationsForClass, getJavaBeanAccessorAnnotationsForClass, getMetaDataForClass, getMethodAnnotationsForClass, getSupportedAnnotationPackages, isSupportedAnnotation, setSupportedAnnotationPackages

Methods inherited from class java.lang.Object

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

Constructor Detail

JDOAnnotationReader

public JDOAnnotationReader(org.datanucleus.metadata.MetaDataManager mgr)

Constructor.

Parameters:

mgr - MetaData manager

Method Detail

processClassAnnotations

protected org.datanucleus.metadata.AbstractClassMetaData processClassAnnotations(org.datanucleus.metadata.PackageMetaData pmd,
                                                                     Class cls,
                                                                     org.datanucleus.metadata.annotations.AnnotationObject[] annotations,
                                                                     org.datanucleus.ClassLoaderResolver clr)

Method to process the "class" level annotations and create the outline ClassMetaData object. Supports classes annotated with @PersistenceCapable, classes annotated with @PersistenceAware, and classes which have neither of those but have @Queries or @Query.

Specified by:

processClassAnnotations in class org.datanucleus.metadata.annotations.AbstractAnnotationReader

Parameters:

pmd - Parent PackageMetaData

cls - The class

annotations - Annotations for this class

clr - ClassLoader resolver

Returns:

The ClassMetaData/InterfaceMetaData (or null if no annotations)

processNamedQueries

protected void processNamedQueries(org.datanucleus.metadata.AbstractClassMetaData cmd,
                       Class cls,
                       org.datanucleus.metadata.annotations.AnnotationObject[] annotations)

Convenience method to process @Queries, @Query.

Parameters:

cmd - Metadata for the class, to which any queries will be added

annotations - Annotations specified on the class

processMemberAnnotations

protected org.datanucleus.metadata.AbstractMemberMetaData processMemberAnnotations(org.datanucleus.metadata.AbstractClassMetaData cmd,
                                                                       org.datanucleus.metadata.annotations.Member member,
                                                                       org.datanucleus.metadata.annotations.AnnotationObject[] annotations,
                                                                       boolean propertyAccessor)

Convenience method to process the annotations for a field/property. The passed annotations may have been specified on the field or on the getter methods.

Specified by:

processMemberAnnotations in class org.datanucleus.metadata.annotations.AbstractAnnotationReader

Parameters:

cmd - The ClassMetaData/InterfaceMetaData to update

member - The field/property

annotations - Annotations for the field/property

propertyAccessor - if there are properties for this class

Returns:

The FieldMetaData/PropertyMetaData that was added (if any)

processMethodAnnotations

protected void processMethodAnnotations(org.datanucleus.metadata.AbstractClassMetaData cmd,
                            Method method)

Method to take the passed in outline ClassMetaData and process the annotations for method adding any necessary MetaData to the ClassMetaData.

Specified by:

processMethodAnnotations in class org.datanucleus.metadata.annotations.AbstractAnnotationReader

Parameters:

cmd - The ClassMetaData/InterfaceMetaData (to be updated)

method - The method

isClassPersistenceCapable

protected org.datanucleus.metadata.annotations.AnnotationObject isClassPersistenceCapable(Class cls)

Check if class is persistence capable, by looking at annotations

Parameters:

cls - the Class

Returns:

The annotationObject for PersistenceCapable

isClassPersistenceAware

protected boolean isClassPersistenceAware(Class cls)

Check if class is persistence aware, by looking at annotations

Parameters:

cls - the Class

Returns:

true if the class has @PersistenceAware

doesClassHaveNamedQueries

protected boolean doesClassHaveNamedQueries(Class cls)

Check if class has Query annotations (for classes that are not persistable but provide named query definitions.

Parameters:

cls - the Class

Returns:

true if the class has Named query annotations