Package com.aquima.interactions.composer.ds.xml.r12.parsing

Class XmlFieldDS

java.lang.Object

com.aquima.interactions.foundation.report.ReportingDS

com.aquima.interactions.composer.ds.xml.r12.parsing.XmlFieldDS

All Implemented Interfaces:

IElementDS, IFieldDS, IReportingDS

Direct Known Subclasses:

XmlInlineFieldDS

public class XmlFieldDS
extends ReportingDS
implements IFieldDS

Xml datasource implementation.

Since:

7.2

Author:

Jon van Leuven

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XmlFieldDS(IInitializationReport report, IXmlNode node)

Method Summary

Modifier and Type	Method	Description
String	getAttributeName()	This method returns the name of the attribute the field is defined for.
DataType	getDataType()	This method returns the data type of the field.
IMultilingualText	getExplainText()	The explain text associated with this field.
String	getName()	This method returns the (unique) name of the element.
String[]	getPresentationStyles()	This method returns the presentation styles that should be used when including the content element that is referred to.
IMultilingualText	getQuestionText()	The question text associated with this field.
String	getRequiredCondition()	The condition that will determine if the element is required or not.
boolean	isMultivalue()	Returns the cardinality of the field-values.
void	iterateParameterValues(IGlobalParameterValueVisitor visitor)	Iterates over all parameters of the field and adds each parameter to the provided visitor.
void	iterateValidations(IFieldValidationVisitor visitor)	This method should iterate over all the validations that should be present on the field, and add the information for them to the provided visitor.

Methods inherited from class com.aquima.interactions.foundation.report.ReportingDS

addError, addMessage, getCategory, getReport

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aquima.interactions.foundation.report.IReportingDS

addMessage

Constructor Details

XmlFieldDS

protected XmlFieldDS(IInitializationReport report,
 IXmlNode node)

Method Details

getAttributeName

public String getAttributeName()

Description copied from interface: IFieldDS

This method returns the name of the attribute the field is defined for. The attribute name should consist of both the entity type and the actual name of the attribute (seperated by a dot).

Specified by:

getAttributeName in interface IFieldDS

Returns:

The name of the attribute the field is defined for.

getDataType

public DataType getDataType()

Description copied from interface: IFieldDS

This method returns the data type of the field.

Specified by:

getDataType in interface IFieldDS

Returns:

The data type of the field.

getExplainText

public IMultilingualText getExplainText()

Description copied from interface: IFieldDS

The explain text associated with this field. This text may contain plain TSL.

Specified by:

getExplainText in interface IFieldDS

Returns:

The explain text associated with this field.

getQuestionText

public IMultilingualText getQuestionText()

Description copied from interface: IFieldDS

The question text associated with this field. This text may contain plain TSL.

Specified by:

getQuestionText in interface IFieldDS

Returns:

The question text associated with this field.

getRequiredCondition

public String getRequiredCondition()

Description copied from interface: IFieldDS

The condition that will determine if the element is required or not. Usually this condition will contain 'null' (not required), but is may also contain a complex expression returning a boolean. The required condition is at the moment only relevant for references to field elements.

Specified by:

getRequiredCondition in interface IFieldDS

Returns:

The condition that will determine if the element is required or not.

isMultivalue

public boolean isMultivalue()

Description copied from interface: IFieldDS

Returns the cardinality of the field-values.

Specified by:

isMultivalue in interface IFieldDS

Returns:

the cardinality of the field-values

iterateValidations

public void iterateValidations(IFieldValidationVisitor visitor)

Description copied from interface: IFieldDS

This method should iterate over all the validations that should be present on the field, and add the information for them to the provided visitor.

Specified by:

iterateValidations in interface IFieldDS

Parameters:

visitor - The visitor that should be used to add the validations to.

iterateParameterValues

public void iterateParameterValues(IGlobalParameterValueVisitor visitor)

Description copied from interface: IFieldDS

Iterates over all parameters of the field and adds each parameter to the provided visitor.

Specified by:

iterateParameterValues in interface IFieldDS

Parameters:

visitor - the visitor that receives the field's parameters

getName

public String getName()

Description copied from interface: IElementDS

This method returns the (unique) name of the element. The name is required when adding the content as a definition to the composer, but it is optional when the element is added directly as inline sub-content.

Specified by:

getName in interface IElementDS

Returns:

the (unique) name of the element.

getPresentationStyles

public String[] getPresentationStyles()

Description copied from interface: IElementDS

This method returns the presentation styles that should be used when including the content element that is referred to.

Specified by:

getPresentationStyles in interface IElementDS

Returns:

the presentation styles that should be used when including the content element that is referred to.