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
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a specified nature.boolean
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 definitiongetProperty
(String name) Get a property by its name.boolean
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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.exolab.castor.mapping.ClassDescriptor
getExtends, getFields, getIdentity, getJavaClass
Methods inherited from interface org.exolab.castor.xml.XMLClassDescriptor
getAttributeDescriptors, getContentDescriptor, getElementDescriptors, getFieldDescriptor, getNameSpacePrefix, getNameSpaceURI, getValidator, getXMLName
-
Constructor Details
-
BaseDescriptor
public BaseDescriptor()
-
-
Method Details
-
canAccept
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 interfaceXMLClassDescriptor
- Parameters:
name
- the name of the field to checknamespace
- 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 interfaceXMLClassDescriptor
- Parameters:
elementDescriptor
- The XML field descriptor to be checkedxmlName
- 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 interfaceXMLClassDescriptor
- Returns:
- True if the artifact described is a choice.
- See Also:
-
getProperty
Description copied from interface:PropertyHolder
Get a property by its name.- Specified by:
getProperty
in interfacePropertyHolder
- Parameters:
name
- of the property- Returns:
- value of the property
-
setProperty
Description copied from interface:PropertyHolder
Set a property specified by the name to the passed value.- Specified by:
setProperty
in interfacePropertyHolder
- Parameters:
name
- of the propertyvalue
- of the property
-
addNature
Description copied from interface:NatureExtendable
Adds a specified nature.- Specified by:
addNature
in interfaceNatureExtendable
- Parameters:
nature
- ID of the Nature
-
hasNature
Description copied from interface:NatureExtendable
Checks if a specified nature has been added.- Specified by:
hasNature
in interfaceNatureExtendable
- Parameters:
nature
- ID of the Nature- Returns:
- true if the Nature ID was added.
-