Inheritance diagram for org.exolab.castor.xml.util.XMLClassDescriptorImpl:

Public Member Functions
	XMLClassDescriptorImpl (Class type)
	XMLClassDescriptorImpl (Class type, String xmlName)
void	addFieldDescriptor (XMLFieldDescriptor descriptor)
boolean	contains (XMLFieldDescriptor descriptor)
XMLFieldDescriptor[]	getAttributeDescriptors ()
XMLFieldDescriptor	getContentDescriptor ()
XMLFieldDescriptor[]	getElementDescriptors ()
XMLFieldDescriptor	getFieldDescriptor (String name, String namespace, NodeType nodeType)
String	getNameSpacePrefix ()
String	getNameSpaceURI ()
TypeValidator	getValidator ()
String	getXMLName ()
boolean	hasContainerFields ()
boolean	removeFieldDescriptor (XMLFieldDescriptor descriptor)
void	setCompositorAsAll ()
void	setCompositorAsChoice ()
void	setCompositorAsSequence ()
void	setExtends (XMLClassDescriptor classDesc)
void	setIdentity (XMLFieldDescriptor fieldDesc)
void	setNameSpacePrefix (String nsPrefix)
void	setNameSpaceURI (String nsURI)
void	setXMLName (String xmlName)
void	sortDescriptors ()
String	toString ()
void	validate (Object object) throws ValidationException
void	validate (Object object, ValidationContext context) throws ValidationException
Class	getJavaClass ()
FieldDescriptor[]	getFields ()
ClassDescriptor	getExtends ()
FieldDescriptor	getIdentity ()
AccessMode	getAccessMode ()
boolean	canAccept (String name, String namespace, Object object)
Protected Member Functions
	XMLClassDescriptorImpl ()
void	setJavaClass (Class type)
void	setExtendsWithoutFlatten (XMLClassDescriptor classDesc)
void	setIntrospected (boolean introspected)
String	toXMLName (String className)
Static Package Functions
	[static initializer]
static boolean	isPrimitive (Class type)
static boolean	isDefaultPrimitiveValue (Object value)

Detailed Description

The core implementation of XMLClassDescriptor. This class is used by both generated source code as well as the XMLMappingLoader.

Author:: Keith Visco

Version:

Revision:: 1.8

Date:: 2004/12/17 05:47:37

Constructor & Destructor Documentation

org.exolab.castor.xml.util.XMLClassDescriptorImpl.XMLClassDescriptorImpl ( Class type )

Creates an XMLClassDescriptor class used by the Marshalling Framework.

Parameters:

type

the Class type with which this ClassDescriptor describes.

References org.exolab.castor.xml.util.XMLClassDescriptorImpl.setXMLName().

org.exolab.castor.xml.util.XMLClassDescriptorImpl.XMLClassDescriptorImpl	(	Class	type,
		String	xmlName
	)

Creates an XMLClassDescriptor class used by the Marshalling Framework.

Parameters:

type

the Class type with which this ClassDescriptor describes.

References org.exolab.castor.xml.util.XMLClassDescriptorImpl.setXMLName().

org.exolab.castor.xml.util.XMLClassDescriptorImpl.XMLClassDescriptorImpl ( ) [protected]

Protected constructor used by this class, and subclasses only

Member Function Documentation

org.exolab.castor.xml.util.XMLClassDescriptorImpl.[static initializer] ( ) [static, package]

Static initializer

void org.exolab.castor.xml.util.XMLClassDescriptorImpl.addFieldDescriptor ( XMLFieldDescriptor descriptor )

Adds the given XMLFieldDescriptor to the list of descriptors. The descriptor will be added to the appropriate list by calling XMLFieldDescriptor.getNodeType() to determine it's type.

Parameters:

descriptor

the XMLFieldDescriptor to add

boolean org.exolab.castor.xml.util.XMLClassDescriptorImpl.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.

An XMLClassDescriptor can accept a value for a field if it contains a descriptor that matches the given xml name and namespace and if the given object can hold this field (i.e a value is not already set for this field).

Parameters:

	name	the xml name of the field to check
	namespace	the namespace uri
	object	the object instance represented by this XMLCLassDescriptor

Returns:: true if the given object represented by this XMLClassDescriptor can accept a member whose name is given.

Implements org.exolab.castor.xml.XMLClassDescriptor.

boolean org.exolab.castor.xml.util.XMLClassDescriptorImpl.contains ( XMLFieldDescriptor descriptor )

Returns true if the given XMLFieldDescriptor is contained within this XMLClassDescriptor.

Returns:: true if the XMLFieldDescriptor is part of this XMLClassDescriptor, otherwise false.

References org.exolab.castor.xml.util.XMLFieldDescriptors.contains().

AccessMode org.exolab.castor.xml.util.XMLClassDescriptorImpl.getAccessMode ( )

Returns the access mode specified for this class.

Returns:: The access mode

Implements org.exolab.castor.mapping.ClassDescriptor.

XMLFieldDescriptor [] org.exolab.castor.xml.util.XMLClassDescriptorImpl.getAttributeDescriptors ( )

Returns the set of XMLFieldDescriptors for all members that should be marshalled as XML attributes.

Returns:: an array of XMLFieldDescriptors for all members that should be marshalled as XML attributes.

Implements org.exolab.castor.xml.XMLClassDescriptor.

XMLFieldDescriptor org.exolab.castor.xml.util.XMLClassDescriptorImpl.getContentDescriptor ( )

Returns the XMLFieldDescriptor for the member that should be marshalled as text content.

Returns:: the XMLFieldDescriptor for the member that should be marshalled as text content.

Implements org.exolab.castor.xml.XMLClassDescriptor.

XMLFieldDescriptor [] org.exolab.castor.xml.util.XMLClassDescriptorImpl.getElementDescriptors ( )

Returns the set of XMLFieldDescriptors for all members that should be marshalled as XML elements.

Returns:: an array of XMLFieldDescriptors for all members that should be marshalled as XML elements.

Implements org.exolab.castor.xml.XMLClassDescriptor.

ClassDescriptor org.exolab.castor.xml.util.XMLClassDescriptorImpl.getExtends ( )

Returns the class descriptor of the class extended by this class.

Returns:: The extended class descriptor

Implements org.exolab.castor.mapping.ClassDescriptor.

XMLFieldDescriptor org.exolab.castor.xml.util.XMLClassDescriptorImpl.getFieldDescriptor	(	String	name,
		String	namespace,
		NodeType	nodeType
	)

Returns the XML field descriptor matching the given xml name and nodeType. If NodeType is null, then either an AttributeDescriptor, or ElementDescriptor may be returned. Null is returned if no matching descriptor is available.

If an field is matched in one of the container field, it will return the container field that contain the field named 'name'

Parameters:

	name	the xml name to match against
	nodeType,the	NodeType to match against, or null if the node type is not known.

Returns:: the matching descriptor, or null if no matching descriptor is available.

Implements org.exolab.castor.xml.XMLClassDescriptor.

References org.exolab.castor.xml.NodeType.Attribute, org.exolab.castor.xml.NodeType.Element, org.exolab.castor.mapping.FieldDescriptor.getClassDescriptor(), org.exolab.castor.xml.XMLClassDescriptor.getFieldDescriptor(), org.exolab.castor.xml.XMLFieldDescriptor.getXMLName(), org.exolab.castor.xml.XMLFieldDescriptor.isContainer(), org.exolab.castor.xml.XMLFieldDescriptor.matches(), and org.exolab.castor.xml.NodeType.Namespace.

Referenced by org.exolab.castor.xml.util.XMLClassDescriptorImpl.canAccept().

FieldDescriptor [] org.exolab.castor.xml.util.XMLClassDescriptorImpl.getFields ( )

Returns a list of fields represented by this descriptor.

Returns:: A list of fields

Implements org.exolab.castor.mapping.ClassDescriptor.

References org.exolab.castor.xml.util.XMLFieldDescriptors.size(), and org.exolab.castor.xml.util.XMLFieldDescriptors.toArray().

Referenced by org.exolab.castor.xml.XMLMappingLoader.createDescriptor().

FieldDescriptor org.exolab.castor.xml.util.XMLClassDescriptorImpl.getIdentity ( )

Returns the identity field, null if this class has no identity.

Returns:: The identity field

Implements org.exolab.castor.mapping.ClassDescriptor.

Class org.exolab.castor.xml.util.XMLClassDescriptorImpl.getJavaClass ( )

Returns the Java class represented by this descriptor.

Returns:: The Java class

Implements org.exolab.castor.mapping.ClassDescriptor.

Referenced by org.exolab.castor.xml.XMLMappingLoader.createDescriptor(), and org.exolab.castor.xml.util.XMLClassDescriptorImpl.validate().

String org.exolab.castor.xml.util.XMLClassDescriptorImpl.getNameSpacePrefix ( )

Returns:: the namespace prefix to use when marshalling as XML.

Implements org.exolab.castor.xml.XMLClassDescriptor.

String org.exolab.castor.xml.util.XMLClassDescriptorImpl.getNameSpaceURI ( )

Returns:: the namespace URI used when marshalling and unmarshalling as XML.

Implements org.exolab.castor.xml.XMLClassDescriptor.

TypeValidator org.exolab.castor.xml.util.XMLClassDescriptorImpl.getValidator ( )

Returns a specific validator for the class described by this ClassDescriptor. A null value may be returned if no specific validator exists.

Returns:: the type validator for the class described by this ClassDescriptor.

Implements org.exolab.castor.xml.XMLClassDescriptor.

String org.exolab.castor.xml.util.XMLClassDescriptorImpl.getXMLName ( )

Returns the XML Name for the Class being described.

Returns:: the XML name.

Implements org.exolab.castor.xml.XMLClassDescriptor.

Referenced by org.exolab.castor.xml.util.XMLClassDescriptorImpl.validate().

boolean org.exolab.castor.xml.util.XMLClassDescriptorImpl.hasContainerFields ( )

Returns true if this XMLClassDescriptorImpl has any fields which are container objects. A container object is a Java object which holds data the should be marshalled, but the object itself should not be. So the container object will be "unwrapped" and the fields associated with the container will appear as if they were part of this class.

Returns:: true if any of the fields are container fields, otherwise false.

static boolean org.exolab.castor.xml.util.XMLClassDescriptorImpl.isDefaultPrimitiveValue ( Object value ) [static, package]

Checks to see if the given Object is a java primitive (does not check for primitive wrappers) and has a value that is equal to the default value for that primitive. This method will return true if the value is a java primitive with a default value.

Returns:: true if the value is a java primitive with a default value

Referenced by org.exolab.castor.xml.util.XMLClassDescriptorImpl.canAccept().

static boolean org.exolab.castor.xml.util.XMLClassDescriptorImpl.isPrimitive ( Class type ) [static, package]

Returns true if the given class should be treated as a primitive type. This method will return true for all Java primitive types, the set of primitive object wrappers, as well as Strings.

Returns:: true if the given class should be treated as a primitive type

boolean org.exolab.castor.xml.util.XMLClassDescriptorImpl.removeFieldDescriptor ( XMLFieldDescriptor descriptor )

Removes the given XMLFieldDescriptor from the list of descriptors.

Parameters:

descriptor

the XMLFieldDescriptor to remove

Returns:: true if the descriptor was removed.

References org.exolab.castor.xml.XMLFieldDescriptor.getNodeType(), org.exolab.castor.xml.NodeType.getType(), org.exolab.castor.xml.XMLFieldDescriptor.isContainer(), org.exolab.castor.xml.NodeType.NAMESPACE, and org.exolab.castor.xml.util.XMLFieldDescriptors.remove().

Referenced by org.exolab.castor.xml.util.XMLClassDescriptorImpl.setExtends().

void org.exolab.castor.xml.util.XMLClassDescriptorImpl.setCompositorAsAll ( )

Sets the compositor for the fields of the described class to be ALL.

void org.exolab.castor.xml.util.XMLClassDescriptorImpl.setCompositorAsChoice ( )

Sets the compositor for the fields of the described class to be CHOICE.

Referenced by org.exolab.castor.builder.binding.ComponentBindingTypeChoiceDescriptor.ComponentBindingTypeChoiceDescriptor(), and org.exolab.castor.builder.binding.PackageTypeChoiceDescriptor.PackageTypeChoiceDescriptor().

void org.exolab.castor.xml.util.XMLClassDescriptorImpl.setCompositorAsSequence ( )

Sets the compositor for the fields of the described class to be a Sequence.

Referenced by org.exolab.castor.builder.binding.BindingDescriptor.BindingDescriptor(), org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor(), org.exolab.castor.builder.binding.ClassTypeDescriptor.ClassTypeDescriptor(), org.exolab.castor.builder.binding.ComponentBindingTypeDescriptor.ComponentBindingTypeDescriptor(), alma.acs.tools.comphelpergen.generated.ComponentHelperInfoDescriptor.ComponentHelperInfoDescriptor(), alma.tools.entitybuilder.generated.EntitybuilderSettingsDescriptor.EntitybuilderSettingsDescriptor(), org.exolab.castor.builder.binding.NamingTypeDescriptor.NamingTypeDescriptor(), org.exolab.castor.builder.binding.NamingXMLTypeDescriptor.NamingXMLTypeDescriptor(), org.exolab.castor.builder.binding.PackageTypeDescriptor.PackageTypeDescriptor(), and org.exolab.castor.mapping.xml.PropertyTypeDescriptor.PropertyTypeDescriptor().

void org.exolab.castor.xml.util.XMLClassDescriptorImpl.setExtends ( XMLClassDescriptor classDesc )

Sets the XMLClassDescriptor that this descriptor inherits from

Parameters:

classDesc

the XMLClassDescriptor that this descriptor extends

References org.exolab.castor.xml.util.XMLClassDescriptorImpl.addFieldDescriptor(), org.exolab.castor.mapping.ClassDescriptor.getFields(), org.exolab.castor.xml.util.XMLClassDescriptorImpl.removeFieldDescriptor(), and org.exolab.castor.xml.util.XMLClassDescriptorImpl.sortDescriptors().

Referenced by org.exolab.castor.xml.Introspector.generateClassDescriptor().

void org.exolab.castor.xml.util.XMLClassDescriptorImpl.setExtendsWithoutFlatten ( XMLClassDescriptor classDesc ) [protected]

Referenced by org.exolab.castor.mapping.xml.PropertyDescriptor.PropertyDescriptor().

void org.exolab.castor.xml.util.XMLClassDescriptorImpl.setIdentity ( XMLFieldDescriptor fieldDesc )

Sets the Identity FieldDescriptor, if the FieldDescriptor is not already a contained in this ClassDescriptor, it will be added

References org.exolab.castor.xml.util.XMLClassDescriptorImpl.addFieldDescriptor(), and org.exolab.castor.xml.util.XMLFieldDescriptors.contains().

Referenced by org.exolab.castor.xml.XMLMappingLoader.createDescriptor().

void org.exolab.castor.xml.util.XMLClassDescriptorImpl.setIntrospected ( boolean introspected ) [protected]

Sets a flag to indicate whether or not this XMLClassDescriptorImpl was created via introspection

Parameters:

introspected

a boolean, when true indicated that this XMLClassDescriptor was created via introspection

Referenced by org.exolab.castor.xml.IntrospectedXMLClassDescriptor.IntrospectedXMLClassDescriptor().

void org.exolab.castor.xml.util.XMLClassDescriptorImpl.setJavaClass ( Class type ) [protected]

Sets the Class type being described by this descriptor.

the Class type being described

Referenced by org.exolab.castor.xml.util.XMLClassDescriptorAdapter.XMLClassDescriptorAdapter().

void org.exolab.castor.xml.util.XMLClassDescriptorImpl.setNameSpacePrefix ( String nsPrefix )

Sets the namespace prefix used when marshalling as XML.

Parameters:

nsPrefix

the namespace prefix used when marshalling the "described" object

Referenced by org.exolab.castor.xml.XMLMappingLoader.createDescriptor().

void org.exolab.castor.xml.util.XMLClassDescriptorImpl.setNameSpaceURI ( String nsURI )

Sets the namespace URI used when marshalling and unmarshalling as XML.

Parameters:

nsURI

the namespace URI used when marshalling and unmarshalling the "described" Object.

Referenced by org.exolab.castor.xml.XMLMappingLoader.createDescriptor().

void org.exolab.castor.xml.util.XMLClassDescriptorImpl.setXMLName ( String xmlName )

Sets the validator to use for the class described by this ClassDescriptor

Parameters:

	validator	the validator to use when peforming validation of the described class. This may be null to signal default validation. Sets the XML name for the Class described by this XMLClassDescriptor
	xmlName	the XML name for the Class described by this XMLClassDescriptor

References org.exolab.castor.xml.util.XMLClassDescriptorImpl.toXMLName().

Referenced by org.exolab.castor.xml.util.XMLClassDescriptorAdapter.XMLClassDescriptorAdapter(), and org.exolab.castor.xml.util.XMLClassDescriptorImpl.XMLClassDescriptorImpl().

void org.exolab.castor.xml.util.XMLClassDescriptorImpl.sortDescriptors ( )

This method is used to keep the set of descriptors in the proper sorted lists. If you dynamically change the NodeType of an XMLFieldDescriptor after adding it the this ClassDescriptor, then call this method.

References org.exolab.castor.xml.util.XMLFieldDescriptors.add(), org.exolab.castor.xml.XMLFieldDescriptor.getNodeType(), org.exolab.castor.xml.NodeType.getType(), and org.exolab.castor.xml.util.XMLFieldDescriptors.remove().

Referenced by org.exolab.castor.xml.util.XMLClassDescriptorImpl.setExtends().

String org.exolab.castor.xml.util.XMLClassDescriptorImpl.toString ( )

Returns the String representation of this XMLClassDescriptor