org.exolab.castor.xml.descriptors
Class StringClassDescriptor

java.lang.Object
  org.exolab.castor.xml.descriptors.StringClassDescriptor

All Implemented Interfaces:

ClassDescriptor, XMLClassDescriptor

public class StringClassDescriptor

extends java.lang.Object

implements XMLClassDescriptor

The default String class descriptor

Version:

$Revision: 1.1.1.1 $ $Date: 2003/03/03 07:09:18 $

Author:

Keith Visco

Constructor Summary

StringClassDescriptor()

Method Summary

boolean	canAccept(java.lang.String fieldName, java.lang.Object object) Returns true if the given object represented by this XMLClassDescriptor can accept a member whose name is given.
AccessMode	getAccessMode() Returns the access mode specified for this class.
XMLFieldDescriptor[]	getAttributeDescriptors() Returns the set of attribute XMLFieldDescriptors
XMLFieldDescriptor	getContentDescriptor() Returns the descriptor for dealing with Text content
XMLFieldDescriptor[]	getElementDescriptors() Returns the set of element MarshalDescriptors
ClassDescriptor	getExtends() Returns the class descriptor of the class extended by this class.
XMLFieldDescriptor	getFieldDescriptor(java.lang.String name, 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.
java.lang.Class	getJavaClass() Returns the Class that this ClassDescriptor describes
java.lang.String	getNameSpacePrefix()
java.lang.String	getNameSpaceURI()
TypeValidator	getValidator() Returns a specific validator for the class described by this ClassDescriptor.
java.lang.String	getXMLName() Returns the XML Name for the Class being described.
void	setNameSpaceURI(java.lang.String nsURI) Sets the desired namespace URI for the described object
void	setValidator(StringValidator validator)
void	setXMLName(java.lang.String xmlName) Sets the XML Name for the described object.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringClassDescriptor

public StringClassDescriptor()

Method Detail

getAttributeDescriptors

public XMLFieldDescriptor[] getAttributeDescriptors()

Returns the set of attribute XMLFieldDescriptors

Specified by:

getAttributeDescriptors in interface XMLClassDescriptor

Returns:

an array of XMLFieldDescriptors for all members that should be marshalled as attributes

getJavaClass

public java.lang.Class getJavaClass()

Returns the Class that this ClassDescriptor describes

Specified by:

getJavaClass in interface ClassDescriptor

Returns:

the Class that this ClassDescriptor describes

getElementDescriptors

public XMLFieldDescriptor[] getElementDescriptors()

Returns the set of element MarshalDescriptors

Specified by:

getElementDescriptors in interface XMLClassDescriptor

Returns:

an array of MarshalDescriptors for all members that should be marshalled as Elements

getExtends

public ClassDescriptor getExtends()

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

Specified by:

getExtends in interface ClassDescriptor

Returns:

The extended class descriptor

getFields

public FieldDescriptor[] getFields()

Returns a list of fields represented by this descriptor.

Specified by:

getFields in interface ClassDescriptor

Returns:

A list of fields

getContentDescriptor

public XMLFieldDescriptor getContentDescriptor()

Returns the descriptor for dealing with Text content

Specified by:

getContentDescriptor in interface XMLClassDescriptor

Returns:

the XMLFieldDescriptor for dealing with Text content

getFieldDescriptor

public XMLFieldDescriptor getFieldDescriptor(java.lang.String name,
                                             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.

Specified by:

getFieldDescriptor in interface XMLClassDescriptor

Parameters:

name - the xml name to match against

Returns:

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

getNameSpacePrefix

public java.lang.String getNameSpacePrefix()

Specified by:

getNameSpacePrefix in interface XMLClassDescriptor

Returns:

the namespace prefix to use when marshalling as XML.

getNameSpaceURI

public java.lang.String getNameSpaceURI()

Specified by:

getNameSpaceURI in interface XMLClassDescriptor

Returns:

the namespace URI used when marshalling and unmarshalling as XML.

getIdentity

public FieldDescriptor getIdentity()

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

Specified by:

getIdentity in interface ClassDescriptor

Returns:

The identity field

getAccessMode

public AccessMode getAccessMode()

Returns the access mode specified for this class.

Specified by:

getAccessMode in interface ClassDescriptor

Returns:

The access mode

getValidator

public TypeValidator getValidator()

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

Specified by:

getValidator in interface XMLClassDescriptor

Returns:

the type validator for the class described by this ClassDescriptor.

getXMLName

public java.lang.String getXMLName()

Returns the XML Name for the Class being described.

Specified by:

getXMLName in interface XMLClassDescriptor

Returns:

the XML name.

setValidator

public void setValidator(StringValidator validator)

setXMLName

public void setXMLName(java.lang.String xmlName)

Sets the XML Name for the described object.

Parameters:

xmlName - the XML name to use for the described object.

setNameSpaceURI

public void setNameSpaceURI(java.lang.String nsURI)

Sets the desired namespace URI for the described object

Parameters:

nsURI - is the desired namespace URI

canAccept

public boolean canAccept(java.lang.String fieldName,
                         java.lang.Object object)

Returns true if the given object represented by this XMLClassDescriptor can accept a member whose name is given. An XMLClassDescriptor can accept a field if it contains a descriptor that matches the given name and if the given object can hold this field (i.e a value is not already set for this field).

This is mainly used for container object (that can contains other object), in this particular case the implementation will return null.

Specified by:

canAccept in interface XMLClassDescriptor

Parameters:

fieldName - the name of the field to check

object - the object represented by this XMLCLassDescriptor

Returns:

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