Method Summary |
|
public void | addCollectionDescriptor(CollectionDescriptor cod) Add a
CollectionDescriptor . |
public void | addExtentClass(Class newExtendClass) |
public void | addExtentClass(String newExtentClassName) |
public void | addExtentClassName(Class newExtendClass) |
public void | addFieldDescriptor(FieldDescriptor fld) adds a FIELDDESCRIPTOR to this ClassDescriptor. |
public void | addObjectReferenceDescriptor(ObjectReferenceDescriptor ord) Add a
ObjectReferenceDescriptor . |
public FieldDescriptor[] | getAllRwFields() Returns array of read/write FieldDescriptors. |
public ArrayList | getAttributeDescriptorsForPath(String aPath) |
public ArrayList | getAttributeDescriptorsForPath(String aPath, Map pathHints) return all AttributeDescriptors for the path
ie: partner.addresses.street returns a Collection of 3 AttributeDescriptors
(ObjectReferenceDescriptor, CollectionDescriptor, FieldDescriptor)
ie: partner.addresses returns a Collection of 2 AttributeDescriptors
(ObjectReferenceDescriptor, CollectionDescriptor)
Parameters: aPath - the cleaned path to the attribute Parameters: pathHints - a Map containing the class to be used for a segment or nullif no segment was used. |
public FieldDescriptor | getAutoIncrementField() Returns the first found autoincrement field
defined in this class descriptor. |
public FieldDescriptor[] | getAutoIncrementFields() |
public String | getBaseClass() |
public String | getClassNameOfObject() |
public Class | getClassOfObject() |
public CollectionDescriptor | getCollectionDescriptorByName(String name) |
public Vector | getCollectionDescriptors() Returns all defined
CollectionDescriptor for
this class descriptor. |
public List | getCollectionDescriptors(boolean withInherited) Returns all defined
CollectionDescriptor for
this class descriptor. |
public ValueContainer[] | getCurrentLockingValues(Object o) |
public DeleteProcedureDescriptor | getDeleteProcedure() Retrieve the descriptor for the delete procedure/function. |
public synchronized Vector | getExtentClassNames() |
public synchronized Vector | getExtentClasses() return all classes in this extent. |
public synchronized Class | getFactoryClass() Return factory class. |
public synchronized Method | getFactoryMethod() Return factory method. |
public FieldDescriptor[] | getFieldDescriptions() Returns array of all FieldDescriptors. |
public FieldDescriptor[] | getFieldDescriptor(boolean withInherited) Return an array of all
FieldDescriptor for this represented class, if
parameter withInherited is true all inherited descriptor
of declared super classes are included. |
public FieldDescriptor | getFieldDescriptorByIndex(int index) Returns the matching
FieldDescriptor . |
public FieldDescriptor | getFieldDescriptorByName(String name) Returns the matching
FieldDescriptor - only fields
of the current class will be scanned, to include fields defined
the the super-classes too, use method
ClassDescriptor.getFieldDescriptor(boolean) . |
public FieldDescriptor | getFieldDescriptorForPath(String aPath, Map pathHints) return the FieldDescriptor for the Attribute referenced in the path
the path may contain simple attribut names, functions and path expressions
using relationships
ie: name, avg(price), adress.street
Parameters: aPath - the path to the attribute Parameters: pathHints - a Map containing the class to be used for a segment or nullif no segment was used. |
public FieldDescriptor | getFieldDescriptorForPath(String aPath) |
public FieldDescriptor[] | getFieldDescriptorNonPk(boolean withInherited) Return an array of NON-PK
FieldDescriptor , if parameter withInherited
is true all inherited descriptor of declared super classes are included. |
public FieldDescriptor[] | getFieldDescriptorsInHeirarchy() |
public String | getFullTableName() |
public Vector | getIndexes() Gets the IndexDescriptors used for DDL generation. |
public synchronized Method | getInitializationMethod() Returns the initialization method for this descriptor or null if no
initialization method is defined. |
public InsertProcedureDescriptor | getInsertProcedure() Retrieve the descriptor for the insert procedure/function. |
public int | getIsolationLevel() returns the transaction isolation level to be used for this class. |
public FieldDescriptor[] | getLockingFields() |
public FieldDescriptor[] | getNonPkFields() |
public FieldDescriptor[] | getNonPkRwFields() Returns array of read/write non pk FieldDescriptors. |
public ObjectCacheDescriptor | getObjectCacheDescriptor() Returns the appropriate
ObjectCacheDescriptor or null if not specified. |
public ObjectReferenceDescriptor | getObjectReferenceDescriptorByName(String name) |
public Vector | getObjectReferenceDescriptors() Returns all defined
ObjectReferenceDescriptor . |
public List | getObjectReferenceDescriptors(boolean withInherited) Returns all defined
ObjectReferenceDescriptor . |
public FieldDescriptor | getOjbConcreteClassField() Returns the ojbConcreteClass field or null if none defined. |
public String | getPersistentFieldClassName() Get the used
org.apache.ojb.broker.metadata.fieldaccess.PersistentField implementation name. |
public FieldDescriptor[] | getPkFields() |
public synchronized Class | getProxyClass() Insert the method's description here. |
public String | getProxyClassName() Get the name of the proxy class. |
public int | getProxyPrefetchingLimit() |
public DescriptorRepository | getRepository() Gets the repository. |
public synchronized RowReader | getRowReader() Returns the
org.apache.ojb.broker.accesslayer.RowReader for this descriptor. |
public String | getRowReaderClassName() |
public String | getSchema() Gets the schema. |
public StatementsForClassIF | getStatementsForClass(ConnectionManagerIF conMan) |
public String | getSuperClass() Return the super class or null
if not declared in repository file. |
public ClassDescriptor | getSuperClassDescriptor() Answers the ClassDescriptor referenced by 'super' ReferenceDescriptor. |
public int | getSuperClassFieldRef() |
public SuperReferenceDescriptor | getSuperReference() Returns the
SuperReferenceDescriptor of this class or null
if none was used. |
public UpdateProcedureDescriptor | getUpdateProcedure() Retrieve the descriptor for the update procedure/function. |
public Constructor | getZeroArgumentConstructor() returns the zero argument constructor for the class represented by this class descriptor
or null if a zero argument constructor does not exist. |
public boolean | isAbstract() |
public boolean | isAcceptLocks() Returns acceptLocks. |
public boolean | isAlwaysRefresh() if true instances of this class are always refreshed
even if they are already in the cache. |
public boolean | isDynamicProxy() |
public boolean | isExtent() Insert the method's description here. |
public boolean | isInterface() Return true, if the described class is
an interface. |
public boolean | isLocking() |
public void | removeCollectionDescriptor(CollectionDescriptor cod) |
public void | removeExtentClass(String extentClassName) |
public boolean | removeFieldDescriptor(FieldDescriptor fld) |
public void | removeObjectReferenceDescriptor(ObjectReferenceDescriptor ord) |
public void | setAcceptLocks(boolean acceptLocks) Sets acceptLocks. |
public void | setAlwaysRefresh(boolean alwaysRefresh) Sets the alwaysRefresh parameter. |
public void | setBaseClass(String baseClass) |
public void | setClassOfObject(Class c) sets the class object described by this descriptor. |
public void | setDeleteProcedure(DeleteProcedureDescriptor newValue) Change the descriptor for the delete procedure/function. |
public synchronized void | setFactoryClass(Class newClass) Set the object factory for class described by this
descriptor. |
public void | setFactoryClass(String newClass) |
public synchronized void | setFactoryMethod(String factoryMethodName) |
public void | setIndexes(Vector indexes) Sets the IndexDescriptors used for DDL generation. |
public synchronized void | setInitializationMethod(String newMethodName) |
public void | setInsertProcedure(InsertProcedureDescriptor newValue) Change the descriptor for the insert procedure/function. |
public void | setIsInterface(boolean newIsInterface) Set true if described class is
a interface. |
public void | setIsolationLevel(int isoLevel) |
public void | setObjectCacheDescriptor(ObjectCacheDescriptor objectCacheDescriptor) Sets the
ObjectCacheDescriptor for representing class. |
public void | setPersistentFieldClassName(String pfClassName) Optional! Set the
org.apache.ojb.broker.metadata.fieldaccess.PersistentField implementation class used by this class. |
public void | setProxyClass(Class newProxyClass) Sets the proxy class to be used. |
public void | setProxyClassName(String newProxyClassName) Sets the name of the proxy class to be used. |
public void | setProxyPrefetchingLimit(int proxyPrefetchingLimit) |
public void | setRepository(DescriptorRepository repository) Sets the repository. |
public void | setRowReader(RowReader newReader) |
public void | setRowReader(String newReaderClassName) |
public void | setSchema(String schema) Sets the schema. |
public void | setSuperClass(String classname) Set name of the super class. |
public void | setSuperClassFieldRef(int fieldId) |
public void | setTableName(String str) |
public void | setUpdateProcedure(UpdateProcedureDescriptor newValue) Change the descriptor for the update procedure/function. |
public String | toString() Return a string representation of this class. |
public String | toXML() |
public void | updateLockingValues(Object obj) |
public boolean | useIdentityColumnField() Returns true if an DB Identity column field based sequence
manager was used. |