net.ontopia.persistence.proxy
Interface ClassInfoIF

All Known Implementing Classes:

ClassInfo

public interface ClassInfoIF

INTERNAL: A interface for class descriptor-like object types that is used by the proxy implementation to access the information it needs about the object relational class descriptor in an optimized manner.

Field Summary

static int	STRUCTURE_COLLECTION Flag indicating that the descriptor class has collection structure.
static int	STRUCTURE_OBJECT Flag indicating that the descriptor class has object structure.
static int	TYPE_AGGREGATE Flag indicating that the descriptor class is an aggregate.
static int	TYPE_IDENTIFIABLE Flag indicating that the descriptor class is identifiable.

Method Summary

java.lang.Object	createInstance(boolean immutable) INTERNAL: Creates an instance of the descriptor class.
java.lang.Class	getDescriptorClass() INTERNAL: Return the descriptor class described by the descriptor.
FieldInfoIF	getFieldInfoByName(java.lang.String name) INTERNAL: Get the field info by name.
FieldInfoIF	getIdentityFieldInfo() INTERNAL: Get the identity field info.
FieldInfoIF[]	getMany2ManyFieldInfos() INTERNAL: Get the M:M field infos.
ObjectRelationalMappingIF	getMapping() INTERNAL: Returns the owning object relational mapping instance.
java.lang.String	getMasterTable() INTERNAL: Returns the name of the master table in which the class is stored.
java.lang.String	getName() INTERNAL: Returns the name of the descriptor class (the mapped class).
FieldInfoIF[]	getOne2ManyFieldInfos() INTERNAL: Get the 1:M field infos.
FieldInfoIF[]	getOne2OneFieldInfos() INTERNAL: Get the 1:1 field infos.
int	getStructure() INTERNAL: Returns the structure of the descriptor class.
FieldInfoIF[]	getValueFieldInfos() INTERNAL: Get the value field infos.
boolean	isAbstract() INTERNAL: Returns true if the descriptor class is declared as an abstract descriptor.
boolean	isAggregate() INTERNAL: Returns true if the descriptor class is declared as an aggregate type.
boolean	isIdentifiable() INTERNAL: Returns true if the descriptor class is declared as a an identifiable type.

Field Detail

TYPE_IDENTIFIABLE

static final int TYPE_IDENTIFIABLE

Flag indicating that the descriptor class is identifiable.

See Also:

Constant Field Values

TYPE_AGGREGATE

static final int TYPE_AGGREGATE

Flag indicating that the descriptor class is an aggregate.

See Also:

Constant Field Values

STRUCTURE_OBJECT

static final int STRUCTURE_OBJECT

Flag indicating that the descriptor class has object structure.

See Also:

Constant Field Values

STRUCTURE_COLLECTION

static final int STRUCTURE_COLLECTION

Flag indicating that the descriptor class has collection structure.

See Also:

Constant Field Values

Method Detail

getMapping

ObjectRelationalMappingIF getMapping()

INTERNAL: Returns the owning object relational mapping instance.

getName

java.lang.String getName()

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

getDescriptorClass

java.lang.Class getDescriptorClass()

INTERNAL: Return the descriptor class described by the descriptor.

createInstance

java.lang.Object createInstance(boolean immutable)
                                throws java.lang.Exception

INTERNAL: Creates an instance of the descriptor class. Actual implementation will depend on the immutable argument.

Throws:

java.lang.Exception

getFieldInfoByName

FieldInfoIF getFieldInfoByName(java.lang.String name)

INTERNAL: Get the field info by name.

getIdentityFieldInfo

FieldInfoIF getIdentityFieldInfo()

INTERNAL: Get the identity field info. Note that this field info is a wrapper instance that wraps the value field infos representing the fields used to represent the object identity.

getValueFieldInfos

FieldInfoIF[] getValueFieldInfos()

INTERNAL: Get the value field infos. The field infos are returned in the same order as specified by their index property.

getOne2OneFieldInfos

FieldInfoIF[] getOne2OneFieldInfos()

INTERNAL: Get the 1:1 field infos.

getOne2ManyFieldInfos

FieldInfoIF[] getOne2ManyFieldInfos()

INTERNAL: Get the 1:M field infos.

getMany2ManyFieldInfos

FieldInfoIF[] getMany2ManyFieldInfos()

INTERNAL: Get the M:M field infos.

isAbstract

boolean isAbstract()

INTERNAL: Returns true if the descriptor class is declared as an abstract descriptor.

isIdentifiable

boolean isIdentifiable()

INTERNAL: Returns true if the descriptor class is declared as a an identifiable type.

isAggregate

boolean isAggregate()

INTERNAL: Returns true if the descriptor class is declared as an aggregate type.

getStructure

int getStructure()

INTERNAL: Returns the structure of the descriptor class. This can either be OBJECT, COLLECTION or MAP.

getMasterTable

java.lang.String getMasterTable()

INTERNAL: Returns the name of the master table in which the class is stored. This is the table which typically contains the instance identity.