org.xins.common.spec

Class DataSectionElementSpec

java.lang.Object

org.xins.common.spec.DataSectionElementSpec

public final class DataSectionElementSpec
extends Object

Specification of a data section element.

Since:

XINS 1.3.0

Version:

$Revision: 1.18 $ $Date: 2010/09/29 17:21:48 $

Author:

Anthony Goubard

Method Summary

Methods

Modifier and Type	Method and Description
ParameterSpec	getAttribute(String attributeName) Gets the specification of the specified attribute of the element.
List	getAttributeCombos() Gets the attribute combos defined for the element.
Map	getAttributes() Gets the attributes of the element.
String	getDescription() Gets the description of the data element.
String	getName() Gets the name of the data element.
DataSectionElementSpec	getSubElement(String elementName) Gets the specified sub element that are included in this element.
Map	getSubElements() Gets the specification of the sub elements that are included in this element.
boolean	isPCDataAllowed() Returns whether the element can contain a PCDATA text.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Gets the name of the data element.

Returns:

The name of the data element, never null.

getDescription

public String getDescription()

Gets the description of the data element.

Returns:

The description of the data element, never null.

getSubElement

public DataSectionElementSpec getSubElement(String elementName)
                                     throws IllegalArgumentException,
                                            EntityNotFoundException

Gets the specified sub element that are included in this element.

Parameters:

elementName - the name of the element, cannot be null.

Returns:

The specification of the sub element, never null.

Throws:

IllegalArgumentException - if elementName == null.

EntityNotFoundException - if the element does not have any sub element with the specified name.

getSubElements

public Map getSubElements()

Gets the specification of the sub elements that are included in this element. The key is the name of the element, the value is the DataSectionElementSpec object.

Returns:

the specification of the sub elements, never null.

getAttribute

public ParameterSpec getAttribute(String attributeName)
                           throws EntityNotFoundException,
                                  IllegalArgumentException

Gets the specification of the specified attribute of the element.

Parameters:

attributeName - the name of the attribute, cannot be null.

Returns:

The specification of the attribute, never null.

Throws:

EntityNotFoundException - if the element does not have any attribute with the specified name.

IllegalArgumentException - if attributeName == null.

getAttributes

public Map getAttributes()

Gets the attributes of the element. The key is the name of the attribute, the value is the ParameterSpec object.

Returns:

The specification of the attributes, never null.

isPCDataAllowed

public boolean isPCDataAllowed()

Returns whether the element can contain a PCDATA text.

Returns:

true if the element can contain text, false otherwise.

getAttributeCombos

public List getAttributeCombos()

Gets the attribute combos defined for the element. A list of AttributeComboSpec object.

Returns:

the list of the attribute combos define for the element, never null.

Since:

XINS 1.4.0