org.exolab.castor.mapping.loader
Class AbstractFieldDescriptor

java.lang.Object
  org.exolab.castor.mapping.loader.AbstractFieldDescriptor

All Implemented Interfaces:

FieldDescriptor

Direct Known Subclasses:

FieldDescriptorImpl, XMLFieldDescriptorImpl

public abstract class AbstractFieldDescriptor

extends java.lang.Object

implements FieldDescriptor

Constructor Summary

AbstractFieldDescriptor()

Method Summary

ClassDescriptor	getClassDescriptor() Returns the class descriptor related to the field type.
ClassDescriptor	getContainingClassDescriptor() Get the class descriptor which contains this field.
java.lang.String	getFieldName() Returns the name of the field.
java.lang.Class	getFieldType() Returns the Java type of the field.
FieldHandler	getHandler() Returns the handler of the field.
boolean	isIdentity() Is the described field is part of the identity of the class it belongs to?
boolean	isImmutable() Returns true if the field type is immutable.
boolean	isMultivalued() Returns true if the field is multivalued (a collection).
boolean	isRequired() Returns true if the field type is required.
boolean	isTransient() Returns true if the field is transient.
void	setClassDescriptor(ClassDescriptor classDescriptor) Set the ClassDescriptor for the described field.
void	setContainingClassDescriptor(ClassDescriptor parent) Set the class descriptor which contains this field.
void	setFieldName(java.lang.String fieldName) Set the name of the field.
void	setFieldType(java.lang.Class fieldType) Set the type of the field.
void	setHandler(FieldHandler handler) Set the FieldHandler for the field being described by this FieldDescriptor.
void	setIdentity(boolean identity) Set wether the described field is part of the identity of the class it belongs to.
void	setImmutable(boolean immutable) Set the immutable flag which indicates that changes to this Field result in a new Object to be created, such as java.lang.String.
void	setMultivalued(boolean multivalued) Set wheter the object described by this descriptor is multivalued or not.
void	setRequired(boolean required) Set whether or not the described field is required.
void	setTransient(boolean isTransient) Sets whether or not the describled field is 'transient'.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFieldDescriptor

public AbstractFieldDescriptor()

Method Detail

setContainingClassDescriptor

public final void setContainingClassDescriptor(ClassDescriptor parent)

Description copied from interface: FieldDescriptor

Set the class descriptor which contains this field.

Specified by:

setContainingClassDescriptor in interface FieldDescriptor

Parameters:

parent - The class descriptor which contains this field.

See Also:

{@inheritDoc}

getContainingClassDescriptor

public final ClassDescriptor getContainingClassDescriptor()

Description copied from interface: FieldDescriptor

Get the class descriptor which contains this field.

Specified by:

getContainingClassDescriptor in interface FieldDescriptor

Returns:

The class descriptor which contains this field.

See Also:

{@inheritDoc}

setFieldName

public final void setFieldName(java.lang.String fieldName)

Set the name of the field.

Parameters:

fieldName - Field name.

getFieldName

public final java.lang.String getFieldName()

Description copied from interface: FieldDescriptor

Returns the name of the field. The field must have a name, even if set through accessor methods.

Specified by:

getFieldName in interface FieldDescriptor

Returns:

Field name.

See Also:

{@inheritDoc}

setFieldType

public final void setFieldType(java.lang.Class fieldType)

Set the type of the field.

Parameters:

fieldType - Field type.

getFieldType

public final java.lang.Class getFieldType()

Description copied from interface: FieldDescriptor

Returns the Java type of the field.

Specified by:

getFieldType in interface FieldDescriptor

Returns:

Field type.

See Also:

{@inheritDoc}

setClassDescriptor

public final void setClassDescriptor(ClassDescriptor classDescriptor)

Set the ClassDescriptor for the described field.

Parameters:

classDescriptor - The ClassDescriptor for the described field.

getClassDescriptor

public final ClassDescriptor getClassDescriptor()

Description copied from interface: FieldDescriptor

Returns the class descriptor related to the field type. If the field type is a class for which a descriptor exists, this descriptor is returned. If the field type is a class for which no mapping is provided, null is returned.

Specified by:

getClassDescriptor in interface FieldDescriptor

Returns:

The class descriptor of the field type, or null.

See Also:

{@inheritDoc}

setHandler

public final void setHandler(FieldHandler handler)

Set the FieldHandler for the field being described by this FieldDescriptor.

Parameters:

handler - The FieldHandler for the field being described.

getHandler

public final FieldHandler getHandler()

Description copied from interface: FieldDescriptor

Returns the handler of the field. In order to persist or marshal a field descriptor will be associated with a handler.

Specified by:

getHandler in interface FieldDescriptor

Returns:

The field handler.

See Also:

{@inheritDoc}

setTransient

public final void setTransient(boolean isTransient)

Sets whether or not the describled field is 'transient'.

Parameters:

isTransient - The flag indicating if the described field is 'transient'.

isTransient

public final boolean isTransient()

Description copied from interface: FieldDescriptor

Returns true if the field is transient. Transient fields are never persisted or marshalled.

Specified by:

isTransient in interface FieldDescriptor

Returns:

True if transient field.

See Also:

{@inheritDoc}

setImmutable

public final void setImmutable(boolean immutable)

Set the immutable flag which indicates that changes to this Field result in a new Object to be created, such as java.lang.String. It serves to identify fields which should not be constructed until all the data is available.

Parameters:

immutable - Flag which if true indicates that the field is immutable.

isImmutable

public final boolean isImmutable()

Description copied from interface: FieldDescriptor

Returns true if the field type is immutable.

Specified by:

isImmutable in interface FieldDescriptor

Returns:

True if the field type is immutable.

See Also:

{@inheritDoc}

setRequired

public final void setRequired(boolean required)

Set whether or not the described field is required.

Parameters:

required - The flag indicating whether or not the described field is required.

isRequired

public final boolean isRequired()

Description copied from interface: FieldDescriptor

Returns true if the field type is required.

Specified by:

isRequired in interface FieldDescriptor

Returns:

True if the field type is required.

See Also:

{@inheritDoc}

setMultivalued

public final void setMultivalued(boolean multivalued)

Set wheter the object described by this descriptor is multivalued or not.

Parameters:

multivalued - True if the object described by this descriptor is multivalued.

isMultivalued

public final boolean isMultivalued()

Description copied from interface: FieldDescriptor

Returns true if the field is multivalued (a collection).

Specified by:

isMultivalued in interface FieldDescriptor

Returns:

True if the field is multivalued.

See Also:

{@inheritDoc}

setIdentity

public final void setIdentity(boolean identity)

Set wether the described field is part of the identity of the class it belongs to.

Parameters:

identity - true if field is part of the classes identity.

isIdentity

public final boolean isIdentity()

Is the described field is part of the identity of the class it belongs to?

Returns:

true if field is part of the classes identity.