|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ClassDescriptor
A runtime descriptor of an persistent class.
Method Summary | |
---|---|
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<ObjAttribute> |
getDiscriminatorColumns()
Returns a collection of ObjAttribute for the described class, its superclasses and subclasses, that participate in inheritance qualifier. |
ObjEntity |
getEntity()
Returns an ObjEntity associated with this descriptor. |
EntityInheritanceTree |
getEntityInheritanceTree()
|
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)
Returns a property descriptor matching property name, or null if no such property is found. |
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 or no inheritance is mapped. |
void |
injectValueHolders(Object object)
Prepares object properties for access. |
boolean |
isFault(Object object)
Returns true if an object is not fully resolved. |
void |
shallowMerge(Object from,
Object to)
Merges object properties from one object to another, avoiding traversal of the ArcProperties. |
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 super-decsriptors. |
Method Detail |
---|
ObjEntity getEntity()
Collection<DbEntity> getRootDbEntities()
EntityInheritanceTree getEntityInheritanceTree()
Class<?> getObjectClass()
ClassDescriptor getSuperclassDescriptor()
ClassDescriptor getSubclassDescriptor(Class<?> objectClass)
this.getObjectClass().isAssignableFrom(objectClass)
Object createObject()
void injectValueHolders(Object object) throws PropertyException
PropertyException
void shallowMerge(Object from, Object to) throws PropertyException
PropertyException
Property getProperty(String propertyName)
AttributeProperty
,
ToManyProperty
, ToOneProperty
.
Property getDeclaredProperty(String propertyName)
AttributeProperty
,
ToManyProperty
, ToOneProperty
.
Iterator<Property> getProperties()
visitProperties(PropertyVisitor)
method
instead.
Iterator<Property> getIdProperties()
Iterator<ObjAttribute> getDiscriminatorColumns()
Expression getEntityQualifier()
Iterator<ArcProperty> getMapArcProperties()
arc.getComplimentaryReverseArc() instanceof ToManyMapProperty
boolean visitProperties(PropertyVisitor visitor)
boolean visitDeclaredProperties(PropertyVisitor visitor)
boolean visitAllProperties(PropertyVisitor visitor)
boolean isFault(Object object)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |