public class ClassDescriptor extends Object
A class descriptor contains information about object classes defined in object relational mappings. Class descriptors consists of a set of field descriptors.
Modifier and Type | Field and Description |
---|---|
protected Class<?>[] |
extends_classes |
protected Map<String,FieldDescriptor> |
fdescs |
protected List<FieldDescriptor> |
fdescs_list |
protected String[] |
identity_fields |
protected Class<?>[] |
interfaces |
protected boolean |
isabstract |
protected Class<?> |
klass |
protected Class<?> |
klass_immutable |
protected ObjectRelationalMapping |
mapping |
protected String |
master_table |
protected int |
structure |
protected int |
type |
Constructor and Description |
---|
ClassDescriptor(Class<?> klass,
Class<?> klass_immutable,
ObjectRelationalMapping mapping) |
Modifier and Type | Method and Description |
---|---|
void |
addField(FieldDescriptor fdesc)
INTERNAL: Adds the field descriptor to the class descriptor.
|
FieldDescriptor[] |
getAggregateFields()
INTERNAL: Returns an array containing the fields that are
aggregate objects.
|
Class<?> |
getDescriptorClass()
INTERNAL: Returns the descriptor class.
|
Class[] |
getExtends()
INTERNAL: Returns the descriptor classes that this descriptor
class extends.
|
FieldDescriptor |
getFieldByName(String field_name)
INTERNAL: Gets the field descriptor representing the field with
the given name.
|
protected Map<String,FieldDescriptor> |
getFieldDescriptorMap() |
FieldDescriptor[] |
getFieldDescriptors()
INTERNAL: Returns all the field descriptors of this class
descriptor.
|
String[] |
getFieldNames()
INTERNAL: Gets all the field names of this class descriptor.
|
protected String[] |
getIdentityFieldNames()
INTERNAL: Returns the field names of the identity fields.
|
FieldDescriptor[] |
getIdentityFields()
INTERNAL: Returns an array containing the fields that are
identity fields.
|
Class<?> |
getImmutableDescriptorClass()
INTERNAL: Returns the immutable descriptor class.
|
Class[] |
getInterfaces()
INTERNAL: Gets the interfaces that this descriptor class
implement.
|
ObjectRelationalMapping |
getMapping()
INTERNAL: Gets the object relational mapping that the class
descriptor belongs to.
|
String |
getMasterTable()
INTERNAL: Returns the name of the master table in which the class
is stored.
|
String |
getName()
INTERNAL: Returns the name of the descriptor class (the mapped class).
|
FieldDescriptor[] |
getPrimitiveFields()
INTERNAL: Returns an array containing the fields that are of
primitive types.
|
FieldDescriptor[] |
getReferenceFields()
INTERNAL: Returns an array containing the fields that references
other mapped objects.
|
int |
getStructure()
INTERNAL: Returns the class structure.
|
int |
getType()
INTERNAL: Returns the class type.
|
FieldDescriptor[] |
getValueFields()
INTERNAL: Returns an array containing the fields that are value
fields, i.e.
|
boolean |
isAbstract()
INTERNAL: Returns true if the descriptor class is mapped as an
abstract class.
|
boolean |
isAggregate() |
protected void |
populateExtendsMap(Map<String,FieldDescriptor> _fdescs) |
void |
setAbstract(boolean isabstract)
INTERNAL: Sets the abstract flag.
|
void |
setExtends(Class[] extends_classes)
INTERNAL: Sets the descriptor classes that this descriptor class
extends.
|
protected void |
setIdentityFieldNames(String[] identity_fields)
INTERNAL: Sets the field names of the identity fields.
|
void |
setInterfaces(Class[] interfaces)
INTERNAL: Sets the interfaces that this descriptor class
implement.
|
void |
setMasterTable(String master_table)
INTERNAL: Sets the name of the master table in which the class is
stored.
|
void |
setStructure(int structure)
INTERNAL: Sets the class structure.
|
void |
setType(int type)
INTERNAL: Sets the class type.
|
String |
toString() |
protected ObjectRelationalMapping mapping
protected Class<?> klass
protected Class<?> klass_immutable
protected String[] identity_fields
protected boolean isabstract
protected int type
protected int structure
protected String master_table
protected Class<?>[] extends_classes
protected Class<?>[] interfaces
protected List<FieldDescriptor> fdescs_list
protected Map<String,FieldDescriptor> fdescs
public ClassDescriptor(Class<?> klass, Class<?> klass_immutable, ObjectRelationalMapping mapping)
public ObjectRelationalMapping getMapping()
public String getName()
public Class<?> getDescriptorClass()
public Class<?> getImmutableDescriptorClass()
public FieldDescriptor[] getIdentityFields()
An identity field is the field that together represents the identity, or primary key, of instances of the class.
public FieldDescriptor[] getValueFields()
public FieldDescriptor[] getPrimitiveFields()
public FieldDescriptor[] getReferenceFields()
public FieldDescriptor[] getAggregateFields()
protected String[] getIdentityFieldNames()
protected void setIdentityFieldNames(String[] identity_fields)
public int getType()
public void setType(int type)
public boolean isAggregate()
public int getStructure()
public void setStructure(int structure)
public void setAbstract(boolean isabstract)
public boolean isAbstract()
public String getMasterTable()
public void setMasterTable(String master_table)
public Class[] getExtends()
public void setExtends(Class[] extends_classes)
protected Map<String,FieldDescriptor> getFieldDescriptorMap()
protected void populateExtendsMap(Map<String,FieldDescriptor> _fdescs)
public Class[] getInterfaces()
public void setInterfaces(Class[] interfaces)
public FieldDescriptor[] getFieldDescriptors()
public String[] getFieldNames()
public FieldDescriptor getFieldByName(String field_name)
public void addField(FieldDescriptor fdesc)