Class XMLClassDescriptorAdapter

java.lang.Object

org.exolab.castor.xml.Validator

org.exolab.castor.xml.util.XMLClassDescriptorImpl

org.exolab.castor.xml.util.XMLClassDescriptorAdapter

All Implemented Interfaces:

NatureExtendable, PropertyHolder, ClassDescriptor, TypeValidator, ClassValidator, XMLClassDescriptor

public class XMLClassDescriptorAdapter
extends XMLClassDescriptorImpl

An adapter class which can turn an ordinary ClassDescriptor into an XMLClassDescriptor.

Version:

$Revision: 7436 $ $Date: 2005-12-13 14:58:48 -0700 (Tue, 13 Dec 2005) $

Author:

Keith Visco

Field Summary

Fields inherited from class Validator

resourceBundle

Modifier and Type	Field	Description
protected static ResourceBundle	resourceBundle	resource bundle

Constructor Summary

Constructors

Constructor	Description
XMLClassDescriptorAdapter()
XMLClassDescriptorAdapter(ClassDescriptor classDesc, String xmlName)	Creates a new XMLClassDescriptorAdapter using the given ClassDescriptor.
XMLClassDescriptorAdapter(ClassDescriptor classDesc, String xmlName, NodeType primitiveNodeType)	Creates a new XMLClassDescriptorAdapter using the given ClassDescriptor.

Method Summary

Methods inherited from class XMLClassDescriptorImpl

addFieldDescriptor, addNature, addSequenceElement, canAccept, checkDescriptorForCorrectOrderWithinSequence, contains, getAccessMode, getAttributeDescriptors, getContentDescriptor, getElementDescriptors, getExtends, getFieldDescriptor, getFields, getIdentity, getJavaClass, getNameSpacePrefix, getNameSpaceURI, getProperty, getSubstitutes, getValidator, getXMLName, hasContainerFields, hasNature, isChoice, isElementDefinition, removeFieldDescriptor, setCompositorAsAll, setCompositorAsChoice, setCompositorAsSequence, setElementDefinition, setExtends, setExtendsWithoutFlatten, setIdentity, setIntrospected, setJavaClass, setNameSpacePrefix, setNameSpaceURI, setProperty, setSubstitutes, setXMLName, sortDescriptors, toString, validate, validate

Modifier and Type	Method	Description
void	addFieldDescriptor(XMLFieldDescriptor descriptor)	Adds the given XMLFieldDescriptor to the list of descriptors.
void	addNature(String nature)	Adds a specified nature.
protected void	addSequenceElement(XMLFieldDescriptor element)	Adds a XMLFieldDescriptor instance to the internally maintained list of sequence elements.
boolean	canAccept(String name, String namespace, Object object)	Returns true if the given object, represented by this XMLClassDescriptor, can accept a value for the member associated with the given xml name and namespace.
void	checkDescriptorForCorrectOrderWithinSequence(XMLFieldDescriptor elementDescriptor, UnmarshalState parentState, String xmlName)	Checks whether the given XMLFieldDescriptor is the one actually expected, given the natural order as defined by a sequence definition
boolean	contains(XMLFieldDescriptor descriptor)	Returns true if the given XMLFieldDescriptor is contained within this XMLClassDescriptor.
AccessMode	getAccessMode()	Returns the access mode specified for this class.
XMLFieldDescriptor[]	getAttributeDescriptors()	Returns the set of XMLFieldDescriptors for all members that should be marshalled as XML attributes.
XMLFieldDescriptor	getContentDescriptor()	Returns the XMLFieldDescriptor for the member that should be marshalled as text content.
XMLFieldDescriptor[]	getElementDescriptors()	Returns the set of XMLFieldDescriptors for all members that should be marshalled as XML elements.
ClassDescriptor	getExtends()	Returns the class descriptor of the class extended by this class.
XMLFieldDescriptor	getFieldDescriptor(String name, String namespace, NodeType nodeType)	Returns the XML field descriptor matching the given xml name and nodeType.
FieldDescriptor[]	getFields()	Returns a list of fields represented by this descriptor.
FieldDescriptor	getIdentity()	Returns the identity field, null if this class has no identity.
Class<?>	getJavaClass()	Returns the Java class represented by this descriptor.
String	getNameSpacePrefix()	Returns the namespace prefix to use when marshalling as XML.
String	getNameSpaceURI()	Returns the namespace URI used when marshalling and unmarshalling as XML.
Object	getProperty(String name)	Get a property by its name.
List<String>	getSubstitutes()
TypeValidator	getValidator()	Returns a specific validator for the class described by this ClassDescriptor.
String	getXMLName()	Returns the XML Name for the Class being described.
boolean	hasContainerFields()	Returns true if this XMLClassDescriptorImpl has any fields which are container objects.
boolean	hasNature(String nature)	Checks if a specified nature has been added.
boolean	isChoice()	Indicates whether the XML artifact described by this descriptor is a invalid input: '<'xsd:choice>.
boolean	isElementDefinition()	Returns true if XML schema definition of this Class is that of a global element or element with anonymous type definition.
boolean	removeFieldDescriptor(XMLFieldDescriptor descriptor)	Removes the given XMLFieldDescriptor from the list of descriptors.
void	setCompositorAsAll()	Sets the compositor for the fields of the described class to be ALL.
void	setCompositorAsChoice()	Sets the compositor for the fields of the described class to be CHOICE.
void	setCompositorAsSequence()	Sets the compositor for the fields of the described class to be a Sequence.
void	setElementDefinition(boolean elementDefinition)	Set elementDefinition to true to indicate Class XML schema definition is a global element or element with anonymous type.
void	setExtends(XMLClassDescriptor classDesc)	Sets the XMLClassDescriptor that this descriptor inherits from
protected void	setExtendsWithoutFlatten(XMLClassDescriptor classDesc)
void	setIdentity(XMLFieldDescriptor fieldDesc)	Sets the Identity FieldDescriptor, if the FieldDescriptor is not already a contained in this ClassDescriptor, it will be added
protected void	setIntrospected(boolean introspected)	Sets a flag to indicate whether or not this XMLClassDescriptorImpl was created via introspection
void	setJavaClass(Class<?> type)	Sets the Class type being described by this descriptor.
void	setNameSpacePrefix(String nsPrefix)	Sets the namespace prefix used when marshalling as XML.
void	setNameSpaceURI(String nsURI)	Sets the namespace URI used when marshalling and unmarshalling as XML.
void	setProperty(String name, Object value)	Set a property specified by the name to the passed value.
void	setSubstitutes(List<String> substitutes)
void	setXMLName(String xmlName)	Sets the XML name for the Class described by this XMLClassDescriptor
void	sortDescriptors()	This method is used to keep the set of descriptors in the proper sorted lists.
String	toString()	Returns the String representation of this XMLClassDescriptor
void	validate(Object object)	Validates the given Object
void	validate(Object object, ValidationContext context)	Validates the given object

Methods inherited from class Validator

checkUnresolvedIdrefs

Modifier and Type	Method	Description
void	checkUnresolvedIdrefs(ValidationContext context)

Methods inherited from class Object

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

Constructor Details

XMLClassDescriptorAdapter

public XMLClassDescriptorAdapter()

XMLClassDescriptorAdapter

public XMLClassDescriptorAdapter(ClassDescriptor classDesc,
 String xmlName)
                          throws MappingException

Creates a new XMLClassDescriptorAdapter using the given ClassDescriptor.

Parameters:

classDesc - the ClassDescriptor to "adapt"

xmlName - the XML name for the class

Throws:

MappingException

XMLClassDescriptorAdapter

public XMLClassDescriptorAdapter(ClassDescriptor classDesc,
 String xmlName,
 NodeType primitiveNodeType)
                          throws MappingException

Creates a new XMLClassDescriptorAdapter using the given ClassDescriptor.

Parameters:

classDesc - the ClassDescriptor to "adapt"

xmlName - the XML name for the class

primitiveNodeType - the NodeType to use for primitives

Throws:

MappingException