org.exolab.castor.xml.descriptors

Class StringClassDescriptor

public class StringClassDescriptor extends Object implements XMLClassDescriptor

The default String class descriptor

Version: $Revision: 1.2 $ $Date: 2004/12/17 05:44:43 $

Author: Keith Visco

Constructor Summary
StringClassDescriptor()
Method Summary
booleancanAccept(String name, String namespace, Object object)

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

AccessModegetAccessMode()
Returns the access mode specified for this class.
XMLFieldDescriptor[]getAttributeDescriptors()
Returns the set of attribute XMLFieldDescriptors
XMLFieldDescriptorgetContentDescriptor()
Returns the descriptor for dealing with Text content
XMLFieldDescriptor[]getElementDescriptors()
Returns the set of element MarshalDescriptors
ClassDescriptorgetExtends()
Returns the class descriptor of the class extended by this class.
XMLFieldDescriptorgetFieldDescriptor(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.
FieldDescriptorgetIdentity()
Returns the identity field, null if this class has no identity.
ClassgetJavaClass()
Returns the Class that this ClassDescriptor describes
StringgetNameSpacePrefix()
StringgetNameSpaceURI()
TypeValidatorgetValidator()
Returns a specific validator for the class described by this ClassDescriptor.
StringgetXMLName()
Returns the XML Name for the Class being described.
voidsetNameSpaceURI(String nsURI)
Sets the desired namespace URI for the described object
voidsetValidator(StringValidator validator)
voidsetXMLName(String xmlName)
Sets the XML Name for the described object.

Constructor Detail

StringClassDescriptor

public StringClassDescriptor()

Method Detail

canAccept

public boolean canAccept(String name, String namespace, 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.

Parameters: name the xml name of the field to check namespace the namespace uri 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.

getAccessMode

public AccessMode getAccessMode()
Returns the access mode specified for this class.

Returns: The access mode

getAttributeDescriptors

public XMLFieldDescriptor[] getAttributeDescriptors()
Returns the set of attribute XMLFieldDescriptors

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

getContentDescriptor

public XMLFieldDescriptor getContentDescriptor()
Returns the descriptor for dealing with Text content

Returns: the XMLFieldDescriptor for dealing with Text content

getElementDescriptors

public XMLFieldDescriptor[] getElementDescriptors()
Returns the set of element MarshalDescriptors

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.

Returns: The extended class descriptor

getFieldDescriptor

public XMLFieldDescriptor 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.

Parameters: name the xml name to match against namespace the namespace uri 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.

getFields

public FieldDescriptor[] getFields()
Returns a list of fields represented by this descriptor.

Returns: A list of fields

getIdentity

public FieldDescriptor getIdentity()
Returns the identity field, null if this class has no identity.

Returns: The identity field

getJavaClass

public Class getJavaClass()
Returns the Class that this ClassDescriptor describes

Returns: the Class that this ClassDescriptor describes

getNameSpacePrefix

public String getNameSpacePrefix()

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

getNameSpaceURI

public String getNameSpaceURI()

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

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.

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

getXMLName

public String getXMLName()
Returns the XML Name for the Class being described.

Returns: the XML name.

setNameSpaceURI

public void setNameSpaceURI(String nsURI)
Sets the desired namespace URI for the described object

Parameters: nsURI is the desired namespace URI

setValidator

public void setValidator(StringValidator validator)

setXMLName

public void setXMLName(String xmlName)
Sets the XML Name for the described object.

Parameters: xmlName the XML name to use for the described object.

Intalio Inc. (C) 1999-2004. All rights reserved http://www.intalio.com