org.exolab.castor.xml
Interface XMLClassDescriptor

All Superinterfaces:
ClassDescriptor
All Known Implementing Classes:
CenturyDescriptor, DatabaseDescriptor, DataSourceDescriptor, DateDescriptor, DriverDescriptor, DurationDescriptor, GDayDescriptor, GMonthDayDescriptor, GMonthDescriptor, GYearDescriptor, GYearMonthDescriptor, JndiDescriptor, MappingDescriptor, MonthDescriptor, ParamDescriptor, RecurringDurationDescriptor, StringClassDescriptor, TimeDescriptor, TimeDurationDescriptor, TimePeriodDescriptor, VectorClassDescriptor, XMLClassDescriptorImpl, YearDescriptor

public interface XMLClassDescriptor
extends ClassDescriptor

A class descriptor for describing relationships between a Class and an XML element. Implements ClassDescriptor All fields are of type XMLFieldDescriptor. This interface used to be "MarshalInfo".

Version:
$Revision: 1.4 $ $Date: 2000/11/23 03:29:01 $
Author:
Keith Visco

Method Summary
 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.
 XMLFieldDescriptor getFieldDescriptor(java.lang.String name, NodeType nodeType)
          Returns the XML field descriptor matching the given xml name and nodeType.
 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.
 
Methods inherited from interface org.exolab.castor.mapping.ClassDescriptor
getAccessMode, getExtends, getFields, getIdentity, getJavaClass
 

Method Detail

getAttributeDescriptors

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

getContentDescriptor

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

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.

Parameters:
name - the xml name to match against
Returns:
the matching descriptor, or null if no matching descriptor is available.

getElementDescriptors

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

getNameSpacePrefix

public java.lang.String getNameSpacePrefix()
Returns:
the namespace prefix to use when marshalling as XML.

getNameSpaceURI

public java.lang.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 java.lang.String getXMLName()
Returns the XML Name for the Class being described.

Returns:
the XML name.


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