Java Doc for ClassDescriptorDef.java in  » Database-ORM » db-ojb » xdoclet » modules » ojb » model » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation 1.  6.0 JDK Core 2.  6.0 JDK Modules 3.  6.0 JDK Modules com.sun 4.  6.0 JDK Modules com.sun.java 5.  6.0 JDK Modules sun 6.  6.0 JDK Platform 7.  Ajax 8.  Apache Harmony Java SE 9.  Aspect oriented 10.  Authentication Authorization 11.  Blogger System 12.  Build 13.  Byte Code 14.  Cache 15.  Chart 16.  Chat 17.  Code Analyzer 18.  Collaboration 19.  Content Management System 20.  Database Client 21.  Database DBMS 22.  Database JDBC Connection Pool 23.  Database ORM 24.  Development 25.  EJB Server geronimo 26.  EJB Server GlassFish 27.  EJB Server JBoss 4.2.1 28.  EJB Server resin 3.1.5 29.  ERP CRM Financial 30.  ESB 31.  Forum 32.  GIS 33.  Graphic Library 34.  Groupware 35.  HTML Parser 36.  IDE 37.  IDE Eclipse 38.  IDE Netbeans 39.  Installer 40.  Internationalization Localization 41.  Inversion of Control 42.  Issue Tracking 43.  J2EE 44.  JBoss 45.  JMS 46.  JMX 47.  Library 48.  Mail Clients 49.  Net 50.  Parser 51.  PDF 52.  Portal 53.  Profiler 54.  Project Management 55.  Report 56.  RSS RDF 57.  Rule Engine 58.  Science 59.  Scripting 60.  Search Engine 61.  Security 62.  Sevlet Container 63.  Source Control 64.  Swing Library 65.  Template Engine 66.  Test Coverage 67.  Testing 68.  UML 69.  Web Crawler 70.  Web Framework 71.  Web Mail 72.  Web Server 73.  Web Services 74.  Web Services apache cxf 2.0.1 75.  Web Services AXIS2 76.  Wiki Engine 77.  Workflow Engines 78.  XML 79.  XML UI Java Java Tutorial Java Open Source Jar File Download Java Articles Java Products Java by API Photoshop Tutorials Maya Tutorials Flash Tutorials 3ds-Max Tutorials Illustrator Tutorials GIMP Tutorials C# / C Sharp C# / CSharp Tutorial C# / CSharp Open Source ASP.Net ASP.NET Tutorial JavaScript DHTML JavaScript Tutorial JavaScript Reference HTML / CSS HTML CSS Reference C / ANSI-C C Tutorial C++ C++ Tutorial Ruby PHP Python Python Tutorial Python Open Source SQL Server / T-SQL SQL Server / T-SQL Tutorial Oracle PL / SQL Oracle PL/SQL Tutorial PostgreSQL SQL / MySQL MySQL Tutorial VB.Net VB.Net Tutorial Flash / Flex / ActionScript VBA / Excel / Access / Word XML XML Tutorial Microsoft Office PowerPoint 2007 Tutorial Microsoft Office Excel 2007 Tutorial Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Database ORM » db ojb » xdoclet.modules.ojb.model   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    xdoclet.modules.ojb.model.DefBase       xdoclet.modules.ojb.model.ClassDescriptorDef ClassDescriptorDef public class ClassDescriptorDef extends DefBase (Code) Definition of a class for the ojb repository file. author:    Thomas Dudziak Constructor Summary public   ClassDescriptorDef(XClass origin)      Creates a new class definition object. Method Summary public  void addCollection(CollectionDescriptorDef collDef)      Adds a collection descriptor to this class. public  void addDirectBaseType(ClassDescriptorDef baseType)      Adds a direct base type. public  void addExtentClass(ClassDescriptorDef subType)      Adds a sub type. public  void addField(FieldDescriptorDef fieldDef)      Adds a field descriptor to this class. public  void addFieldClone(FieldDescriptorDef fieldDef)      Adds a clone of the given field descriptor to this class. public  void addIndexDescriptor(IndexDescriptorDef indexDef)      Adds an index descriptor definition to this class descriptor. public  void addModification(String name, Properties mods)      Adds a modification for the given inherited field/reference/collection. public  void addNested(NestedDef nestedDef)      Adds a nested object to this class. public  void addProcedure(ProcedureDef procDef)      Adds a procedure definition to this class descriptor. public  void addProcedureArgument(ProcedureArgumentDef argDef)      Adds a procedure argument definition to this class descriptor. public  void addReference(ReferenceDescriptorDef refDef)      Adds a reference descriptor to this class. public  boolean canBeInstantiated()      Determines whether this class can be instantiated, i.e. public  void checkConstraints(String checkLevel)      Checks the constraints on this class. public  boolean equals(Object other)      public  Iterator getAllBaseTypes()      Returns all base types. public  Iterator getAllExtentClasses()      Returns an iterator of all direct and indirect extents of this class. public  CollectionDescriptorDef getCollection(String name)      Returns the collection definition of the given name if it exists. public  Iterator getCollections()      Returns an iterator of the collection definitions. public  String getDefaultTableName()      Returns the default table name for this class which is the unqualified class name. public  Iterator getDirectBaseTypes()      Returns the direct base types. public  Iterator getExtentClasses()      Returns an iterator of the extents of this class. public  DefBase getFeature(String name)      Returns the feature (field, reference, collection) of the given name. public  FieldDescriptorDef getField(String name)      Returns the field definition with the specified name. public  Iterator getFields()      Returns an iterator of the fields definitions. public  ArrayList getFields(String fieldNames)      Returns the field descriptors given in the the field names list. public  IndexDescriptorDef getIndexDescriptor(String name)      Returns the index descriptor definition of the given name if it exists. public  Iterator getIndexDescriptors()      Returns an iterator of the index descriptor definitions. public  Properties getModification(String name)      Returns the modification for the inherited field/reference/collection with the given name. public  Iterator getModificationNames()      Returns an iterator of all field/reference/collection names for which modifications are stored in this class def. public  NestedDef getNested(String name)      Returns the nested object definition with the specified name. public  Iterator getNested()      Returns an iterator of the nested object definitions. public  ObjectCacheDef getObjectCache()      Returns the object cache definition. public  XClass getOriginalClass()      Returns the original class. public  ArrayList getPrimaryKeys()      Returns the primarykey fields. public  ProcedureDef getProcedure(String name)      Returns the procedure definition of the given name if it exists. public  ProcedureArgumentDef getProcedureArgument(String name)      Returns the procedure argument definition of the given name if it exists. public  Iterator getProcedureArguments()      Returns an iterator of all procedure argument definitions. public  Iterator getProcedures()      Returns an iterator of the procedure definitions. public  String getQualifiedName()      Returns the qualified name of this class as per Java spec. public  ReferenceDescriptorDef getReference(String name)      Returns a reference definition of the given name if it exists. public  Iterator getReferences()      Returns an iterator of the reference definitionss.  boolean hasBeenProcessed()      Determines whether this class descriptor has been processed. public  boolean hasFeature(String name)      Determines whether this class has a feature (field, reference, collection) of the given name. public  int hashCode()      public  void process()      Processes theis class (ensures that all base types are processed, copies their features to this class, and applies modifications (removes ignored features, changes declarations). public  ObjectCacheDef setObjectCache(String name)      Sets an object cache definition to an object cache of the given name (if necessary), and returns it. Constructor Detail ClassDescriptorDef public ClassDescriptorDef(XClass origin)(Code) Creates a new class definition object. Parameters:   origin - The original class Method Detail addCollection public void addCollection(CollectionDescriptorDef collDef)(Code) Adds a collection descriptor to this class. Parameters:   collDef - The collection descriptor addDirectBaseType public void addDirectBaseType(ClassDescriptorDef baseType)(Code) Adds a direct base type. Parameters:   baseType - The base type descriptor addExtentClass public void addExtentClass(ClassDescriptorDef subType)(Code) Adds a sub type. Parameters:   subType - The sub type definition addField public void addField(FieldDescriptorDef fieldDef)(Code) Adds a field descriptor to this class. Parameters:   fieldDef - The field descriptor addFieldClone public void addFieldClone(FieldDescriptorDef fieldDef)(Code) Adds a clone of the given field descriptor to this class. Parameters:   fieldDef - The field descriptor addIndexDescriptor public void addIndexDescriptor(IndexDescriptorDef indexDef)(Code) Adds an index descriptor definition to this class descriptor. Parameters:   indexDef - The index descriptor definition addModification public void addModification(String name, Properties mods)(Code) Adds a modification for the given inherited field/reference/collection. Parameters:   name - The name of the inherited field, reference or collection Parameters:   mods - The modified properties addNested public void addNested(NestedDef nestedDef)(Code) Adds a nested object to this class. Parameters:   nestedDef - The nested object addProcedure public void addProcedure(ProcedureDef procDef)(Code) Adds a procedure definition to this class descriptor. Parameters:   procDef - The procedure definition addProcedureArgument public void addProcedureArgument(ProcedureArgumentDef argDef)(Code) Adds a procedure argument definition to this class descriptor. Parameters:   argDef - The procedure argument definition addReference public void addReference(ReferenceDescriptorDef refDef)(Code) Adds a reference descriptor to this class. Parameters:   refDef - The reference descriptor canBeInstantiated public boolean canBeInstantiated()(Code) Determines whether this class can be instantiated, i.e. not an interface or abstract class. true if objects can be created of this class checkConstraints public void checkConstraints(String checkLevel) throws ConstraintException(Code) Checks the constraints on this class. Parameters:   checkLevel - The amount of checks to perform exception:   ConstraintException - If a constraint has been violated equals public boolean equals(Object other)(Code) getAllBaseTypes public Iterator getAllBaseTypes()(Code) Returns all base types. An iterator of the base types getAllExtentClasses public Iterator getAllExtentClasses()(Code) Returns an iterator of all direct and indirect extents of this class. The extents iterator getCollection public CollectionDescriptorDef getCollection(String name)(Code) Returns the collection definition of the given name if it exists. Parameters:   name - The name of the collection The collection definition or null if there is no such collection getCollections public Iterator getCollections()(Code) Returns an iterator of the collection definitions. The collection iterator getDefaultTableName public String getDefaultTableName()(Code) Returns the default table name for this class which is the unqualified class name. The default table name getDirectBaseTypes public Iterator getDirectBaseTypes()(Code) Returns the direct base types. An iterator of the direct base types getExtentClasses public Iterator getExtentClasses()(Code) Returns an iterator of the extents of this class. The extents iterator getFeature public DefBase getFeature(String name)(Code) Returns the feature (field, reference, collection) of the given name. Parameters:   name - The name The feature or null if there is no such feature in the current class getField public FieldDescriptorDef getField(String name)(Code) Returns the field definition with the specified name. Parameters:   name - The name of the desired field The field definition or null if there is no such field getFields public Iterator getFields()(Code) Returns an iterator of the fields definitions. The field iterator getFields public ArrayList getFields(String fieldNames) throws NoSuchFieldException(Code) Returns the field descriptors given in the the field names list. Parameters:   fieldNames - The field names, separated by commas The field descriptors in the order given by the field names throws:   NoSuchFieldException - If a field hasn't been found getIndexDescriptor public IndexDescriptorDef getIndexDescriptor(String name)(Code) Returns the index descriptor definition of the given name if it exists. Parameters:   name - The name of the index The index descriptor definition or null if there is no such index getIndexDescriptors public Iterator getIndexDescriptors()(Code) Returns an iterator of the index descriptor definitions. The index descriptor iterator getModification public Properties getModification(String name)(Code) Returns the modification for the inherited field/reference/collection with the given name. Parameters:   name - The name of the inherited field, reference or collection The modified properties or null if there are no modifications for it getModificationNames public Iterator getModificationNames()(Code) Returns an iterator of all field/reference/collection names for which modifications are stored in this class def. The iterator getNested public NestedDef getNested(String name)(Code) Returns the nested object definition with the specified name. Parameters:   name - The name of the attribute of the nested object The nested object definition or null if there is no such nested object getNested public Iterator getNested()(Code) Returns an iterator of the nested object definitions. The nested object iterator getObjectCache public ObjectCacheDef getObjectCache()(Code) Returns the object cache definition. The object cache definition getOriginalClass public XClass getOriginalClass()(Code) Returns the original class. The original XDoclet class object getPrimaryKeys public ArrayList getPrimaryKeys()(Code) Returns the primarykey fields. The field descriptors of the primarykey fields getProcedure public ProcedureDef getProcedure(String name)(Code) Returns the procedure definition of the given name if it exists. Parameters:   name - The name of the procedure The procedure definition or null if there is no such procedure getProcedureArgument public ProcedureArgumentDef getProcedureArgument(String name)(Code) Returns the procedure argument definition of the given name if it exists. Parameters:   name - The name of the procedure argument The procedure argument definition or null if there is no such argument getProcedureArguments public Iterator getProcedureArguments()(Code) Returns an iterator of all procedure argument definitions. The procedure argument iterator getProcedures public Iterator getProcedures()(Code) Returns an iterator of the procedure definitions. The procedure iterator getQualifiedName public String getQualifiedName()(Code) Returns the qualified name of this class as per Java spec. The qualified name getReference public ReferenceDescriptorDef getReference(String name)(Code) Returns a reference definition of the given name if it exists. Parameters:   name - The name of the reference The reference def or null if there is no such reference getReferences public Iterator getReferences()(Code) Returns an iterator of the reference definitionss. The iterator hasBeenProcessed boolean hasBeenProcessed()(Code) Determines whether this class descriptor has been processed. true if this class descriptor has been processed hasFeature public boolean hasFeature(String name)(Code) Determines whether this class has a feature (field, reference, collection) of the given name. Parameters:   name - The name true if there is such a feature hashCode public int hashCode()(Code) process public void process() throws ConstraintException(Code) Processes theis class (ensures that all base types are processed, copies their features to this class, and applies modifications (removes ignored features, changes declarations). throws:   ConstraintException - If a constraint has been violated setObjectCache public ObjectCacheDef setObjectCache(String name)(Code) Sets an object cache definition to an object cache of the given name (if necessary), and returns it. Parameters:   name - The name of the object cache class The object cache definition Methods inherited from xdoclet.modules.ojb.model.DefBase public void applyModifications(Properties mods)(Code)(Java Doc) public boolean getBooleanProperty(String name, boolean defaultValue)(Code)(Java Doc) public String getName()(Code)(Java Doc) public DefBase getOwner()(Code)(Java Doc) public String getProperty(String name)(Code)(Java Doc) public Iterator getPropertyNames()(Code)(Java Doc) public boolean hasProperty(String name)(Code)(Java Doc) public void setOwner(DefBase owner)(Code)(Java Doc) public void setProperty(String name, String value)(Code)(Java Doc) public String toString()(Code)(Java Doc) Methods inherited from java.lang.Object native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc) public boolean equals(Object obj)(Code)(Java Doc) protected void finalize() throws Throwable(Code)(Java Doc) final native public Class getClass()(Code)(Java Doc) native public int hashCode()(Code)(Java Doc) final native public void notify()(Code)(Java Doc) final native public void notifyAll()(Code)(Java Doc) public String toString()(Code)(Java Doc) final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc) final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc) final public void wait() throws InterruptedException(Code)(Java Doc)