org.exolab.castor.xml.handlers

Class CollectionFieldHandler

Implemented Interfaces:
ConfigurableFieldHandler, FieldHandler

public class CollectionFieldHandler
extends XMLFieldHandler

A FieldHandler for the XML Schema Collection type.

TODO : support all kind of XSList.

Version:
$Revision: 6671 $ $Date: 2003-03-03 00:05:44 -0700 (Mon, 03 Mar 2003) $
Author:
Arnaud Blandin

Field Summary

Fields inherited from class org.exolab.castor.mapping.AbstractFieldHandler

configuration

Constructor Summary

CollectionFieldHandler(FieldHandler fieldHandler)
Creates a new CollectionFieldHandler using the given FieldHandler for delegation.
CollectionFieldHandler(FieldHandler fieldHandler, TypeValidator validator)
Creates a new CollectionFieldHandler using the given FieldHandler for delegation and the given type validator for validation.

Method Summary

void
checkValidity(Object object)
Checks the field validity.
boolean
equals(Object obj)
Returns true if the given object is an XMLFieldHandler that is equivalent to the delegated handler.
Object
getValue(Object target)
Gets the value of the field associated with this descriptor.
Object
newInstance(Object parent)
Creates a new instance of the object described by this field.
void
resetValue(Object target)
Sets the value of the field to a default value.
void
setValue(Object target, Object value)
Sets the value of the field associated with this descriptor.

Methods inherited from class org.exolab.castor.xml.XMLFieldHandler

equals, getValue, newInstance, newInstance, resetValue, setValue

Methods inherited from class org.exolab.castor.mapping.AbstractFieldHandler

getFieldDescriptor, getValue, hasValue, newInstance, newInstance, resetValue, setConfiguration, setFieldDescriptor, setValue

Methods inherited from class org.exolab.castor.mapping.ExtendedFieldHandler

checkValidity, getFieldDescriptor, getValue, newInstance, newInstance, resetValue, setFieldDescriptor, setValue

Methods inherited from class org.exolab.castor.mapping.loader.FieldHandlerFriend

checkValidity, getFieldDescriptor, getValue, newInstance, resetValue, setFieldDescriptor, setValue

Constructor Details

CollectionFieldHandler

public CollectionFieldHandler(FieldHandler fieldHandler)
Creates a new CollectionFieldHandler using the given FieldHandler for delegation.
Parameters:
fieldHandler - the fieldHandler for delegation.

CollectionFieldHandler

public CollectionFieldHandler(FieldHandler fieldHandler,
                              TypeValidator validator)
Creates a new CollectionFieldHandler using the given FieldHandler for delegation and the given type validator for validation.
Parameters:
fieldHandler - the fieldHandler for delegation.
validator - Type validator to use to validate an instance of this type.

Method Details

checkValidity

public void checkValidity(Object object)
            throws ValidityException,
                   IllegalStateException
Checks the field validity. Returns successfully if the field can be stored, is valid, etc, throws an exception otherwise.
Specified by:
checkValidity in interface FieldHandler
Overrides:
checkValidity in interface ExtendedFieldHandler
Parameters:
object - The object
Throws:
ValidityException - The field is invalid, is required and null, or any other validity violation

equals

public boolean equals(Object obj)
Returns true if the given object is an XMLFieldHandler that is equivalent to the delegated handler. An equivalent XMLFieldHandler is an XMLFieldHandler that is an instances of the same class.
Overrides:
equals in interface XMLFieldHandler
Parameters:
obj - The object to compare to this.
Returns:
true if the given object is an XMLFieldHandler that is equivalent to this one.

getValue

public Object getValue(Object target)
            throws java.lang.IllegalStateException
Gets the value of the field associated with this descriptor. If the value is an array, it returns a string 'representing' this array
Specified by:
getValue in interface FieldHandler
Overrides:
getValue in interface XMLFieldHandler
Parameters:
target - the object from which to get the value
Returns:
the value of the field associated with this descriptor.

newInstance

public Object newInstance(Object parent)
            throws IllegalStateException
Creates a new instance of the object described by this field.
Specified by:
newInstance in interface FieldHandler
Overrides:
newInstance in interface XMLFieldHandler
Parameters:
parent - The object for which the field is created
Returns:
A new instance of the field's value

resetValue

public void resetValue(Object target)
            throws java.lang.IllegalStateException
Sets the value of the field to a default value.
Specified by:
resetValue in interface FieldHandler
Overrides:
resetValue in interface XMLFieldHandler
Parameters:
target - The object to reset

setValue

public void setValue(Object target,
                     Object value)
            throws java.lang.IllegalStateException
Sets the value of the field associated with this descriptor. If paased a String, then String is tokenized and each token is added as an individual instance to the collection.
Specified by:
setValue in interface FieldHandler
Overrides:
setValue in interface XMLFieldHandler
Parameters:
target - the object in which to set the value
value - the value of the field

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