org.exolab.castor.mapping
Interface FieldDescriptor
- XMLFieldDescriptor
- DelegateFieldDescriptor, FieldDescriptorImpl, JDOFieldDescriptor, XMLFieldDescriptorImpl, XMLMappingLoader.ContainerElementFieldDescriptor
public interface FieldDescriptor
Describes the properties of a field. Implementations will extend
this inteface to provide additional properties.
$Revision: 1.1.1.1 $ $Date: 2003/03/03 07:08:26 $
getClassDescriptor
public ClassDescriptor 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.
- The class descriptor of the field type, or null
getContainingClassDescriptor
public ClassDescriptor getContainingClassDescriptor()
- the class which contains this field
getFieldName
public String getFieldName()
Returns the name of the field.
getFieldType
public Class getFieldType()
Returns the Java type of the field.
getHandler
public FieldHandler getHandler()
Returns the handler of the field. In order to persist or marshal
a field descriptor will be associated with a handler.
isImmutable
public boolean isImmutable()
Returns true if the field type is immutable.
- True if the field type is immutable
isMultivalued
public boolean isMultivalued()
Returns true if the field is multi valued (a collection).
- True if the field is multi valued
isRequired
public boolean isRequired()
Returns true if the field type is required.
- True if the field type is required
isTransient
public boolean isTransient()
Returns true if the field is transient. Transient fields are
never persisted or marshalled.
setContainingClassDescriptor
public void setContainingClassDescriptor(ClassDescriptor contClsDesc)
Set the class which contains this field
Intalio Inc. (C) 1999-2003. All rights reserved http://www.intalio.com