Public Member Functions

org.exolab.castor.xml.XMLClassDescriptor Interface Reference

Inheritance diagram for org.exolab.castor.xml.XMLClassDescriptor:
org.exolab.castor.mapping.ClassDescriptor org.exolab.castor.types.BaseDescriptor org.exolab.castor.xml.descriptors.DateClassDescriptor org.exolab.castor.xml.descriptors.ListClassDescriptor org.exolab.castor.xml.descriptors.LocaleDescriptor org.exolab.castor.xml.descriptors.RootArrayDescriptor org.exolab.castor.xml.descriptors.SQLDateClassDescriptor org.exolab.castor.xml.descriptors.SQLTimeClassDescriptor org.exolab.castor.xml.descriptors.SQLTimestampClassDescriptor org.exolab.castor.xml.descriptors.StringClassDescriptor org.exolab.castor.xml.descriptors.VectorClassDescriptor org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor org.exolab.castor.xml.util.XMLClassDescriptorImpl

List of all members.

Public Member Functions

XMLFieldDescriptor[] getAttributeDescriptors ()
XMLFieldDescriptor getContentDescriptor ()
XMLFieldDescriptor[] getElementDescriptors ()
XMLFieldDescriptor getFieldDescriptor (String name, String namespace, NodeType nodeType)
String getNameSpacePrefix ()
String getNameSpaceURI ()
TypeValidator getValidator ()
String getXMLName ()
boolean canAccept (String name, String namespace, Object object)

Detailed Description

A class descriptor for describing relationships between a Class and an XML element or complexType. This class implements org.exolab.castor.mapping.ClassDescriptor, yet adds extra methods for handling XML. All fields are of type XMLFieldDescriptor.

Author:
Keith Visco
Version:
Revision:
1.2
Date:
2004/12/17 05:42:04

Member Function Documentation

boolean org.exolab.castor.xml.XMLClassDescriptor.canAccept ( String  name,
String  namespace,
Object  object 
)

Returns true if the given object, represented by this XMLClassDescriptor, can accept a value for the member associated with the given xml name and namespace.

An XMLClassDescriptor can accept a value for a field if it contains a descriptor that matches the given xml name and namespace and if the given object can hold this field (i.e a value is not already set for this field).

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.

Implemented in org.exolab.castor.types.BaseDescriptor, org.exolab.castor.xml.descriptors.DateClassDescriptor, org.exolab.castor.xml.descriptors.ListClassDescriptor, org.exolab.castor.xml.descriptors.LocaleDescriptor, org.exolab.castor.xml.descriptors.RootArrayDescriptor, org.exolab.castor.xml.descriptors.SQLDateClassDescriptor, org.exolab.castor.xml.descriptors.SQLTimeClassDescriptor, org.exolab.castor.xml.descriptors.SQLTimestampClassDescriptor, org.exolab.castor.xml.descriptors.StringClassDescriptor, org.exolab.castor.xml.descriptors.VectorClassDescriptor, org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor, and org.exolab.castor.xml.util.XMLClassDescriptorImpl.

Referenced by org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor.canAccept().

XMLFieldDescriptor org.exolab.castor.xml.XMLClassDescriptor.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.

Implemented in org.exolab.castor.types.BaseDescriptor, org.exolab.castor.types.CenturyDescriptor, org.exolab.castor.types.DateDescriptor, org.exolab.castor.types.DurationDescriptor, org.exolab.castor.types.GDayDescriptor, org.exolab.castor.types.GMonthDayDescriptor, org.exolab.castor.types.GMonthDescriptor, org.exolab.castor.types.GYearDescriptor, org.exolab.castor.types.GYearMonthDescriptor, org.exolab.castor.types.MonthDescriptor, org.exolab.castor.types.RecurringDurationDescriptor, org.exolab.castor.types.TimeDescriptor, org.exolab.castor.types.TimeDurationDescriptor, org.exolab.castor.types.TimePeriodDescriptor, org.exolab.castor.types.YearDescriptor, org.exolab.castor.xml.descriptors.DateClassDescriptor, org.exolab.castor.xml.descriptors.ListClassDescriptor, org.exolab.castor.xml.descriptors.LocaleDescriptor, org.exolab.castor.xml.descriptors.RootArrayDescriptor, org.exolab.castor.xml.descriptors.SQLDateClassDescriptor, org.exolab.castor.xml.descriptors.SQLTimeClassDescriptor, org.exolab.castor.xml.descriptors.SQLTimestampClassDescriptor, org.exolab.castor.xml.descriptors.StringClassDescriptor, org.exolab.castor.xml.descriptors.VectorClassDescriptor, org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor, and org.exolab.castor.xml.util.XMLClassDescriptorImpl.

Referenced by org.exolab.castor.xml.XMLMappingLoader.createDescriptor(), org.exolab.castor.xml.UnmarshalHandler.endElement(), org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor.getContentDescriptor(), and org.exolab.castor.xml.MarshalFramework.hasFieldsAtLocation().

XMLFieldDescriptor org.exolab.castor.xml.XMLClassDescriptor.getFieldDescriptor ( String  name,
String  namespace,
NodeType  nodeType 
)
String org.exolab.castor.xml.XMLClassDescriptor.getNameSpacePrefix (  ) 

Returns the namespace prefix to use when marshalling as XML.

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

Implemented in alma.acs.tools.comphelpergen.generated.ComponentHelperInfoDescriptor, alma.acs.tools.comphelpergen.generated.ComponentInterfaceDescriptor, alma.tools.entitybuilder.generated.EntitybuilderSettingsDescriptor, alma.tools.entitybuilder.generated.EntitySchemaDescriptor, alma.tools.entitybuilder.generated.XmlNamespace2JPackageDescriptor, org.exolab.castor.builder.binding.BindingDescriptor, org.exolab.castor.builder.binding.ClassTypeDescriptor, org.exolab.castor.builder.binding.ComponentBindingTypeChoiceDescriptor, org.exolab.castor.builder.binding.ComponentBindingTypeDescriptor, org.exolab.castor.builder.binding.FieldTypeDescriptor, org.exolab.castor.builder.binding.IncludeTypeDescriptor, org.exolab.castor.builder.binding.InterfaceDescriptor, org.exolab.castor.builder.binding.NamingTypeDescriptor, org.exolab.castor.builder.binding.NamingXMLTypeDescriptor, org.exolab.castor.builder.binding.PackageTypeChoiceDescriptor, org.exolab.castor.builder.binding.PackageTypeDescriptor, org.exolab.castor.builder.binding.PathTypeDescriptor, org.exolab.castor.builder.binding.types.BindingTypeDescriptor, org.exolab.castor.builder.binding.types.FieldTypeCollectionTypeDescriptor, org.exolab.castor.mapping.xml.BindXmlDescriptor, org.exolab.castor.mapping.xml.CacheTypeMappingDescriptor, org.exolab.castor.mapping.xml.ClassMappingDescriptor, org.exolab.castor.mapping.xml.ContainerDescriptor, org.exolab.castor.mapping.xml.FieldMappingDescriptor, org.exolab.castor.mapping.xml.IncludeDescriptor, org.exolab.castor.mapping.xml.KeyGeneratorDefDescriptor, org.exolab.castor.mapping.xml.LdapDescriptor, org.exolab.castor.mapping.xml.MappingRootDescriptor, org.exolab.castor.mapping.xml.MapToDescriptor, org.exolab.castor.mapping.xml.ParamDescriptor, org.exolab.castor.mapping.xml.PropertyDescriptor, org.exolab.castor.mapping.xml.PropertyTypeDescriptor, org.exolab.castor.mapping.xml.SqlDescriptor, org.exolab.castor.mapping.xml.types.AccessTypeDescriptor, org.exolab.castor.mapping.xml.types.BindXmlAutoNamingTypeDescriptor, org.exolab.castor.mapping.xml.types.BindXmlNodeTypeDescriptor, org.exolab.castor.mapping.xml.types.CollectionTypeDescriptor, org.exolab.castor.mapping.xml.types.DirtyTypeDescriptor, org.exolab.castor.mapping.xml.types.TypeTypeDescriptor, org.exolab.castor.types.BaseDescriptor, org.exolab.castor.xml.descriptors.DateClassDescriptor, org.exolab.castor.xml.descriptors.ListClassDescriptor, org.exolab.castor.xml.descriptors.LocaleDescriptor, org.exolab.castor.xml.descriptors.RootArrayDescriptor, org.exolab.castor.xml.descriptors.SQLDateClassDescriptor, org.exolab.castor.xml.descriptors.SQLTimeClassDescriptor, org.exolab.castor.xml.descriptors.SQLTimestampClassDescriptor, org.exolab.castor.xml.descriptors.StringClassDescriptor, org.exolab.castor.xml.descriptors.VectorClassDescriptor, org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor, and org.exolab.castor.xml.util.XMLClassDescriptorImpl.

Referenced by org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor.getNameSpacePrefix().

String org.exolab.castor.xml.XMLClassDescriptor.getNameSpaceURI (  ) 

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

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

Implemented in alma.acs.tools.comphelpergen.generated.ComponentHelperInfoDescriptor, alma.acs.tools.comphelpergen.generated.ComponentInterfaceDescriptor, alma.tools.entitybuilder.generated.EntitybuilderSettingsDescriptor, alma.tools.entitybuilder.generated.EntitySchemaDescriptor, alma.tools.entitybuilder.generated.XmlNamespace2JPackageDescriptor, org.exolab.castor.builder.binding.BindingDescriptor, org.exolab.castor.builder.binding.ClassTypeDescriptor, org.exolab.castor.builder.binding.ComponentBindingTypeChoiceDescriptor, org.exolab.castor.builder.binding.ComponentBindingTypeDescriptor, org.exolab.castor.builder.binding.FieldTypeDescriptor, org.exolab.castor.builder.binding.IncludeTypeDescriptor, org.exolab.castor.builder.binding.InterfaceDescriptor, org.exolab.castor.builder.binding.NamingTypeDescriptor, org.exolab.castor.builder.binding.NamingXMLTypeDescriptor, org.exolab.castor.builder.binding.PackageTypeChoiceDescriptor, org.exolab.castor.builder.binding.PackageTypeDescriptor, org.exolab.castor.builder.binding.PathTypeDescriptor, org.exolab.castor.builder.binding.types.BindingTypeDescriptor, org.exolab.castor.builder.binding.types.FieldTypeCollectionTypeDescriptor, org.exolab.castor.mapping.xml.BindXmlDescriptor, org.exolab.castor.mapping.xml.CacheTypeMappingDescriptor, org.exolab.castor.mapping.xml.ClassMappingDescriptor, org.exolab.castor.mapping.xml.ContainerDescriptor, org.exolab.castor.mapping.xml.FieldMappingDescriptor, org.exolab.castor.mapping.xml.IncludeDescriptor, org.exolab.castor.mapping.xml.KeyGeneratorDefDescriptor, org.exolab.castor.mapping.xml.LdapDescriptor, org.exolab.castor.mapping.xml.MappingRootDescriptor, org.exolab.castor.mapping.xml.MapToDescriptor, org.exolab.castor.mapping.xml.ParamDescriptor, org.exolab.castor.mapping.xml.PropertyDescriptor, org.exolab.castor.mapping.xml.PropertyTypeDescriptor, org.exolab.castor.mapping.xml.SqlDescriptor, org.exolab.castor.mapping.xml.types.AccessTypeDescriptor, org.exolab.castor.mapping.xml.types.BindXmlAutoNamingTypeDescriptor, org.exolab.castor.mapping.xml.types.BindXmlNodeTypeDescriptor, org.exolab.castor.mapping.xml.types.CollectionTypeDescriptor, org.exolab.castor.mapping.xml.types.DirtyTypeDescriptor, org.exolab.castor.mapping.xml.types.TypeTypeDescriptor, org.exolab.castor.types.BaseDescriptor, org.exolab.castor.xml.descriptors.DateClassDescriptor, org.exolab.castor.xml.descriptors.ListClassDescriptor, org.exolab.castor.xml.descriptors.LocaleDescriptor, org.exolab.castor.xml.descriptors.RootArrayDescriptor, org.exolab.castor.xml.descriptors.SQLDateClassDescriptor, org.exolab.castor.xml.descriptors.SQLTimeClassDescriptor, org.exolab.castor.xml.descriptors.SQLTimestampClassDescriptor, org.exolab.castor.xml.descriptors.StringClassDescriptor, org.exolab.castor.xml.descriptors.VectorClassDescriptor, org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor, and org.exolab.castor.xml.util.XMLClassDescriptorImpl.

Referenced by org.exolab.castor.xml.util.ClassDescriptorResolverImpl.associate(), org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor.getNameSpaceURI(), and org.exolab.castor.xml.util.ClassDescriptorResolverImpl.resolveByXMLName().

TypeValidator org.exolab.castor.xml.XMLClassDescriptor.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.

Implemented in alma.acs.tools.comphelpergen.generated.ComponentHelperInfoDescriptor, alma.acs.tools.comphelpergen.generated.ComponentInterfaceDescriptor, alma.tools.entitybuilder.generated.EntitybuilderSettingsDescriptor, alma.tools.entitybuilder.generated.EntitySchemaDescriptor, alma.tools.entitybuilder.generated.XmlNamespace2JPackageDescriptor, org.exolab.castor.builder.binding.BindingDescriptor, org.exolab.castor.builder.binding.ClassTypeDescriptor, org.exolab.castor.builder.binding.ComponentBindingTypeChoiceDescriptor, org.exolab.castor.builder.binding.ComponentBindingTypeDescriptor, org.exolab.castor.builder.binding.FieldTypeDescriptor, org.exolab.castor.builder.binding.IncludeTypeDescriptor, org.exolab.castor.builder.binding.InterfaceDescriptor, org.exolab.castor.builder.binding.NamingTypeDescriptor, org.exolab.castor.builder.binding.NamingXMLTypeDescriptor, org.exolab.castor.builder.binding.PackageTypeChoiceDescriptor, org.exolab.castor.builder.binding.PackageTypeDescriptor, org.exolab.castor.builder.binding.PathTypeDescriptor, org.exolab.castor.builder.binding.types.BindingTypeDescriptor, org.exolab.castor.builder.binding.types.FieldTypeCollectionTypeDescriptor, org.exolab.castor.mapping.xml.BindXmlDescriptor, org.exolab.castor.mapping.xml.CacheTypeMappingDescriptor, org.exolab.castor.mapping.xml.ClassMappingDescriptor, org.exolab.castor.mapping.xml.ContainerDescriptor, org.exolab.castor.mapping.xml.FieldMappingDescriptor, org.exolab.castor.mapping.xml.IncludeDescriptor, org.exolab.castor.mapping.xml.KeyGeneratorDefDescriptor, org.exolab.castor.mapping.xml.LdapDescriptor, org.exolab.castor.mapping.xml.MappingRootDescriptor, org.exolab.castor.mapping.xml.MapToDescriptor, org.exolab.castor.mapping.xml.ParamDescriptor, org.exolab.castor.mapping.xml.PropertyDescriptor, org.exolab.castor.mapping.xml.PropertyTypeDescriptor, org.exolab.castor.mapping.xml.SqlDescriptor, org.exolab.castor.mapping.xml.types.AccessTypeDescriptor, org.exolab.castor.mapping.xml.types.BindXmlAutoNamingTypeDescriptor, org.exolab.castor.mapping.xml.types.BindXmlNodeTypeDescriptor, org.exolab.castor.mapping.xml.types.CollectionTypeDescriptor, org.exolab.castor.mapping.xml.types.DirtyTypeDescriptor, org.exolab.castor.mapping.xml.types.TypeTypeDescriptor, org.exolab.castor.types.BaseDescriptor, org.exolab.castor.xml.descriptors.DateClassDescriptor, org.exolab.castor.xml.descriptors.ListClassDescriptor, org.exolab.castor.xml.descriptors.LocaleDescriptor, org.exolab.castor.xml.descriptors.RootArrayDescriptor, org.exolab.castor.xml.descriptors.SQLDateClassDescriptor, org.exolab.castor.xml.descriptors.SQLTimeClassDescriptor, org.exolab.castor.xml.descriptors.SQLTimestampClassDescriptor, org.exolab.castor.xml.descriptors.StringClassDescriptor, org.exolab.castor.xml.descriptors.VectorClassDescriptor, org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor, and org.exolab.castor.xml.util.XMLClassDescriptorImpl.

Referenced by org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor.getValidator(), org.exolab.castor.xml.util.XMLClassDescriptorImpl.validate(), and org.exolab.castor.xml.Validator.validate().

String org.exolab.castor.xml.XMLClassDescriptor.getXMLName (  ) 

Returns the XML Name for the Class being described.

Returns:
the XML name.

Implemented in alma.acs.tools.comphelpergen.generated.ComponentHelperInfoDescriptor, alma.acs.tools.comphelpergen.generated.ComponentInterfaceDescriptor, alma.tools.entitybuilder.generated.EntitybuilderSettingsDescriptor, alma.tools.entitybuilder.generated.EntitySchemaDescriptor, alma.tools.entitybuilder.generated.XmlNamespace2JPackageDescriptor, org.exolab.castor.builder.binding.BindingDescriptor, org.exolab.castor.builder.binding.ClassTypeDescriptor, org.exolab.castor.builder.binding.ComponentBindingTypeChoiceDescriptor, org.exolab.castor.builder.binding.ComponentBindingTypeDescriptor, org.exolab.castor.builder.binding.FieldTypeDescriptor, org.exolab.castor.builder.binding.IncludeTypeDescriptor, org.exolab.castor.builder.binding.InterfaceDescriptor, org.exolab.castor.builder.binding.NamingTypeDescriptor, org.exolab.castor.builder.binding.NamingXMLTypeDescriptor, org.exolab.castor.builder.binding.PackageTypeChoiceDescriptor, org.exolab.castor.builder.binding.PackageTypeDescriptor, org.exolab.castor.builder.binding.PathTypeDescriptor, org.exolab.castor.builder.binding.types.BindingTypeDescriptor, org.exolab.castor.builder.binding.types.FieldTypeCollectionTypeDescriptor, org.exolab.castor.mapping.xml.BindXmlDescriptor, org.exolab.castor.mapping.xml.CacheTypeMappingDescriptor, org.exolab.castor.mapping.xml.ClassMappingDescriptor, org.exolab.castor.mapping.xml.ContainerDescriptor, org.exolab.castor.mapping.xml.FieldMappingDescriptor, org.exolab.castor.mapping.xml.IncludeDescriptor, org.exolab.castor.mapping.xml.KeyGeneratorDefDescriptor, org.exolab.castor.mapping.xml.LdapDescriptor, org.exolab.castor.mapping.xml.MappingRootDescriptor, org.exolab.castor.mapping.xml.MapToDescriptor, org.exolab.castor.mapping.xml.ParamDescriptor, org.exolab.castor.mapping.xml.PropertyDescriptor, org.exolab.castor.mapping.xml.PropertyTypeDescriptor, org.exolab.castor.mapping.xml.SqlDescriptor, org.exolab.castor.mapping.xml.types.AccessTypeDescriptor, org.exolab.castor.mapping.xml.types.BindXmlAutoNamingTypeDescriptor, org.exolab.castor.mapping.xml.types.BindXmlNodeTypeDescriptor, org.exolab.castor.mapping.xml.types.CollectionTypeDescriptor, org.exolab.castor.mapping.xml.types.DirtyTypeDescriptor, org.exolab.castor.mapping.xml.types.TypeTypeDescriptor, org.exolab.castor.types.BaseDescriptor, org.exolab.castor.xml.descriptors.DateClassDescriptor, org.exolab.castor.xml.descriptors.ListClassDescriptor, org.exolab.castor.xml.descriptors.LocaleDescriptor, org.exolab.castor.xml.descriptors.RootArrayDescriptor, org.exolab.castor.xml.descriptors.SQLDateClassDescriptor, org.exolab.castor.xml.descriptors.SQLTimeClassDescriptor, org.exolab.castor.xml.descriptors.SQLTimestampClassDescriptor, org.exolab.castor.xml.descriptors.StringClassDescriptor, org.exolab.castor.xml.descriptors.VectorClassDescriptor, org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor, and org.exolab.castor.xml.util.XMLClassDescriptorImpl.

Referenced by org.exolab.castor.xml.util.ClassDescriptorResolverImpl.associate(), org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor.getXMLName(), org.exolab.castor.xml.util.ClassDescriptorResolverImpl.resolveAllByXMLName(), org.exolab.castor.xml.util.ClassDescriptorResolverImpl.resolveByXMLName(), and org.exolab.castor.xml.Validator.validate().


The documentation for this interface was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties