ACS-10.0 Java API: org.exolab.castor.mapping.loader.FieldDescriptorImpl Class Reference

Inheritance diagram for org.exolab.castor.mapping.loader.FieldDescriptorImpl:

List of all members.

Public Member Functions
	FieldDescriptorImpl (String fieldName, TypeInfo typeInfo, FieldHandler handler, boolean trans) throws MappingException
void	setContainingClassDescriptor (ClassDescriptor contClsDesc)
ClassDescriptor	getContainingClassDescriptor ()
String	getFieldName ()
Class	getFieldType ()
boolean	isTransient ()
boolean	isImmutable ()
boolean	isRequired ()
boolean	isMultivalued ()
ClassDescriptor	getClassDescriptor ()
FieldHandler	getHandler ()
TypeConvertor	getConvertor ()
String	getConvertorParam ()
String	toString ()
Protected Member Functions
	FieldDescriptorImpl (FieldDescriptor fieldDesc)
	FieldDescriptorImpl (FieldDescriptorImpl fieldDesc)
Package Functions
void	setHandler (FieldHandler handler)
void	setClassDescriptor (ClassDescriptor clsDesc)
void	setRequired (boolean required)

Detailed Description

A basic field descriptor implementation. Engines will extend this class to provide additional functionality.

Author:: Assaf Arkin

Version:

Revision:: 1.3

Date:: 2004/06/16 09:48:53

See also:: ClassDescriptorImpl

Constructor & Destructor Documentation

org.exolab.castor.mapping.loader.FieldDescriptorImpl.FieldDescriptorImpl	(	String	fieldName,
		TypeInfo	typeInfo,
		FieldHandler	handler,
		boolean	trans
	)			throws MappingException

Constructs a new field descriptor.

Parameters:

	fieldName	The field name
	typeInfo	The field type information
	handler	The field handler (may be null)
	trans	True if the field is transient

org.exolab.castor.mapping.loader.FieldDescriptorImpl.FieldDescriptorImpl ( FieldDescriptor fieldDesc ) [protected]

Constructor used by derived clases.

References org.exolab.castor.mapping.FieldDescriptor.getClassDescriptor(), org.exolab.castor.mapping.FieldDescriptor.getContainingClassDescriptor(), org.exolab.castor.mapping.FieldDescriptor.getFieldName(), org.exolab.castor.mapping.FieldDescriptor.getFieldType(), org.exolab.castor.mapping.FieldDescriptor.getHandler(), org.exolab.castor.mapping.FieldDescriptor.isImmutable(), org.exolab.castor.mapping.FieldDescriptor.isMultivalued(), org.exolab.castor.mapping.FieldDescriptor.isRequired(), and org.exolab.castor.mapping.FieldDescriptor.isTransient().

org.exolab.castor.mapping.loader.FieldDescriptorImpl.FieldDescriptorImpl ( FieldDescriptorImpl fieldDesc ) [protected]

Constructor used by derived clases.

References org.exolab.castor.mapping.loader.FieldDescriptorImpl.getClassDescriptor(), org.exolab.castor.mapping.loader.FieldDescriptorImpl.getContainingClassDescriptor(), org.exolab.castor.mapping.loader.FieldDescriptorImpl.getConvertor(), org.exolab.castor.mapping.loader.FieldDescriptorImpl.getConvertorParam(), org.exolab.castor.mapping.loader.FieldDescriptorImpl.getFieldName(), org.exolab.castor.mapping.loader.FieldDescriptorImpl.getFieldType(), org.exolab.castor.mapping.loader.FieldDescriptorImpl.getHandler(), org.exolab.castor.mapping.loader.FieldDescriptorImpl.isImmutable(), org.exolab.castor.mapping.loader.FieldDescriptorImpl.isMultivalued(), org.exolab.castor.mapping.loader.FieldDescriptorImpl.isRequired(), and org.exolab.castor.mapping.loader.FieldDescriptorImpl.isTransient().

Member Function Documentation

ClassDescriptor org.exolab.castor.mapping.loader.FieldDescriptorImpl.getClassDescriptor ( )

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.

Returns:: The class descriptor of the field type, or null

Implements org.exolab.castor.mapping.FieldDescriptor.

Referenced by org.exolab.castor.mapping.loader.FieldDescriptorImpl.FieldDescriptorImpl().

ClassDescriptor org.exolab.castor.mapping.loader.FieldDescriptorImpl.getContainingClassDescriptor ( )

Returns:: the class which contains this field

Implements org.exolab.castor.mapping.FieldDescriptor.

Referenced by org.exolab.castor.mapping.loader.FieldDescriptorImpl.FieldDescriptorImpl().

TypeConvertor org.exolab.castor.mapping.loader.FieldDescriptorImpl.getConvertor ( )

Returns the convertor from the field type to an external type.

Returns:: Convertor from field type

Referenced by org.exolab.castor.mapping.loader.FieldDescriptorImpl.FieldDescriptorImpl().

String org.exolab.castor.mapping.loader.FieldDescriptorImpl.getConvertorParam ( )

Returns the convertor parameter.

Returns:: Convertor parameter

Referenced by org.exolab.castor.mapping.loader.FieldDescriptorImpl.FieldDescriptorImpl().

String org.exolab.castor.mapping.loader.FieldDescriptorImpl.getFieldName ( )

Returns the name of the field.

Returns:: Field name

Implements org.exolab.castor.mapping.FieldDescriptor.

Referenced by org.exolab.castor.mapping.loader.FieldDescriptorImpl.FieldDescriptorImpl().

Class org.exolab.castor.mapping.loader.FieldDescriptorImpl.getFieldType ( )

Returns the Java type of the field.

Returns:: Field type

Implements org.exolab.castor.mapping.FieldDescriptor.

Referenced by org.exolab.castor.mapping.loader.FieldDescriptorImpl.FieldDescriptorImpl().

FieldHandler org.exolab.castor.mapping.loader.FieldDescriptorImpl.getHandler ( )

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

Returns:: The field handler

Implements org.exolab.castor.mapping.FieldDescriptor.

Referenced by org.exolab.castor.mapping.loader.FieldDescriptorImpl.FieldDescriptorImpl().

boolean org.exolab.castor.mapping.loader.FieldDescriptorImpl.isImmutable ( )

Returns true if the field type is immutable.

Returns:: True if the field type is immutable

Implements org.exolab.castor.mapping.FieldDescriptor.

Referenced by org.exolab.castor.mapping.loader.FieldDescriptorImpl.FieldDescriptorImpl().

boolean org.exolab.castor.mapping.loader.FieldDescriptorImpl.isMultivalued ( )

Returns true if the field is multi valued (a collection).

Returns:: True if the field is multi valued

Implements org.exolab.castor.mapping.FieldDescriptor.

Referenced by org.exolab.castor.mapping.loader.FieldDescriptorImpl.FieldDescriptorImpl().

boolean org.exolab.castor.mapping.loader.FieldDescriptorImpl.isRequired ( )

Returns true if the field type is required.

Returns:: True if the field type is required

Implements org.exolab.castor.mapping.FieldDescriptor.

Referenced by org.exolab.castor.mapping.loader.FieldDescriptorImpl.FieldDescriptorImpl().

boolean org.exolab.castor.mapping.loader.FieldDescriptorImpl.isTransient ( )

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

Returns:: True if transient field

Implements org.exolab.castor.mapping.FieldDescriptor.

Referenced by org.exolab.castor.mapping.loader.FieldDescriptorImpl.FieldDescriptorImpl().

void org.exolab.castor.mapping.loader.FieldDescriptorImpl.setClassDescriptor ( ClassDescriptor clsDesc ) [package]

Mutator method used by MappingLoader.

void org.exolab.castor.mapping.loader.FieldDescriptorImpl.setContainingClassDescriptor ( ClassDescriptor contClsDesc )

Set the class which contains this field

Implements org.exolab.castor.mapping.FieldDescriptor.

void org.exolab.castor.mapping.loader.FieldDescriptorImpl.setHandler ( FieldHandler handler ) [package]

Mutator method used by MappingLoader.

void org.exolab.castor.mapping.loader.FieldDescriptorImpl.setRequired ( boolean required ) [package]

Mutator method used by MappingLoader.

Referenced by org.exolab.castor.mapping.loader.MappingLoader.createFieldDesc().

String org.exolab.castor.mapping.loader.FieldDescriptorImpl.toString ( )

The documentation for this class was generated from the following file:

FieldDescriptorImpl.java

All Classes Namespaces Files Functions Variables Enumerations Properties