org.datanucleus.jdo.query

Class JDOQueryProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.datanucleus.jdo.query.JDOQueryProcessor

All Implemented Interfaces:

Processor

@SupportedAnnotationTypes(value="javax.jdo.annotations.PersistenceCapable")
public class JDOQueryProcessor
extends AbstractProcessor

Annotation processor for JDO to generate "dummy" classes for all persistable classes for use with the Typesafe Query API. Any class ({MyClass}) that has a JDO "class" annotation will have a stub class (Q{MyClass}) generated.

• For each managed class X in package p, a metamodel class QX in package p is created.
• The name of the metamodel class is derived from the name of the managed class by prepending "Q" to the name of the managed class.

This processor can generate classes in two modes.

• Property access - so users type in "field1()", "field1().field2()" etc. Specify the compiler argument "queryMode" as "PROPERTY" to get this
• Field access - so users type in "field1", "field1.field2". This is the default.

Field Summary

Fields

Modifier and Type	Field and Description
int	fieldDepth
static String	OPTION_MODE
int	queryMode

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
JDOQueryProcessor()

Method Summary

Modifier and Type	Method and Description
TypeElement	getPersistentSupertype(TypeElement element) Method to find the next persistent supertype above this one.
static String	getQueryClassNameForClassName(String name) Method to return the (simple) name of the query class for a specified class name.
SourceVersion	getSupportedSourceVersion()
void	init(ProcessingEnvironment pe)
boolean	isPersistableType(TypeElement el)
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
protected void	processClass(TypeElement el) Handler for processing a JDO annotated class to create the criteria class stub.

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedAnnotationTypes, getSupportedOptions, isInitialized

Methods inherited from class java.lang.Object

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

Field Detail

OPTION_MODE

public static final String OPTION_MODE

See Also:

Constant Field Values

queryMode

public int queryMode

fieldDepth

public int fieldDepth

Constructor Detail

JDOQueryProcessor

public JDOQueryProcessor()

Method Detail

init

public void init(ProcessingEnvironment pe)

Specified by:

init in interface Processor

Overrides:

init in class AbstractProcessor

process

public boolean process(Set<? extends TypeElement> annotations,
                       RoundEnvironment roundEnv)

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface Processor

Overrides:

getSupportedSourceVersion in class AbstractProcessor

processClass

protected void processClass(TypeElement el)

Handler for processing a JDO annotated class to create the criteria class stub.

Parameters:

el - The class element

isPersistableType

public boolean isPersistableType(TypeElement el)

getPersistentSupertype

public TypeElement getPersistentSupertype(TypeElement element)

Method to find the next persistent supertype above this one.

Parameters:

element - The element

Returns:

Its next parent that is persistable (or null if no persistable predecessors)

getQueryClassNameForClassName

public static String getQueryClassNameForClassName(String name)

Method to return the (simple) name of the query class for a specified class name. Currently just returns "Q{className}"

Parameters:

name - Simple name of the class (without package)

Returns:

Simple name of the query class