|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.cayenne.reflect.PersistentDescriptor
public class PersistentDescriptor
A default ClassDescriptor implementation for persistent objects.
| Field Summary | |
|---|---|
protected Collection<DbAttribute> |
allDiscriminatorColumns
|
protected Map<String,Property> |
declaredProperties
|
protected ObjEntity |
entity
|
protected Expression |
entityQualifier
|
protected Collection<Property> |
idProperties
|
protected Collection<ArcProperty> |
mapArcProperties
|
protected Class<?> |
objectClass
|
protected Accessor |
persistenceStateAccessor
|
protected Collection<DbEntity> |
rootDbEntities
|
protected Map<String,ClassDescriptor> |
subclassDescriptors
|
protected ClassDescriptor |
superclassDescriptor
|
protected Map<String,Property> |
superProperties
|
| Constructor Summary | |
|---|---|
PersistentDescriptor()
Creates a PersistentDescriptor. |
|
| Method Summary | |
|---|---|
void |
addDeclaredProperty(Property property)
Registers a property. |
void |
addRootDbEntity(DbEntity dbEntity)
Adds a root DbEntity to the list of roots, filtering duplicates. |
void |
addSubclassDescriptor(String className,
ClassDescriptor subclassDescriptor)
Adds a subclass descriptor that maps to a given class name. |
void |
addSuperProperty(Property property)
Registers a superclass property. |
Object |
createObject()
Creates a new instance of a class described by this object. |
Property |
getDeclaredProperty(String propertyName)
Returns a Java Bean property descriptor matching property name or null if no such property is found. |
Iterator<DbAttribute> |
getDiscriminatorColumns()
Returns a collection of DbAttributes for the described class, its superclasses and subclasses, that participate in inheritance qualifier, but are not mapped as object properties. |
ObjEntity |
getEntity()
Returns an ObjEntity associated with this descriptor. |
Expression |
getEntityQualifier()
Returns entity qualifier as a Cayenne expression that includes qualifiers for this entity and all subentities. |
Iterator<Property> |
getIdProperties()
Returns an iterator over the properties mapped to id columns. |
Iterator<ArcProperty> |
getMapArcProperties()
Returns an iterator over the arc properties whose reverse arcs are to-many maps. |
Class<?> |
getObjectClass()
Returns a class mapped by this descriptor. |
Iterator<Property> |
getProperties()
Deprecated. since 3.0. Use visitProperties(PropertyVisitor) method
instead. |
Property |
getProperty(String propertyName)
Recursively looks up property descriptor in this class descriptor and all superclass descriptors. |
Collection<DbEntity> |
getRootDbEntities()
Returns a collection of DbEntities that are the root tables for this descriptor's ObjEntity. |
ClassDescriptor |
getSubclassDescriptor(Class<?> objectClass)
Returns the most "specialized" descriptor for a given class. |
ClassDescriptor |
getSuperclassDescriptor()
Returns a descriptor of the mapped superclass or null if the descriptor's entity sits at the top of inheritance hierarchy. |
void |
injectValueHolders(Object object)
Invokes 'prepareForAccess' of a super descriptor and then invokes 'prepareForAccess' of each declared property. |
boolean |
isFault(Object object)
Returns true if an object is not fully resolved. |
void |
removeDeclaredProperty(String propertyName)
Removes declared property. |
void |
setDiscriminatorColumns(Collection<DbAttribute> columns)
|
void |
setEntity(ObjEntity entity)
|
void |
setEntityQualifier(Expression entityQualifier)
|
void |
setPersistenceStateAccessor(Accessor persistenceStateAccessor)
|
void |
setSuperclassDescriptor(ClassDescriptor superclassDescriptor)
|
void |
shallowMerge(Object from,
Object to)
Copies object properties from one object to another. |
boolean |
visitAllProperties(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. |
boolean |
visitDeclaredProperties(PropertyVisitor visitor)
Passes the visitor to the properties "visit" method for all properties declared in this descriptor. |
boolean |
visitProperties(PropertyVisitor visitor)
Passes the visitor to the properties "visit" method for all properties declared in this descriptor and all its subdescriptors. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected ClassDescriptor superclassDescriptor
protected Class<?> objectClass
protected Map<String,Property> declaredProperties
protected Map<String,Property> superProperties
protected Map<String,ClassDescriptor> subclassDescriptors
protected Accessor persistenceStateAccessor
protected ObjEntity entity
protected Collection<DbEntity> rootDbEntities
protected Collection<Property> idProperties
protected Collection<ArcProperty> mapArcProperties
protected Collection<DbAttribute> allDiscriminatorColumns
protected Expression entityQualifier
| Constructor Detail |
|---|
public PersistentDescriptor()
| Method Detail |
|---|
public void setDiscriminatorColumns(Collection<DbAttribute> columns)
public void addSuperProperty(Property property)
public void addDeclaredProperty(Property property)
public void addRootDbEntity(DbEntity dbEntity)
public void removeDeclaredProperty(String propertyName)
public void addSubclassDescriptor(String className,
ClassDescriptor subclassDescriptor)
public ObjEntity getEntity()
ClassDescriptor
getEntity in interface ClassDescriptorpublic Collection<DbEntity> getRootDbEntities()
ClassDescriptor
getRootDbEntities in interface ClassDescriptorpublic boolean isFault(Object object)
ClassDescriptor
isFault in interface ClassDescriptorpublic Class<?> getObjectClass()
ClassDescriptor
getObjectClass in interface ClassDescriptorpublic ClassDescriptor getSubclassDescriptor(Class<?> objectClass)
ClassDescriptorthis.getObjectClass().isAssignableFrom(objectClass)
getSubclassDescriptor in interface ClassDescriptorpublic Iterator<Property> getProperties()
visitProperties(PropertyVisitor) method
instead.
ClassDescriptor
getProperties in interface ClassDescriptorpublic Iterator<DbAttribute> getDiscriminatorColumns()
ClassDescriptor
getDiscriminatorColumns in interface ClassDescriptorpublic Iterator<Property> getIdProperties()
ClassDescriptor
getIdProperties in interface ClassDescriptorpublic Iterator<ArcProperty> getMapArcProperties()
ClassDescriptorarc.getComplimentaryReverseArc() instanceof ToManyMapProperty
getMapArcProperties in interface ClassDescriptorpublic Property getProperty(String propertyName)
getProperty in interface ClassDescriptorpublic Property getDeclaredProperty(String propertyName)
ClassDescriptorAttributeProperty,
ToManyProperty, ToOneProperty.
getDeclaredProperty in interface ClassDescriptorpublic ClassDescriptor getSuperclassDescriptor()
getSuperclassDescriptor in interface ClassDescriptorpublic Object createObject()
createObject in interface ClassDescriptor
public void injectValueHolders(Object object)
throws PropertyException
injectValueHolders in interface ClassDescriptorPropertyException
public void shallowMerge(Object from,
Object to)
throws PropertyException
shallowMerge in interface ClassDescriptorPropertyExceptionpublic boolean visitDeclaredProperties(PropertyVisitor visitor)
ClassDescriptor
visitDeclaredProperties in interface ClassDescriptorpublic boolean visitAllProperties(PropertyVisitor visitor)
ClassDescriptor
visitAllProperties in interface ClassDescriptorpublic boolean visitProperties(PropertyVisitor visitor)
ClassDescriptor
visitProperties in interface ClassDescriptorpublic void setPersistenceStateAccessor(Accessor persistenceStateAccessor)
public void setEntity(ObjEntity entity)
public void setSuperclassDescriptor(ClassDescriptor superclassDescriptor)
public Expression getEntityQualifier()
ClassDescriptor
getEntityQualifier in interface ClassDescriptorpublic void setEntityQualifier(Expression entityQualifier)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||