org.hibernate.tool.enhance

Class EnhancementTask

java.lang.Object

Task

org.hibernate.tool.enhance.EnhancementTask

All Implemented Interfaces:

EnhancementContext

Direct Known Subclasses:

InstrumentTask

public class EnhancementTask
extends Task
implements EnhancementContext

Ant task for performing build-time enhancement of entities and component/embeddable classes.

IMPL NOTE : currently makes numerous assumptions, the most "horrific" being that all entities are annotated @Entity which precludes hbm.xml mappings as well as complete orm.xml mappings. This is just a PoC though...

Author:

Steve Ebersole

See Also:

Managed

Constructor Summary

Constructors

Constructor and Description
EnhancementTask()

Method Summary

Modifier and Type	Method and Description
void	addFileset(FileSet set)
boolean	doBiDirectionalAssociationManagement(javassist.CtField field) Should we manage association of bi-directional persistent attributes for this field?
boolean	doDirtyCheckingInline(javassist.CtClass classDescriptor) Should we in-line dirty checking for persistent attributes for this class?
boolean	doExtendedEnhancement(javassist.CtClass classDescriptor) Should we enhance field access to entities from this class?
void	execute()
ClassLoader	getLoadingClassLoader() Obtain access to the ClassLoader that can be used to load Class references.
boolean	hasLazyLoadableAttributes(javassist.CtClass classDescriptor) Does the given class define any lazy loadable attributes?
boolean	isCompositeClass(javassist.CtClass classDescriptor) Does the given class name represent an embeddable/component class?
boolean	isEntityClass(javassist.CtClass classDescriptor) Does the given class descriptor represent a entity class?
boolean	isLazyLoadable(javassist.CtField field) Determine if a field is lazy loadable.
boolean	isMappedCollection(javassist.CtField field)
boolean	isPersistentField(javassist.CtField ctField) Does the field represent persistent state? Persistent fields will be "enhanced".
javassist.CtField[]	order(javassist.CtField[] persistentFields) For fields which are persistent (according to EnhancementContext.isPersistentField(javassist.CtField)), determine the corresponding ordering maintained within the Hibernate metamodel.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnhancementTask

public EnhancementTask()

Method Detail

addFileset

public void addFileset(FileSet set)

execute

public void execute()
             throws BuildException

Throws:

BuildException

getLoadingClassLoader

public ClassLoader getLoadingClassLoader()

Description copied from interface: EnhancementContext

Obtain access to the ClassLoader that can be used to load Class references. In JPA SPI terms, this should be a "temporary class loader" as defined by PersistenceUnitInfo.getNewTempClassLoader()

Specified by:

getLoadingClassLoader in interface EnhancementContext

Returns:

The class loader that the enhancer can use.

isEntityClass

public boolean isEntityClass(javassist.CtClass classDescriptor)

Description copied from interface: EnhancementContext

Does the given class descriptor represent a entity class?

Specified by:

isEntityClass in interface EnhancementContext

Parameters:

classDescriptor - The descriptor of the class to check.

Returns:

true if the class is an entity; false otherwise.

isCompositeClass

public boolean isCompositeClass(javassist.CtClass classDescriptor)

Description copied from interface: EnhancementContext

Does the given class name represent an embeddable/component class?

Specified by:

isCompositeClass in interface EnhancementContext

Parameters:

classDescriptor - The descriptor of the class to check.

Returns:

true if the class is an embeddable/component; false otherwise.

doBiDirectionalAssociationManagement

public boolean doBiDirectionalAssociationManagement(javassist.CtField field)

Description copied from interface: EnhancementContext

Should we manage association of bi-directional persistent attributes for this field?

Specified by:

doBiDirectionalAssociationManagement in interface EnhancementContext

Parameters:

field - The field to check.

Returns:

true indicates that the field is enhanced so that for bi-directional persistent fields the association is managed, i.e. the associations are automatically set; false indicates that the management is handled by the user.

doDirtyCheckingInline

public boolean doDirtyCheckingInline(javassist.CtClass classDescriptor)

Description copied from interface: EnhancementContext

Should we in-line dirty checking for persistent attributes for this class?

Specified by:

doDirtyCheckingInline in interface EnhancementContext

Parameters:

classDescriptor - The descriptor of the class to check.

Returns:

true indicates that dirty checking should be in-lined within the entity; false indicates it should not. In-lined is more easily serializable and probably more performant.

doExtendedEnhancement

public boolean doExtendedEnhancement(javassist.CtClass classDescriptor)

Description copied from interface: EnhancementContext

Should we enhance field access to entities from this class?

Specified by:

doExtendedEnhancement in interface EnhancementContext

Parameters:

classDescriptor - The descriptor of the class to check.

Returns:

true indicates that any direct access to fields of entities should be routed to the enhanced getter / setter method.

hasLazyLoadableAttributes

public boolean hasLazyLoadableAttributes(javassist.CtClass classDescriptor)

Description copied from interface: EnhancementContext

Does the given class define any lazy loadable attributes?

Specified by:

hasLazyLoadableAttributes in interface EnhancementContext

Parameters:

classDescriptor - The class to check

Returns:

true/false

isLazyLoadable

public boolean isLazyLoadable(javassist.CtField field)

Description copied from interface: EnhancementContext

Determine if a field is lazy loadable.

Specified by:

isLazyLoadable in interface EnhancementContext

Parameters:

field - The field to check

Returns:

true if the field is lazy loadable; false otherwise.

isPersistentField

public boolean isPersistentField(javassist.CtField ctField)

Description copied from interface: EnhancementContext

Does the field represent persistent state? Persistent fields will be "enhanced".

may be better to perform basic checks in the caller (non-static, etc) and call out with just the Class name and field name...

Specified by:

isPersistentField in interface EnhancementContext

Parameters:

ctField - The field reference.

Returns:

true if the field is ; false otherwise.

isMappedCollection

public boolean isMappedCollection(javassist.CtField field)

Specified by:

isMappedCollection in interface EnhancementContext

Parameters:

field - the field to check

Returns:

true if the field is mapped

order

public javassist.CtField[] order(javassist.CtField[] persistentFields)

Description copied from interface: EnhancementContext

For fields which are persistent (according to EnhancementContext.isPersistentField(javassist.CtField)), determine the corresponding ordering maintained within the Hibernate metamodel.

Specified by:

order in interface EnhancementContext

Parameters:

persistentFields - The persistent field references.

Returns:

The ordered references.