Class BaseDescriptor

java.lang.Object

org.exolab.castor.xml.descriptors.BaseDescriptor

All Implemented Interfaces:

NatureExtendable, PropertyHolder, ClassDescriptor, XMLClassDescriptor

Direct Known Subclasses:

DateClassDescriptor, ListClassDescriptor, LocaleDescriptor, RootArrayDescriptor, SQLDateClassDescriptor, SQLTimeClassDescriptor, SQLTimestampClassDescriptor, StringClassDescriptor, VectorClassDescriptor

public abstract class BaseDescriptor
extends Object
implements XMLClassDescriptor

Constructor Summary

Constructors

Constructor	Description
BaseDescriptor()

Method Summary

Modifier and Type	Method	Description
void	addNature(String nature)	Adds a specified nature.
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.
void	checkDescriptorForCorrectOrderWithinSequence(XMLFieldDescriptor elementDescriptor, UnmarshalState parentState, String xmlName)	Checks whether the given XMLFieldDescriptor is the one actually expected, given the natural order as defined by a sequence definition
Object	getProperty(String name)	Get a property by its name.
boolean	hasNature(String nature)	Checks if a specified nature has been added.
boolean	isChoice()	Indicates whether the XML artifact described by this descriptor is a invalid input: '<'xsd:choice>.
void	setProperty(String name, Object value)	Set a property specified by the name to the passed value.

Methods inherited from class Object

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

Methods inherited from interface ClassDescriptor

getExtends, getFields, getIdentity, getJavaClass

Modifier and Type	Method	Description
ClassDescriptor	getExtends()	Returns the class descriptor of the class extended by this class.
FieldDescriptor[]	getFields()	Returns a list of fields represented by this descriptor.
FieldDescriptor	getIdentity()	Returns the identity field, null if this class has no identity.
Class<?>	getJavaClass()	Returns the Java class represented by this descriptor.

Methods inherited from interface XMLClassDescriptor

getAttributeDescriptors, getContentDescriptor, getElementDescriptors, getFieldDescriptor, getNameSpacePrefix, getNameSpaceURI, getValidator, getXMLName

Modifier and Type	Method	Description
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(String name, String namespace, NodeType nodeType)	Returns the XML field descriptor matching the given xml name, namespace, and nodeType.
String	getNameSpacePrefix()	Returns the namespace prefix to use when marshalling as XML.
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.
String	getXMLName()	Returns the XML Name for the Class being described.

Constructor Details

BaseDescriptor

public BaseDescriptor()

Method Details

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 contain other objects), in this particular case the implementation returns false.

Specified by:

canAccept in interface XMLClassDescriptor

Parameters:

name - the name of the field to check

namespace - the namespace of the element. This may be null. Note: A null namespace is not the same as the default namespace unless the default namespace is also null.

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.

checkDescriptorForCorrectOrderWithinSequence

public void checkDescriptorForCorrectOrderWithinSequence(XMLFieldDescriptor elementDescriptor,
 UnmarshalState parentState,
 String xmlName)
                                                  throws ValidationException

Checks whether the given XMLFieldDescriptor is the one actually expected, given the natural order as defined by a sequence definition

Specified by:

checkDescriptorForCorrectOrderWithinSequence in interface XMLClassDescriptor

Parameters:

elementDescriptor - The XML field descriptor to be checked

xmlName - TODO

Throws:

ValidationException - If the descriptor is not the one expected

isChoice

public boolean isChoice()

Indicates whether the XML artifact described by this descriptor is a invalid input: '<'xsd:choice>.

Specified by:

isChoice in interface XMLClassDescriptor

Returns:

True if the artifact described is a choice.

See Also:

• XMLClassDescriptor.isChoice()

getProperty

public Object getProperty(String name)

Description copied from interface: PropertyHolder

Get a property by its name.

Specified by:

getProperty in interface PropertyHolder

Parameters:

name - of the property

Returns:

value of the property

setProperty

public void setProperty(String name,
 Object value)

Description copied from interface: PropertyHolder

Set a property specified by the name to the passed value.

Specified by:

setProperty in interface PropertyHolder

Parameters:

name - of the property

value - of the property

addNature

public void addNature(String nature)

Description copied from interface: NatureExtendable

Adds a specified nature.

Specified by:

addNature in interface NatureExtendable

Parameters:

nature - ID of the Nature

hasNature

public boolean hasNature(String nature)

Description copied from interface: NatureExtendable

Checks if a specified nature has been added.

Specified by:

hasNature in interface NatureExtendable

Parameters:

nature - ID of the Nature

Returns:

true if the Nature ID was added.