com.teamkonzept.dom4jb.beans
Interface XMLBeanInfo

All Known Implementing Classes:

EntryXMLBeanInfo, MapXMLBeanInfo, ObjectXMLBeanInfo, SetXMLBeanInfo, StringEntryXMLBeanInfo

public interface XMLBeanInfo

A bean implementor who wishes to provide explicit information about their bean may provide a XMLBeanInfo class that implements this XMLBeanInfo interface and provides explicit information about the mapping between the properties of the bean and the XML schema.

Version:

$Revision: 1.2 $

Author:

Carsten Krebs

See Also:

Introspector

Field Summary

static String

DEFAULT_ITEM_NAME the default item name, used if getItemName() returns null.

Method Summary

GroupDescriptor	getAttributeDescriptors() Gets the group of attribute descriptors.
GroupDescriptor	getContentDescriptors() Gets the group of content descriptors.
DataDescriptor	getDataDescriptor() Gets the data descriptor.
String	getItemName() Gets the item name of the bean.

Field Detail

DEFAULT_ITEM_NAME

public static final String DEFAULT_ITEM_NAME

the default item name, used if getItemName() returns null.

See Also:

getItemName(), Constant Field Values

Method Detail

getContentDescriptors

public GroupDescriptor getContentDescriptors()

Gets the group of content descriptors. Every content descriptor defines the mapping of the bean properties to the content of an XML element.

Returns:

Content descriptor defining the properties which describes element content.

May return null if the bean has no properties representing element content.

See Also:

ContentDescriptor

getAttributeDescriptors

public GroupDescriptor getAttributeDescriptors()

Gets the group of attribute descriptors. Every attribute descriptor defines the mapping of the bean properties to a collection of element attributes.

Returns:

Attribute descriptor defining the properties which describes element attributes.

May return null if the bean has no properties representing element attributes.

See Also:

AttributeDescriptor

getDataDescriptor

public DataDescriptor getDataDescriptor()

Gets the data descriptor. That is a descriptor which defines how the bean will be transformed into character data. Every time the bean is used as attribute value this data descriptor is used.

Returns:

Data descriptor defining the character data representation of the bean.

May return null if the bean has no character data representation

See Also:

DataDescriptor

getItemName

public String getItemName()

Gets the item name of the bean. If the bean has to be expanded as part of a collection, this name is used as the surrounding element name.

Returns:

Item name

May return null if the default item name should be used

See Also:

CollectionAdapter