NatureExtendable
, PropertyHolder
, ClassDescriptor
, XMLClassDescriptor
CenturyDescriptor
, DateDescriptor
, DateTimeDescriptor
, DurationDescriptor
, GDayDescriptor
, GMonthDayDescriptor
, GMonthDescriptor
, GYearDescriptor
, GYearMonthDescriptor
, MonthDescriptor
, RecurringDurationDescriptor
, TimeDescriptor
, TimeDurationDescriptor
, TimePeriodDescriptor
, YearDescriptor
public class BaseDescriptor extends java.lang.Object implements XMLClassDescriptor
Modifier and Type | Field | Description |
---|---|---|
protected static XMLFieldDescriptor[] |
noXMLFields |
Used for returning no attribute and no element fields
|
Modifier | Constructor | Description |
---|---|---|
protected |
BaseDescriptor(java.lang.String xmlName,
java.lang.Class type) |
Modifier and Type | Method | Description |
---|---|---|
void |
addNature(java.lang.String nature) |
Adds a specified nature.
|
boolean |
canAccept(java.lang.String name,
java.lang.String namespace,
java.lang.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,
java.lang.String xmlName) |
Checks whether the given XMLFieldDescriptor is the one actually expected,
given the natural order as defined by a sequence definition
|
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,
java.lang.String namespace,
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() |
Returns the namespace prefix to use when marshalling as XML.
|
java.lang.String |
getNameSpaceURI() |
Returns the namespace URI used when marshalling and unmarshalling as XML.
|
java.lang.Object |
getProperty(java.lang.String name) |
Get a property by its name.
|
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.
|
boolean |
hasNature(java.lang.String nature) |
Checks if a specified nature has been added.
|
boolean |
isChoice() |
Indicates whether the XML artifact described by this descriptor is a
|
void |
setProperty(java.lang.String name,
java.lang.Object value) |
Set a property specified by the name to the passed value.
|
java.lang.String |
toString() |
Returns the String representation of this XMLClassDescriptor.
|
protected static final XMLFieldDescriptor[] noXMLFields
protected BaseDescriptor(java.lang.String xmlName, java.lang.Class type)
public XMLFieldDescriptor[] getAttributeDescriptors()
getAttributeDescriptors
in interface XMLClassDescriptor
public XMLFieldDescriptor getContentDescriptor()
getContentDescriptor
in interface XMLClassDescriptor
public XMLFieldDescriptor[] getElementDescriptors()
getElementDescriptors
in interface XMLClassDescriptor
public XMLFieldDescriptor getFieldDescriptor(java.lang.String name, java.lang.String namespace, NodeType nodeType)
getFieldDescriptor
in interface XMLClassDescriptor
name
- The xml name to match against.namespace
- The namespace uri.nodeType
- The NodeType to match against, or null if the node type is not
known.public java.lang.String getNameSpacePrefix()
XMLClassDescriptor
getNameSpacePrefix
in interface XMLClassDescriptor
public java.lang.String getNameSpaceURI()
XMLClassDescriptor
getNameSpaceURI
in interface XMLClassDescriptor
public TypeValidator getValidator()
getValidator
in interface XMLClassDescriptor
public java.lang.String getXMLName()
getXMLName
in interface XMLClassDescriptor
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.Class getJavaClass()
getJavaClass
in interface ClassDescriptor
public FieldDescriptor[] getFields()
getFields
in interface ClassDescriptor
public ClassDescriptor getExtends()
getExtends
in interface ClassDescriptor
public FieldDescriptor getIdentity()
getIdentity
in interface ClassDescriptor
public AccessMode getAccessMode()
public boolean canAccept(java.lang.String name, java.lang.String namespace, java.lang.Object object)
This is mainly used for container object (that can contains other object), in this particular case the implementation will return null.
canAccept
in interface XMLClassDescriptor
name
- the xml name of the field to checknamespace
- the namespace uriobject
- the object represented by this XMLCLassDescriptorpublic void checkDescriptorForCorrectOrderWithinSequence(XMLFieldDescriptor elementDescriptor, UnmarshalState parentState, java.lang.String xmlName) throws ValidationException
checkDescriptorForCorrectOrderWithinSequence
in interface XMLClassDescriptor
elementDescriptor
- The XML field descriptor to be checkedxmlName
- TODOValidationException
- If the descriptor is not the one expectedXMLClassDescriptor.checkDescriptorForCorrectOrderWithinSequence(org.exolab.castor.xml.XMLFieldDescriptor, org.exolab.castor.xml.UnmarshalState, java.lang.String)
public boolean isChoice()
isChoice
in interface XMLClassDescriptor
XMLClassDescriptor.isChoice()
public java.lang.Object getProperty(java.lang.String name)
PropertyHolder
getProperty
in interface PropertyHolder
name
- of the propertypublic void setProperty(java.lang.String name, java.lang.Object value)
PropertyHolder
setProperty
in interface PropertyHolder
name
- of the propertyvalue
- of the propertypublic void addNature(java.lang.String nature)
NatureExtendable
addNature
in interface NatureExtendable
nature
- ID of the Naturepublic boolean hasNature(java.lang.String nature)
NatureExtendable
hasNature
in interface NatureExtendable
nature
- ID of the NatureIntalio Inc. (C) 1999-2008. All rights reserved http://www.intalio.com