Class PersistentDescriptorFactory

java.lang.Object

org.apache.cayenne.reflect.PersistentDescriptorFactory

All Implemented Interfaces:

ClassDescriptorFactory

Direct Known Subclasses:

PersistentObjectDescriptorFactory

public abstract class PersistentDescriptorFactory
extends Object
implements ClassDescriptorFactory

A convenience superclass for ClassDescriptorFactory implementors.

Since:

3.0

Field Summary

Fields

Modifier and Type	Field	Description
protected ClassDescriptorMap	descriptorMap

Constructor Summary

Constructors

Constructor	Description
PersistentDescriptorFactory(ClassDescriptorMap descriptorMap)

Method Summary

Modifier and Type	Method	Description
protected Accessor	createAccessor(PersistentDescriptor descriptor, String propertyName, Class<?> propertyType)	Creates an accessor for the property.
protected void	createAttributeProperty(PersistentDescriptor descriptor, ObjAttribute attribute)
protected PersistentDescriptor	createDescriptor()
protected Accessor	createEmbeddableAccessor(EmbeddableDescriptor descriptor, String propertyName, Class<?> propertyType)	Creates an accessor for the property of the embeddable class.
protected EmbeddableDescriptor	createEmbeddableDescriptor(EmbeddedAttribute embeddedAttribute)	Creates a descriptor of the embedded property.
protected void	createEmbeddedAttributeProperty(PersistentDescriptor descriptor, EmbeddedAttribute embeddedAttribute, ObjAttribute attribute)
protected Accessor	createMapKeyAccessor(ObjRelationship relationship, ClassDescriptor targetDescriptor)	Creates an accessor to read a map key for a given relationship.
protected abstract void	createToManyCollectionProperty(PersistentDescriptor descriptor, ObjRelationship relationship)
protected abstract void	createToManyListProperty(PersistentDescriptor descriptor, ObjRelationship relationship)
protected abstract void	createToManyMapProperty(PersistentDescriptor descriptor, ObjRelationship relationship)
protected abstract void	createToManySetProperty(PersistentDescriptor descriptor, ObjRelationship relationship)
protected abstract void	createToOneProperty(PersistentDescriptor descriptor, ObjRelationship relationship)
protected ObjAttribute	discriminatorAttribute(PersistentDescriptor descriptor, Expression node)	Resolves an "obj:" or "db:" path node of an inheritance qualifier to an ObjAttribute of the descriptor's entity, synthesizing one for a DB column that has no ObjAttribute.
ClassDescriptor	getDescriptor(String entityName)	Returns a ClassDescriptor instance for a given symbolic entity name.
protected ClassDescriptor	getDescriptor(ObjEntity entity, Class<?> entityClass)
protected void	indexAdditionalDbEntities(PersistentDescriptor descriptor)
protected void	indexDiscriminatorValues(PersistentDescriptor descriptor)	Compiles the values that the entity's own qualifier pins its attributes to, i.e. the "attribute = value" comparisons in it, possibly joined by "and", for ClassDescriptor.injectDiscriminatorValues(Object).
protected void	indexQualifiers(PersistentDescriptor descriptor, EntityInheritanceTree inheritanceTree)
protected void	indexRootDbEntities(PersistentDescriptor descriptor, EntityInheritanceTree inheritanceTree)
protected void	indexSubclassDescriptors(PersistentDescriptor descriptor, EntityInheritanceTree inheritanceTree)
protected void	indexSuperclassProperties(PersistentDescriptor descriptor)	Adds superclass properties to the descriptor, applying proper overrides.

Methods inherited from class Object

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

Field Details

descriptorMap

protected ClassDescriptorMap descriptorMap

Constructor Details

PersistentDescriptorFactory

public PersistentDescriptorFactory(ClassDescriptorMap descriptorMap)

Method Details

getDescriptor

public ClassDescriptor getDescriptor(String entityName)

Description copied from interface: ClassDescriptorFactory

Returns a ClassDescriptor instance for a given symbolic entity name. Returns null if this factory doesn't support this type of entity.

Specified by:

getDescriptor in interface ClassDescriptorFactory

getDescriptor

protected ClassDescriptor getDescriptor(ObjEntity entity,
 Class<?> entityClass)

createDescriptor

protected PersistentDescriptor createDescriptor()

createAttributeProperty

protected void createAttributeProperty(PersistentDescriptor descriptor,
 ObjAttribute attribute)

createEmbeddedAttributeProperty

protected void createEmbeddedAttributeProperty(PersistentDescriptor descriptor,
 EmbeddedAttribute embeddedAttribute,
 ObjAttribute attribute)

createToOneProperty

protected abstract void createToOneProperty(PersistentDescriptor descriptor,
 ObjRelationship relationship)

createToManySetProperty

protected abstract void createToManySetProperty(PersistentDescriptor descriptor,
 ObjRelationship relationship)

createToManyMapProperty

protected abstract void createToManyMapProperty(PersistentDescriptor descriptor,
 ObjRelationship relationship)

createToManyListProperty

protected abstract void createToManyListProperty(PersistentDescriptor descriptor,
 ObjRelationship relationship)

createToManyCollectionProperty

protected abstract void createToManyCollectionProperty(PersistentDescriptor descriptor,
 ObjRelationship relationship)

indexSubclassDescriptors

protected void indexSubclassDescriptors(PersistentDescriptor descriptor,
 EntityInheritanceTree inheritanceTree)

indexRootDbEntities

protected void indexRootDbEntities(PersistentDescriptor descriptor,
 EntityInheritanceTree inheritanceTree)

indexQualifiers

protected void indexQualifiers(PersistentDescriptor descriptor,
 EntityInheritanceTree inheritanceTree)

discriminatorAttribute

protected ObjAttribute discriminatorAttribute(PersistentDescriptor descriptor,
 Expression node)

Resolves an "obj:" or "db:" path node of an inheritance qualifier to an ObjAttribute of the descriptor's entity, synthesizing one for a DB column that has no ObjAttribute. Returns null for any other node.

indexDiscriminatorValues

protected void indexDiscriminatorValues(PersistentDescriptor descriptor)

Compiles the values that the entity's own qualifier pins its attributes to, i.e. the "attribute = value" comparisons in it, possibly joined by "and", for ClassDescriptor.injectDiscriminatorValues(Object). Values are converted to the attribute Java type here, once.

indexSuperclassProperties

protected void indexSuperclassProperties(PersistentDescriptor descriptor)

Adds superclass properties to the descriptor, applying proper overrides.

indexAdditionalDbEntities

protected void indexAdditionalDbEntities(PersistentDescriptor descriptor)

createAccessor

protected Accessor createAccessor(PersistentDescriptor descriptor,
 String propertyName,
 Class<?> propertyType)
                           throws PropertyException

Creates an accessor for the property.

Throws:

PropertyException

createMapKeyAccessor

protected Accessor createMapKeyAccessor(ObjRelationship relationship,
 ClassDescriptor targetDescriptor)

Creates an accessor to read a map key for a given relationship.

createEmbeddableAccessor

protected Accessor createEmbeddableAccessor(EmbeddableDescriptor descriptor,
 String propertyName,
 Class<?> propertyType)

Creates an accessor for the property of the embeddable class.

createEmbeddableDescriptor

protected EmbeddableDescriptor createEmbeddableDescriptor(EmbeddedAttribute embeddedAttribute)

Creates a descriptor of the embedded property.