Package net.ontopia.persistence.proxy

Class ClassDescriptor

  • public class ClassDescriptor
extends Object
    INTERNAL: Class used for holding object relational mapping class declarations. It is used by the ObjectRelationalMapping class.

    A class descriptor contains information about object classes defined in object relational mappings. Class descriptors consists of a set of field descriptors.

    • Field Detail

      • klass

        protected Class<?> klass

      • klass_immutable

        protected Class<?> klass_immutable

      • identity_fields

        protected String[] identity_fields

      • isabstract

        protected boolean isabstract

      • type

        protected int type

      • structure

        protected int structure

      • master_table

        protected String master_table

      • extends_classes

        protected Class<?>[] extends_classes

      • interfaces

        protected Class<?>[] interfaces

    • Method Detail

      • getMapping

        public ObjectRelationalMapping getMapping()
        INTERNAL: Gets the object relational mapping that the class descriptor belongs to.

      • getName

        public String getName()
        INTERNAL: Returns the name of the descriptor class (the mapped class).

      • getDescriptorClass

        public Class<?> getDescriptorClass()
        INTERNAL: Returns the descriptor class.

      • getImmutableDescriptorClass

        public Class<?> getImmutableDescriptorClass()
        INTERNAL: Returns the immutable descriptor class.

      • getIdentityFields

        public FieldDescriptor[] getIdentityFields()
        INTERNAL: Returns an array containing the fields that are identity fields.

        An identity field is the field that together represents the identity, or primary key, of instances of the class.

      • getValueFields

        public FieldDescriptor[] getValueFields()
        INTERNAL: Returns an array containing the fields that are value fields, i.e. not identity fields.

      • getPrimitiveFields

        public FieldDescriptor[] getPrimitiveFields()
        INTERNAL: Returns an array containing the fields that are of primitive types.

      • getReferenceFields

        public FieldDescriptor[] getReferenceFields()
        INTERNAL: Returns an array containing the fields that references other mapped objects.

      • getAggregateFields

        public FieldDescriptor[] getAggregateFields()
        INTERNAL: Returns an array containing the fields that are aggregate objects. Aggregate objects are composite objects that don't have explicit identity.

      • getIdentityFieldNames

        protected String[] getIdentityFieldNames()
        INTERNAL: Returns the field names of the identity fields.

      • setIdentityFieldNames

        protected void setIdentityFieldNames​(String[] identity_fields)
        INTERNAL: Sets the field names of the identity fields.

      • getType

        public int getType()
        INTERNAL: Returns the class type.

      • setType

        public void setType​(int type)
        INTERNAL: Sets the class type. This is can either be ClassInfoIF.TYPE_IDENTIFIABLE or ClassInfoIF.TYPE_AGGREGATE.

      • isAggregate

        public boolean isAggregate()

      • getStructure

        public int getStructure()
        INTERNAL: Returns the class structure.

      • setStructure

        public void setStructure​(int structure)
        INTERNAL: Sets the class structure. This is can either be ClassInfoIF.STRUCTURE_OBJECT or ClassInfoIF.STRUCTURE_COLLECTION.

      • setAbstract

        public void setAbstract​(boolean isabstract)
        INTERNAL: Sets the abstract flag. The default is that the descriptor class is non-abstract (i.e. concrete).

      • isAbstract

        public boolean isAbstract()
        INTERNAL: Returns true if the descriptor class is mapped as an abstract class.

      • getMasterTable

        public String getMasterTable()
        INTERNAL: Returns the name of the master table in which the class is stored.

      • setMasterTable

        public void setMasterTable​(String master_table)
        INTERNAL: Sets the name of the master table in which the class is stored.

      • getExtends

        public Class[] getExtends()
        INTERNAL: Returns the descriptor classes that this descriptor class extends. (Not implemented)

      • setExtends

        public void setExtends​(Class[] extends_classes)
        INTERNAL: Sets the descriptor classes that this descriptor class extends. (Not implemented)

      • getInterfaces

        public Class[] getInterfaces()
        INTERNAL: Gets the interfaces that this descriptor class implement.

      • setInterfaces

        public void setInterfaces​(Class[] interfaces)
        INTERNAL: Sets the interfaces that this descriptor class implement.

      • getFieldDescriptors

        public FieldDescriptor[] getFieldDescriptors()
        INTERNAL: Returns all the field descriptors of this class descriptor.

      • getFieldNames

        public String[] getFieldNames()
        INTERNAL: Gets all the field names of this class descriptor.

      • getFieldByName

        public FieldDescriptor getFieldByName​(String field_name)
        INTERNAL: Gets the field descriptor representing the field with the given name.

      • addField

        public void addField​(FieldDescriptor fdesc)
        INTERNAL: Adds the field descriptor to the class descriptor.