Class XMLContainerElementFieldDescriptor

java.lang.Object

org.exolab.castor.mapping.loader.FieldDescriptorImpl

org.exolab.castor.xml.util.XMLFieldDescriptorImpl

org.exolab.castor.xml.util.XMLContainerElementFieldDescriptor

All Implemented Interfaces:

NatureExtendable, PropertyHolder, FieldDescriptor, XMLFieldDescriptor

public class XMLContainerElementFieldDescriptor
extends XMLFieldDescriptorImpl

Version:

$Revision: 5951 $ $Date: 2005-12-06 14:55:28 -0700 (Tue, 06 Dec 2005) $

Author:

Ralf Joachim

Field Summary

Fields inherited from class XMLFieldDescriptorImpl

_isReference

Modifier and Type	Field	Description
boolean	_isReference	True if the field is a reference to another Object in the hierarchy.

Fields inherited from interface XMLFieldDescriptor

PROPERTY_XML_LANG, PROPERTY_XML_SPACE

Modifier and Type	Field	Description
static final String	PROPERTY_XML_LANG	The xml:lang property.
static final String	PROPERTY_XML_SPACE	The xml:space property.

Constructor Summary

Constructors

Constructor	Description
XMLContainerElementFieldDescriptor(XMLFieldDescriptorImpl fieldDesc, NodeType primitiveNodeType)

Method Summary

Methods inherited from class XMLFieldDescriptorImpl

equals, getComponentType, getConstructorArgumentIndex, getLocationPath, getNameSpacePrefix, getNameSpaceURI, getNodeType, getQNamePrefix, getSchemaType, getSubstitutes, getValidator, getXMLName, getXMLProperty, hashCode, isConstructorArgument, isContainer, isDerivedFromXSList, isIncremental, isMapped, isNillable, isReference, matches, matches, setComponentType, setConstructorArgumentIndex, setContainer, setDerivedFromXSList, setIncremental, setLocationPath, setMapped, setMatches, setNameSpacePrefix, setNameSpaceURI, setNillable, setNodeType, setQNamePrefix, setReference, setSchemaType, setSubstitutes, setUseParentsNamespace, setValidator, setXMLName, setXMLProperty, toString

Modifier and Type	Method	Description
boolean	equals(Object obj)	Returns true if two XMLFieldDescriptors should be treated as equal.
String	getComponentType()	Returns the component type of this XMLFieldDescriptor instance, if the field described represents a collection of values.
int	getConstructorArgumentIndex()	Returns the index within the constructor argument array where the value of this field should be.
String	getLocationPath()	Returns the "relative" XML path for the field being described.
String	getNameSpacePrefix()	Return the "suggested" namespace prefix to use when marshaling as XML.
String	getNameSpaceURI()	Returns the namespace URI to be used when marshaling and unmarshaling as XML.
NodeType	getNodeType()	Returns the node type of the field being described.
String	getQNamePrefix()	Returns the prefix used in case the value of the field described by this descriptor is of type QName.
String	getSchemaType()	Returns the XML Schema type of the XML field being described.
List<String>	getSubstitutes()	Returns the possible substitution groups for this class.
FieldValidator	getValidator()	Returns a specific validator for the field described by this descriptor.
String	getXMLName()	Returns the XML Name for the field being described.
String	getXMLProperty(String propertyName)	Returns the value property with the given name or null if no such property exists.
int	hashCode()	Returns the hashCode for this XMLFieldDescriptor
boolean	isConstructorArgument()	Returns true if the value of the field represented by this descriptor should be set via the constructor of the containing class.
boolean	isContainer()	Returns true if the field described by this descriptor is a container field.
boolean	isDerivedFromXSList()	Indicates whether the field described by this XMLFieldDescriptorImpl is created as a result of a invalid input: '<'xs:list> definition.
boolean	isIncremental()	Returns the incremental flag which when true indicates that this member may be safely added before the unmarshaler is finished unmarshaling it.
boolean	isMapped()	Returns true if the field described by this descriptor is Map or Hashtable.
boolean	isNillable()	Returns true if the field described by this descriptor may be nillable.
boolean	isReference()	Returns true if the field described by this descriptor is a reference (ie.
boolean	matches(String xmlName)	Returns true if this descriptor can be used to handle elements or attributes with the given XML name.
boolean	matches(String xmlName, String namespace)	Returns true if this descriptor can be used to handle elements or attributes with the given XML name.
void	setComponentType(String componentType)	Sets the type of the XML Schema type of the value for the field being described.
void	setConstructorArgumentIndex(int index)	Sets whether or not the value of the field represented by this FieldDescriptor should be set via the constructor of the containing ClassDescriptor.
void	setContainer(boolean isContainer)	Set if the field is a container field or not.
void	setDerivedFromXSList(boolean derivedFromXSList)	Sets whether the field described by this XMLFieldDescriptorImpl is created as a result of a invalid input: '<'xs:list> definition.
void	setIncremental(boolean incremental)	Sets the incremental flag which indicates whether this member can be added before the unmarshaler is finished unmarshaling it.
void	setLocationPath(String path)	Sets the location path for the field being described.
void	setMapped(boolean mapped)	Sets whether or not this field has been mapped in a Map or Hashtable.
void	setMatches(String matchExpr)	This is a space separated list of xml names that this Field descriptor matches.
void	setNameSpacePrefix(String nsPrefix)	Sets the namespace prefix used when marshaling as XML.
void	setNameSpaceURI(String nsURI)	Sets the namespace URI used when marshaling and unmarshaling as XML.
void	setNillable(boolean nillable)	Sets whether or not the described field is allowed to be nil.
void	setNodeType(NodeType nodeType)	Sets the XML node type for the described field.
void	setQNamePrefix(String qNamePrefix)	Sets the prefix used in case the value of the field described by this descriptor is of type QName.
void	setReference(boolean isReference)	Sets the flag indicating that the field described by this descriptor is a reference to another field in the object model.
void	setSchemaType(String schemaType)	Sets the type of the XML Schema type of the value for the field being described.
void	setSubstitutes(List<String> substitutes)	Sets the possible substitution groups for this class.
void	setUseParentsNamespace(boolean useParentsNamespace)	Sets whether or not the namespace for the parent "containing" class should be used during marshaling/unmarshaling when no specific namespace URI has been set for this field.
void	setValidator(FieldValidator validator)
void	setXMLName(String xmlName)	Sets the xml name for the described field.
void	setXMLProperty(String propertyName, String value)	Sets the value property with the given name.
String	toString()

Methods inherited from class FieldDescriptorImpl

addNature, getClassDescriptor, getCollection, getComparator, getContainingClassDescriptor, getCreateMethod, getFieldName, getFieldType, getGetMethod, getHandler, getProperty, getSetMethod, hasNature, isDirect, isIdentity, isImmutable, isLazy, isMultivalued, isRequired, isTransient, setClassDescriptor, setCollection, setComparator, setContainingClassDescriptor, setCreateMethod, setDirect, setFieldName, setFieldType, setGetMethod, setHandler, setIdentity, setImmutable, setLazy, setMultivalued, setProperty, setRequired, setSetMethod, setTransient

Modifier and Type	Method	Description
void	addNature(String nature)	Adds a specified nature.
final ClassDescriptor	getClassDescriptor()	Returns the class descriptor related to the field type.
FieldMappingCollectionType	getCollection()
String	getComparator()
final ClassDescriptor	getContainingClassDescriptor()	Get the class descriptor which contains this field.
String	getCreateMethod()
final String	getFieldName()	Returns the name of the field.
final Class<?>	getFieldType()	Returns the Java type of the field.
String	getGetMethod()
final FieldHandler	getHandler()	Returns the handler of the field.
Object	getProperty(String name)	Get a property by its name.
String	getSetMethod()
boolean	hasNature(String nature)	Checks if a specified nature has been added.
boolean	isDirect()
final boolean	isIdentity()	Is the described field is part of the identity of the class it belongs to?
final boolean	isImmutable()	Returns true if the field type is immutable.
boolean	isLazy()
final boolean	isMultivalued()	Returns true if the field is multivalued (a collection).
final boolean	isRequired()	Returns true if the field type is required.
final boolean	isTransient()	Returns true if the field is transient.
final void	setClassDescriptor(ClassDescriptor classDescriptor)	Set the ClassDescriptor for the described field.
void	setCollection(FieldMappingCollectionType collection)
void	setComparator(String comparator)
final void	setContainingClassDescriptor(ClassDescriptor parent)	Set the class descriptor which contains this field.
void	setCreateMethod(String createMethod)
void	setDirect(boolean direct)
final void	setFieldName(String fieldName)	Set the name of the field.
final void	setFieldType(Class<?> fieldType)	Set the type of the field.
void	setGetMethod(String getMethod)
final void	setHandler(FieldHandler handler)	Set the FieldHandler for the field being described by this FieldDescriptor.
final void	setIdentity(boolean identity)	Set wether the described field is part of the identity of the class it belongs to.
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.
void	setLazy(boolean lazy)
final void	setMultivalued(boolean multivalued)	Set wheter the object described by this descriptor is multivalued or not.
void	setProperty(String name, Object value)	Set a property specified by the name to the passed value.
final void	setRequired(boolean required)	Set whether or not the described field is required.
void	setSetMethod(String setMethod)
final void	setTransient(boolean isTransient)	Sets whether or not the describled field is 'transient'.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface XMLFieldDescriptor

isMultivalued

Modifier and Type	Method	Description
boolean	isMultivalued()	Returns true if the field described by this descriptor can contain more than one value.

Constructor Details

XMLContainerElementFieldDescriptor

public XMLContainerElementFieldDescriptor(XMLFieldDescriptorImpl fieldDesc,
 NodeType primitiveNodeType)
                                   throws MappingException

Throws:

MappingException