org.castor.persist

Class ProposedEntity

public final class ProposedEntity extends Object

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

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
ClassMoldergetActualClassMolder()
Returns the ClassMolder associated with the actual object.
ClassgetActualEntityClass()
Returns the actual Class instance.
ObjectgetEntity()
Returns the object.
ObjectgetField(int index)
Returns the specified field value of the object in question.
Object[]getFields()
Returns the fields of the object in question.
intgetNumberOfFields()
Indicates the number of field values set for this entity.
ClassgetProposedEntityClass()
Returns the proposed Class instance.
voidinitializeFields(int numberOfFields)
Initialize field values to the specified number.
booleanisExpanded()
True if the proposed class has been expanded.
booleanisFieldsSet()
Indicates whether the fields are set, i.e. not null.
booleanisObjectLockObjectToBeIgnored()
voidsetActualClassMolder(ClassMolder actualClassMolder)
Sets the ClassMolder associated with the actual object.
voidsetActualEntityClass(Class actualClass)
Sets the actual Class instance.
voidsetEntity(Object entity)
Sets the object.
voidsetExpanded(boolean isExpanded)
Set to true if the proposed class has been expanded.
voidsetField(Object field, int index)
Sets the specified field of the object in question.
voidsetFields(Object[] fields)
Sets the fields of the object in question.
voidsetObjectLockObjectToBeIgnored(boolean lockObjectToBeIgnored)
voidsetProposedEntityClass(Class proposedClass)
Sets the proposed Class instance.
StringtoString()

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

getActualClassMolder

public ClassMolder getActualClassMolder()
Returns the ClassMolder associated with the actual object.

Returns: The actual ClassMolder.

getActualEntityClass

public Class getActualEntityClass()
Returns the actual Class instance.

Returns: The actualClass.

getEntity

public Object getEntity()
Returns the object.

Returns: The object.

getField

public 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.

getFields

public Object[] getFields()
Returns the fields of the object in question.

Returns: Returns the fields.

getNumberOfFields

public int getNumberOfFields()
Indicates the number of field values set for this entity.

Returns: Number of field values set.

getProposedEntityClass

public Class getProposedEntityClass()
Returns the proposed Class instance.

Returns: The proposedClass.

initializeFields

public void initializeFields(int numberOfFields)
Initialize field values to the specified number.

Parameters: numberOfFields Number of the field values to be created.

isExpanded

public boolean isExpanded()
True if the proposed class has been expanded.

Returns: true if class is expanded, false otherwise.

isFieldsSet

public boolean isFieldsSet()
Indicates whether the fields are set, i.e. not null.

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

isObjectLockObjectToBeIgnored

public boolean isObjectLockObjectToBeIgnored()

setActualClassMolder

public void setActualClassMolder(ClassMolder actualClassMolder)
Sets the ClassMolder associated with the actual object.

Parameters: actualClassMolder The ClassMolder associated with the actual object.

setActualEntityClass

public void setActualEntityClass(Class actualClass)
Sets the actual Class instance.

Parameters: actualClass The actualClass to set.

setEntity

public void setEntity(Object entity)
Sets the object.

Parameters: entity The object to set.

setExpanded

public void setExpanded(boolean isExpanded)
Set to true if the proposed class has been expanded.

Parameters: isExpanded The isExpanded to set.

setField

public void setField(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.

setFields

public void setFields(Object[] fields)
Sets the fields of the object in question.

Parameters: fields The fields to set.

setObjectLockObjectToBeIgnored

public void setObjectLockObjectToBeIgnored(boolean lockObjectToBeIgnored)

setProposedEntityClass

public void setProposedEntityClass(Class proposedClass)
Sets the proposed Class instance.

Parameters: proposedClass The proposedClass to set.

toString

public String toString()
{@inheritDoc }

See Also: java.lang.Object#toString()

Intalio Inc. (C) 1999-2006. All rights reserved http://www.intalio.com