org.exolab.castor.jdo.conf
Class DriverDescriptor

java.lang.Object
  org.exolab.castor.jdo.conf.DriverDescriptor

All Implemented Interfaces:

ClassDescriptor, XMLClassDescriptor

public class DriverDescriptor
extends java.lang.Object
implements XMLClassDescriptor

Version:

$Revision: 1.2 $ $Date: 2004/12/17 05:47:55 $

Constructor Summary

DriverDescriptor()

Method Summary

boolean	canAccept(java.lang.String name, java.lang.String namespace, java.lang.Object object) false
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(java.lang.String name, java.lang.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.
java.lang.Class	getJavaClass() Returns the Java class represented by this descriptor.
java.lang.String	getNameSpacePrefix() Returns the namespace prefix to use when marshalling as XML.
java.lang.String	getNameSpaceURI() Returns the namespace URI used when marshalling and unmarshalling as XML.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DriverDescriptor

public DriverDescriptor()

Method Detail

getAccessMode

public AccessMode getAccessMode()

Description copied from interface: ClassDescriptor

Returns the access mode specified for this class.

Specified by:

getAccessMode in interface ClassDescriptor

Returns:

The access mode

getAttributeDescriptors

public XMLFieldDescriptor[] getAttributeDescriptors()

Description copied from interface: XMLClassDescriptor

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

Specified by:

getAttributeDescriptors in interface XMLClassDescriptor

Returns:

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

getContentDescriptor

public XMLFieldDescriptor getContentDescriptor()

Description copied from interface: XMLClassDescriptor

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

Specified by:

getContentDescriptor in interface XMLClassDescriptor

Returns:

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

getElementDescriptors

public XMLFieldDescriptor[] getElementDescriptors()

Description copied from interface: XMLClassDescriptor

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

Specified by:

getElementDescriptors in interface XMLClassDescriptor

Returns:

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

getExtends

public ClassDescriptor getExtends()

Description copied from interface: ClassDescriptor

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()

Description copied from interface: ClassDescriptor

Returns a list of fields represented by this descriptor.

Specified by:

getFields in interface ClassDescriptor

Returns:

A list of fields

getIdentity

public FieldDescriptor getIdentity()

Description copied from interface: ClassDescriptor

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

Specified by:

getIdentity in interface ClassDescriptor

Returns:

The identity field

getFieldDescriptor

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

Specified by:

getFieldDescriptor in interface XMLClassDescriptor

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.

getJavaClass

public java.lang.Class getJavaClass()

Description copied from interface: ClassDescriptor

Returns the Java class represented by this descriptor.

Specified by:

getJavaClass in interface ClassDescriptor

Returns:

The Java class

getNameSpacePrefix

public java.lang.String getNameSpacePrefix()

Description copied from interface: XMLClassDescriptor

Returns the namespace prefix to use when marshalling as XML.

Specified by:

getNameSpacePrefix in interface XMLClassDescriptor

Returns:

the namespace prefix to use when marshalling as XML.

getNameSpaceURI

public java.lang.String getNameSpaceURI()

Description copied from interface: XMLClassDescriptor

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

Specified by:

getNameSpaceURI in interface XMLClassDescriptor

Returns:

the namespace URI used when marshalling and unmarshalling as XML.

getValidator

public TypeValidator getValidator()

Description copied from interface: XMLClassDescriptor

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()

Description copied from interface: XMLClassDescriptor

Returns the XML Name for the Class being described.

Specified by:

getXMLName in interface XMLClassDescriptor

Returns:

the XML name.

canAccept

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

false

Specified by:

canAccept in interface XMLClassDescriptor

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.