org.exolab.castor.types
Class TimePeriodDescriptor

java.lang.Object
  |
  +--org.exolab.castor.types.TimePeriodDescriptor

public class TimePeriodDescriptor
extends java.lang.Object
implements XMLClassDescriptor

The Time Descriptor

Version:
$Revision: 1.4 $ $Date: 2000/12/06 22:19:49 $
Author:
Keith Visco
See Also:
TimeDurationDescriptor

Constructor Summary
TimePeriodDescriptor()
           
 
Method Summary
 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, 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()
           
 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.
 java.lang.String toString()
          Returns the String representation of this XMLClassDescriptor
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TimePeriodDescriptor

public TimePeriodDescriptor()
Method Detail

getAttributeDescriptors

public XMLFieldDescriptor[] getAttributeDescriptors()
Returns the set of XMLFieldDescriptors for all members that should be marshalled as XML attributes.
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()
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()
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.

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

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.

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.

toString

public java.lang.String toString()
Returns the String representation of this XMLClassDescriptor
Overrides:
toString in class java.lang.Object
Returns:
the String representation of this XMLClassDescriptor

getJavaClass

public java.lang.Class getJavaClass()
Returns the Java class represented by this descriptor.
Returns:
The Java class

getFields

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

getExtends

public ClassDescriptor getExtends()
Returns the class descriptor of the class extended by this class.
Returns:
The extended class descriptor

getIdentity

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

getAccessMode

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


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