org.exolab.castor.persist
Class FieldMolder

java.lang.Object
  org.exolab.castor.persist.FieldMolder

public class FieldMolder
extends Object

FieldMolder represents a field of a data object class. It is used by ClassMolder to set and get the value from a field of a data object.

Author:

Thomas Yip

Nested Class Summary

static class

FieldMolder.CollectionInfo

Constructor Summary

FieldMolder(DatingService datingService, ClassMolder enclosingClassMolder, FieldDescriptor fieldDescriptor)

FieldMolder(DatingService ds, ClassMolder eMold, FieldDescriptor fieldDescriptor, SQLRelationLoader loader)
Creates a single field descriptor.

Method Summary

void	addValue(Object object, Object value, ClassLoader loader)
static Method	findAccessor(Class<?> javaClass, String methodName, Class<?> fieldType, boolean getMethod) Returns the named accessor.
EnumSet<CascadingType>	getCascading() Returns the 'cascading operations' defined for this field.
Class<?>	getCollectionType()
protected Class<?>	getCollectionType(String coll, boolean lazy)
String	getComparator() Returns the java.util.Comparator instance to be used with SortedSets; null, if not specified.
ClassMolder	getEnclosingClassMolder()
ClassMolder	getFieldClassMolder()
LockEngine	getFieldLockEngine()
FieldPersistenceType	getFieldPertsistenceType()
String	getName()
SQLRelationLoader	getRelationLoader()
Object	getValue(Object object, ClassLoader loader)
boolean	isAddable()
boolean	isCheckDirty()
boolean	isDefault(Object value) Check if the specified value is the default value of the Field represented by this FieldMolder.
boolean	isDependent()
boolean	isLazy()
boolean	isManyToMany()
boolean	isMulti()
boolean	isPersistanceCapable()
boolean	isReadonly()
boolean	isSerializable()
boolean	isStored()
boolean	isTransient()
void	setValue(Object object, Object value, ClassLoader loader)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldMolder

public FieldMolder(DatingService ds,
                   ClassMolder eMold,
                   FieldDescriptor fieldDescriptor,
                   SQLRelationLoader loader)
            throws MappingException

Creates a single field descriptor. The field mapping is used to create a new stock FieldMolder. Implementations may extend this class to create a more suitable descriptor.

Parameters:

eMold - The ClassMolder to which the field belongs

Throws:

MappingException - The field or its accessor methods are not found, not accessible, not of the specified type, etc

FieldMolder

public FieldMolder(DatingService datingService,
                   ClassMolder enclosingClassMolder,
                   FieldDescriptor fieldDescriptor)
            throws MappingException

Throws:

MappingException

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

getComparator

public String getComparator()

Returns the java.util.Comparator instance to be used with SortedSets; null, if not specified.

Returns:

the java.util.Comparator instance to be used with SortedSets

getFieldPertsistenceType

public FieldPersistenceType getFieldPertsistenceType()

getRelationLoader

public SQLRelationLoader getRelationLoader()

isStored

public boolean isStored()

isManyToMany

public boolean isManyToMany()

isDependent

public boolean isDependent()

isMulti

public boolean isMulti()

isPersistanceCapable

public boolean isPersistanceCapable()

isSerializable

public boolean isSerializable()

isCheckDirty

public boolean isCheckDirty()

isLazy

public boolean isLazy()

isAddable

public boolean isAddable()

isTransient

public boolean isTransient()

getEnclosingClassMolder

public ClassMolder getEnclosingClassMolder()

getFieldClassMolder

public ClassMolder getFieldClassMolder()

getFieldLockEngine

public LockEngine getFieldLockEngine()

isReadonly

public boolean isReadonly()

getCollectionType

public Class<?> getCollectionType()

getCascading

public EnumSet<CascadingType> getCascading()

Returns the 'cascading operations' defined for this field.

Returns:

the 'cascading operations' defined.

getValue

public Object getValue(Object object,
                       ClassLoader loader)

addValue

public void addValue(Object object,
                     Object value,
                     ClassLoader loader)

setValue

public void setValue(Object object,
                     Object value,
                     ClassLoader loader)

isDefault

public boolean isDefault(Object value)

Check if the specified value is the default value of the Field represented by this FieldMolder.

getCollectionType

protected Class<?> getCollectionType(String coll,
                                     boolean lazy)

findAccessor

public static final Method findAccessor(Class<?> javaClass,
                                        String methodName,
                                        Class<?> fieldType,
                                        boolean getMethod)
                                 throws MappingException

Returns the named accessor. Uses reflection to return the named accessor and check the return value or parameter type, if specified.

Parameters:

javaClass - The class to which the field belongs.

methodName - The name of the accessor method.

fieldType - The type of the field if known, or null.

getMethod - True if get method, false if set method.

Returns:

The method, null if not found.

Throws:

MappingException - The method is not accessible or is not of the specified type.