Package org.apache.cayenne.reflect
Class PersistentDescriptor
java.lang.Object
org.apache.cayenne.reflect.PersistentDescriptor
- All Implemented Interfaces:
ClassDescriptor
A default ClassDescriptor implementation for persistent objects.
- Since:
- 3.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Map<CayennePath,AdditionalDbEntityDescriptor> protected Collection<ObjAttribute>protected Map<String,PropertyDescriptor> protected ObjEntityprotected EntityInheritanceTreeprotected Expressionprotected Collection<AttributeProperty>protected Collection<ArcProperty>protected Class<?>protected Accessorprotected Map<String,PropertyDescriptor> protected Collection<DbEntity>protected Map<String,ClassDescriptor> protected ClassDescriptor -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddDeclaredProperty(PropertyDescriptor property) Registers a property.voidaddRootDbEntity(DbEntity dbEntity) Adds a root DbEntity to the list of roots, filtering duplicates.voidaddSubclassDescriptor(String entityName, ClassDescriptor subclassDescriptor) Adds a subclass descriptor that maps to a given class name.voidaddSuperProperty(PropertyDescriptor property) Registers a superclass property.Creates a new instance of a class described by this object.Returns information about additional db entities that is used for this ObjEntity (i.e.getDeclaredProperty(String propertyName) Returns a Java Bean property descriptor matching property name or null if no such property is found.Returns a collection of ObjAttribute for the described class, its superclasses and subclasses, that participate in inheritance qualifier.Returns an ObjEntity associated with this descriptor.Returns entity qualifier as a Cayenne expression that includes qualifiers for this entity and all subentities.Returns a collection of the properties mapped to id columns.Returns a collection over the arc properties whose reverse arcs are to-many maps.Class<?>Returns a class mapped by this descriptor.getProperty(String propertyName) Recursively looks up property descriptor in this class descriptor and all superclass descriptors.Returns a collection of DbEntities that are the root tables for this descriptor's ObjEntity.getSubclassDescriptor(String entityName) Returns the most "specialized" descriptor for a given entity name.Returns a descriptor of the mapped superclass or null if the descriptor's entity sits at the top of inheritance hierarchy.booleanReturns whether this class has persistent subclasses.voidinjectValueHolders(Object object) Invokes 'prepareForAccess' of a super descriptor and then invokes 'prepareForAccess' of each declared property.booleanReturns true if an object is not fully resolved.voidremoveDeclaredProperty(String propertyName) Removes declared property.voidsetDiscriminatorColumns(Collection<ObjAttribute> columns) voidvoidsetEntityInheritanceTree(EntityInheritanceTree entityInheritanceTree) voidsetEntityQualifier(Expression entityQualifier) voidsetPersistenceStateAccessor(Accessor persistenceStateAccessor) voidsetSuperclassDescriptor(ClassDescriptor superclassDescriptor) voidshallowMerge(Object from, Object to) Copies object properties from one object to another.booleanvisitAllProperties(PropertyVisitor visitor) Passes the visitor to the properties "visit" method for a combination of all properties, including properties declared in this descriptor, its super descriptors, and all subdescriptors.booleanvisitDeclaredProperties(PropertyVisitor visitor) Passes the visitor to the properties "visit" method for all properties declared in this descriptor.booleanvisitProperties(PropertyVisitor visitor) Passes the visitor to the properties "visit" method for all properties declared in this descriptor and all its super-decsriptors.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.cayenne.reflect.ClassDescriptor
getSubclassDescriptor
-
Field Details
-
superclassDescriptor
-
objectClass
-
declaredProperties
-
properties
-
subclassDescriptors
-
persistenceStateAccessor
-
entity
-
rootDbEntities
-
additionalDbEntities
-
entityInheritanceTree
-
idProperties
-
mapArcProperties
-
allDiscriminatorColumns
-
entityQualifier
-
-
Constructor Details
-
PersistentDescriptor
public PersistentDescriptor()Creates a PersistentDescriptor.
-
-
Method Details
-
setDiscriminatorColumns
-
addSuperProperty
Registers a superclass property. -
addDeclaredProperty
Registers a property. This method is useful to customize default ClassDescriptor generated from ObjEntity by adding new properties or overriding the standard ones. -
addRootDbEntity
Adds a root DbEntity to the list of roots, filtering duplicates. -
removeDeclaredProperty
Removes declared property. This method can be used to customize default ClassDescriptor generated from ObjEntity. -
addSubclassDescriptor
Adds a subclass descriptor that maps to a given class name. -
getEntity
Description copied from interface:ClassDescriptorReturns an ObjEntity associated with this descriptor.- Specified by:
getEntityin interfaceClassDescriptor
-
getRootDbEntities
Description copied from interface:ClassDescriptorReturns a collection of DbEntities that are the root tables for this descriptor's ObjEntity. Usually such collection would contain only one entity, however in cases involving subclass horizontal inheritance, it will be more than one, and in cases of abstract entities with no subclasses, the collection will be empty.- Specified by:
getRootDbEntitiesin interfaceClassDescriptor
-
getAdditionalDbEntities
Description copied from interface:ClassDescriptorReturns information about additional db entities that is used for this ObjEntity (i.e. for flattened attributes).Keys are full paths for corresponding flattened attributes.
- Specified by:
getAdditionalDbEntitiesin interfaceClassDescriptor- Returns:
- information about additional db entities
-
isFault
Description copied from interface:ClassDescriptorReturns true if an object is not fully resolved.- Specified by:
isFaultin interfaceClassDescriptor
-
getObjectClass
Description copied from interface:ClassDescriptorReturns a class mapped by this descriptor.- Specified by:
getObjectClassin interfaceClassDescriptor
-
getSubclassDescriptor
Description copied from interface:ClassDescriptorReturns the most "specialized" descriptor for a given entity name.- Specified by:
getSubclassDescriptorin interfaceClassDescriptor
-
getDiscriminatorColumns
Description copied from interface:ClassDescriptorReturns a collection of ObjAttribute for the described class, its superclasses and subclasses, that participate in inheritance qualifier. If a discriminator expression specifies a DbAttribute instead of an ObjAttribute, a synthetic ObjAttribute is created and returned.- Specified by:
getDiscriminatorColumnsin interfaceClassDescriptor
-
getIdProperties
Description copied from interface:ClassDescriptorReturns a collection of the properties mapped to id columns.- Specified by:
getIdPropertiesin interfaceClassDescriptor
-
getMapArcProperties
Description copied from interface:ClassDescriptorReturns a collection over the arc properties whose reverse arcs are to-many maps. I.e. for each ArcProperty in returned collection, the following is true:arc.getComplimentaryReverseArc() instanceof ToManyMapProperty
- Specified by:
getMapArcPropertiesin interfaceClassDescriptor
-
getProperty
Recursively looks up property descriptor in this class descriptor and all superclass descriptors.- Specified by:
getPropertyin interfaceClassDescriptor
-
getDeclaredProperty
Description copied from interface:ClassDescriptorReturns a Java Bean property descriptor matching property name or null if no such property is found. Lookup DOES NOT including properties from the superclass descriptors. Returned property can be any one ofAttributeProperty,ToManyProperty,ToOneProperty.- Specified by:
getDeclaredPropertyin interfaceClassDescriptor
-
getSuperclassDescriptor
Returns a descriptor of the mapped superclass or null if the descriptor's entity sits at the top of inheritance hierarchy.- Specified by:
getSuperclassDescriptorin interfaceClassDescriptor
-
createObject
Creates a new instance of a class described by this object.- Specified by:
createObjectin interfaceClassDescriptor
-
injectValueHolders
Invokes 'prepareForAccess' of a super descriptor and then invokes 'prepareForAccess' of each declared property.- Specified by:
injectValueHoldersin interfaceClassDescriptor- Throws:
PropertyException
-
shallowMerge
Copies object properties from one object to another. Invokes 'shallowCopy' of a super descriptor and then invokes 'shallowCopy' of each declared property.- Specified by:
shallowMergein interfaceClassDescriptor- Throws:
PropertyException
-
visitDeclaredProperties
Description copied from interface:ClassDescriptorPasses the visitor to the properties "visit" method for all properties declared in this descriptor. This property set excludes inherited properties, even those that got overridden in this subclass. Walkthrough is terminated in case one of the properties returns false. Returns true if all visited properties returned true, false - if one property returned false.- Specified by:
visitDeclaredPropertiesin interfaceClassDescriptor- Since:
- 3.0
-
visitAllProperties
Description copied from interface:ClassDescriptorPasses the visitor to the properties "visit" method for a combination of all properties, including properties declared in this descriptor, its super descriptors, and all subdescriptors. Walkthrough is terminated in case one of the properties returns false. Returns true if all visited properties returned true, false - if one property returned false.- Specified by:
visitAllPropertiesin interfaceClassDescriptor- Since:
- 3.0
-
visitProperties
Description copied from interface:ClassDescriptorPasses the visitor to the properties "visit" method for all properties declared in this descriptor and all its super-decsriptors. Properties that are overridden in subdescriptors will include overridden information. Walkthrough is terminated in case one of the properties returns false. Returns true if all visited properties returned true, false - if one property returned false.- Specified by:
visitPropertiesin interfaceClassDescriptor
-
setPersistenceStateAccessor
-
setEntity
-
setSuperclassDescriptor
-
getEntityQualifier
Description copied from interface:ClassDescriptorReturns entity qualifier as a Cayenne expression that includes qualifiers for this entity and all subentities.- Specified by:
getEntityQualifierin interfaceClassDescriptor
-
setEntityQualifier
-
getEntityInheritanceTree
- Specified by:
getEntityInheritanceTreein interfaceClassDescriptor
-
setEntityInheritanceTree
-
hasSubclasses
public boolean hasSubclasses()Description copied from interface:ClassDescriptorReturns whether this class has persistent subclasses.- Specified by:
hasSubclassesin interfaceClassDescriptor
-