Class XmlReferenceDS
java.lang.Object
com.aquima.interactions.foundation.report.ReportingDS
com.aquima.interactions.composer.ds.xml.r12.parsing.XmlReferenceDS
- All Implemented Interfaces:
IReferenceDS
,IReportingDS
- Direct Known Subclasses:
XmlInlineReferenceDS
Xml datasource implementation.
- Since:
- 7.2
- Author:
- Jon van Leuven
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
XmlReferenceDS
(IInitializationReport report, IXmlNode node, String targetName) -
Method Summary
Modifier and TypeMethodDescriptionThis method returns the format that should be used when the reference is pointing to an asset (text).String[]
This method returns the action of a button reference.This method returns the event of a button reference.This method returns the optional condition expression that should be evaluated to determine if the element that is referred to should be included.The containment determines can override the content style in which an element is shown.boolean
This method may be implemented to indicate that an instance is created when the value of the relation is empty.This method returns the maximum length of the element that is referred.This method returns an optional display text for this reference, for example to overwrite the display text of a container (when this reference refers to a container).This method returns the image height.This method returns the mask call of the element that is referred.getPresentationStyleCondition
(String presentationStyle) Returns the precondition for a presentationStyle.String[]
The containment determines the styles in which an element is shown.The condition that will determine if the element that is referred is shown read only.This method returns the optional repeat expression that should be used to determine the context of the element.This method returns the attribute that should be used to sort the instances on that where returned from the context expression.protected String
This method returns the type of the element that is referred to.getWidth()
This method returns the image width.boolean
This (temporary) method describes if the element is linked via a relation attribute.boolean
This method returns a boolean indicating if a 'refresh' event should be generated when the value of the referred element changes.boolean
This method returns a boolean indicating if the instances should be sorted in ascending order.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
-
Method Details
-
getTargetName
-
getAssetFormat
Description copied from interface:IReferenceDS
This method returns the format that should be used when the reference is pointing to an asset (text).- Specified by:
getAssetFormat
in interfaceIReferenceDS
- Returns:
- the format that should be used when the reference is pointing to an asset (text).
-
getButtonActions
Description copied from interface:IReferenceDS
This method returns the action of a button reference.- Specified by:
getButtonActions
in interfaceIReferenceDS
- Returns:
- the action of a button reference.
-
getButtonEvent
Description copied from interface:IReferenceDS
This method returns the event of a button reference.- Specified by:
getButtonEvent
in interfaceIReferenceDS
- Returns:
- the event of a button reference.
-
getCondition
Description copied from interface:IReferenceDS
This method returns the optional condition expression that should be evaluated to determine if the element that is referred to should be included.- Specified by:
getCondition
in interfaceIReferenceDS
- Returns:
- The condition expression that determines if the referred element item is applicable.
-
getContentStyle
Description copied from interface:IReferenceDS
The containment determines can override the content style in which an element is shown.- Specified by:
getContentStyle
in interfaceIReferenceDS
- Returns:
- The content style in which the element should be shown.
-
getCreateInstanceForEmptyRelation
public boolean getCreateInstanceForEmptyRelation()Description copied from interface:IReferenceDS
This method may be implemented to indicate that an instance is created when the value of the relation is empty.- Specified by:
getCreateInstanceForEmptyRelation
in interfaceIReferenceDS
- Returns:
- boolean indicating if empty relations should trigger the creation of an instance.
-
getDisplayLength
Description copied from interface:IReferenceDS
This method returns the maximum length of the element that is referred. This property is usually used for containments referring field elements. This method should return null or unknown when reference refers to an element that has no display length.- Specified by:
getDisplayLength
in interfaceIReferenceDS
- Returns:
- This method returns the maximum length of the element that is referred.
-
getDisplayText
Description copied from interface:IReferenceDS
This method returns an optional display text for this reference, for example to overwrite the display text of a container (when this reference refers to a container).- Specified by:
getDisplayText
in interfaceIReferenceDS
- Returns:
- The optional display text.
-
getHeight
Description copied from interface:IReferenceDS
This method returns the image height.- Specified by:
getHeight
in interfaceIReferenceDS
- Returns:
- Image height (may be null)
-
getMaskCallName
Description copied from interface:IReferenceDS
This method returns the mask call of the element that is referred. This property is usually used for containments referring field elements.- Specified by:
getMaskCallName
in interfaceIReferenceDS
- Returns:
- This method returns the mask call name of the element that is referred.
-
getPresentationStyles
Description copied from interface:IReferenceDS
The containment determines the styles in which an element is shown. A unique element can be included in different containers, but shown in different styles. The styles is sometimes also referred to as the format of the element.- Specified by:
getPresentationStyles
in interfaceIReferenceDS
- Returns:
- The styles in which the element should be shown.
-
getPresentationStyleCondition
Description copied from interface:IReferenceDS
Returns the precondition for a presentationStyle.- Specified by:
getPresentationStyleCondition
in interfaceIReferenceDS
- Parameters:
presentationStyle
- The name of the presentationStyle, not null.- Returns:
- The precondition, or null in case no precondition was defined.
-
getReadonlyCondition
Description copied from interface:IReferenceDS
The condition that will determine if the element that is referred is shown read only. Usually this condition will contain either 'true' or 'false', but is may also contain a complex expression returning a boolean.- Specified by:
getReadonlyCondition
in interfaceIReferenceDS
- Returns:
- The condition that will determine if the element that is referred is shown read only.
-
getRepeatExpression
Description copied from interface:IReferenceDS
This method returns the optional repeat expression that should be used to determine the context of the element. The repeat expression can be a relation attribute containing the instance that should be active when evaluating the content item that is referred to.- Specified by:
getRepeatExpression
in interfaceIReferenceDS
- Returns:
- The expression that should be used to determine the context.
-
getSortAttribute
Description copied from interface:IReferenceDS
This method returns the attribute that should be used to sort the instances on that where returned from the context expression. When no attribute is specified, the instances will be sorted on ID. This method is only relevant when a context expression has been specified.- Specified by:
getSortAttribute
in interfaceIReferenceDS
- Returns:
- the attribute that should be used to sort the instances on that where returned from the context expression.
-
getTargetType
Description copied from interface:IReferenceDS
This method returns the type of the element that is referred to.- Specified by:
getTargetType
in interfaceIReferenceDS
- Returns:
- The type of the element that is referred to.
-
getWidth
Description copied from interface:IReferenceDS
This method returns the image width.- Specified by:
getWidth
in interfaceIReferenceDS
- Returns:
- Image width (may be null)
-
isLinkedViaRelationAttribute
public boolean isLinkedViaRelationAttribute()Description copied from interface:IReferenceDS
This (temporary) method describes if the element is linked via a relation attribute. For example two containers that are linked via a relation attribute. In the future this will be replaced by a repeat expression.- Specified by:
isLinkedViaRelationAttribute
in interfaceIReferenceDS
- Returns:
- Boolean indicating if the reference is a link via a releation attribute.
-
isRefreshElement
public boolean isRefreshElement()Description copied from interface:IReferenceDS
This method returns a boolean indicating if a 'refresh' event should be generated when the value of the referred element changes. The refresh property is usually only relevant for field and button elements.- Specified by:
isRefreshElement
in interfaceIReferenceDS
- Returns:
- boolean indicating if a 'refresh' event should be generated when the value of the referred element changes.
-
sortAscending
public boolean sortAscending()Description copied from interface:IReferenceDS
This method returns a boolean indicating if the instances should be sorted in ascending order. This method is only relevant when a context expression has been specified.- Specified by:
sortAscending
in interfaceIReferenceDS
- Returns:
- a boolean indicating if the instances should be sorted in ascending order.
-