org.castor.persist
Class ProposedEntity

java.lang.Object
  org.castor.persist.ProposedEntity

public final class ProposedEntity

extends java.lang.Object

Holding structure for information about an entity class instance. This contains amongst others ...

• the suggested class
• the actually loaded class (if expansion took place)
• the field values (in form of an object array) of the entity

Since:

0.9.9

Version:

$Revision: 5951 $ $Date$

Author:

Werner Guttmann

Constructor Summary

ProposedEntity()
Creates an default instance.

ProposedEntity(ClassMolder actualClassMolder)

ProposedEntity(ProposedEntity proposedEntity)
Creates an instance of this class based upon the values passed in.

Method Summary

ClassMolder	getActualClassMolder() Returns the ClassMolder associated with the actual object.
java.lang.Class	getActualEntityClass() Returns the actual Class instance.
java.lang.Object	getEntity() Returns the object.
java.lang.Object	getField(int index) Returns the specified field value of the object in question.
java.lang.Object[]	getFields() Returns the fields of the object in question.
int	getNumberOfFields() Indicates the number of field values set for this entity.
java.lang.Class	getProposedEntityClass() Returns the proposed Class instance.
void	initializeFields(int numberOfFields) Initialize field values to the specified number.
boolean	isExpanded() True if the proposed class has been expanded.
boolean	isFieldsSet() Indicates whether the fields are set, i.e. not null.
boolean	isObjectLockObjectToBeIgnored()
void	setActualClassMolder(ClassMolder actualClassMolder) Sets the ClassMolder associated with the actual object.
void	setActualEntityClass(java.lang.Class actualClass) Sets the actual Class instance.
void	setEntity(java.lang.Object entity) Sets the object.
void	setExpanded(boolean isExpanded) Set to true if the proposed class has been expanded.
void	setField(java.lang.Object field, int index) Sets the specified field of the object in question.
void	setFields(java.lang.Object[] fields) Sets the fields of the object in question.
void	setObjectLockObjectToBeIgnored(boolean lockObjectToBeIgnored)
void	setProposedEntityClass(java.lang.Class proposedClass) Sets the proposed Class instance.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ProposedEntity

public ProposedEntity()

Creates an default instance.

ProposedEntity

public ProposedEntity(ClassMolder actualClassMolder)

ProposedEntity

public ProposedEntity(ProposedEntity proposedEntity)

Creates an instance of this class based upon the values passed in.

Parameters:

proposedEntity - The entity instance to be copied.

Method Detail

initializeFields

public void initializeFields(int numberOfFields)

Initialize field values to the specified number.

Parameters:

numberOfFields - Number of the field values to be created.

getFields

public java.lang.Object[] getFields()

Returns the fields of the object in question.

Returns:

Returns the fields.

getField

public java.lang.Object getField(int index)

Returns the specified field value of the object in question.

Parameters:

index - Index of the field to be returned.

Returns:

Returns the specified field value.

isFieldsSet

public boolean isFieldsSet()

Indicates whether the fields are set, i.e. not null.

Returns:

True if fields are set, i.e. not null(.

getNumberOfFields

public int getNumberOfFields()

Indicates the number of field values set for this entity.

Returns:

Number of field values set.

setFields

public void setFields(java.lang.Object[] fields)

Sets the fields of the object in question.

Parameters:

fields - The fields to set.

setField

public void setField(java.lang.Object field,
                     int index)

Sets the specified field of the object in question.

Parameters:

field - The field value to set.

index - Specifies which field to set.

getEntity

public java.lang.Object getEntity()

Returns the object.

Returns:

The object.

setEntity

public void setEntity(java.lang.Object entity)

Sets the object.

Parameters:

entity - The object to set.

isExpanded

public boolean isExpanded()

True if the proposed class has been expanded.

Returns:

true if class is expanded, false otherwise.

setExpanded

public void setExpanded(boolean isExpanded)

Set to true if the proposed class has been expanded.

Parameters:

isExpanded - The isExpanded to set.

getProposedEntityClass

public java.lang.Class getProposedEntityClass()

Returns the proposed Class instance.

Returns:

The proposedClass.

setProposedEntityClass

public void setProposedEntityClass(java.lang.Class proposedClass)

Sets the proposed Class instance.

Parameters:

proposedClass - The proposedClass to set.

getActualEntityClass

public java.lang.Class getActualEntityClass()

Returns the actual Class instance.

Returns:

The actualClass.

setActualEntityClass

public void setActualEntityClass(java.lang.Class actualClass)

Sets the actual Class instance.

Parameters:

actualClass - The actualClass to set.

getActualClassMolder

public ClassMolder getActualClassMolder()

Returns the ClassMolder associated with the actual object.

Returns:

The actual ClassMolder.

setActualClassMolder

public void setActualClassMolder(ClassMolder actualClassMolder)

Sets the ClassMolder associated with the actual object.

Parameters:

actualClassMolder - The ClassMolder associated with the actual object.

toString

public java.lang.String toString()

See Also:

Object.toString()

isObjectLockObjectToBeIgnored

public boolean isObjectLockObjectToBeIgnored()

setObjectLockObjectToBeIgnored

public void setObjectLockObjectToBeIgnored(boolean lockObjectToBeIgnored)