Package com.aquima.interactions.test.templates.composer

Class Reference

java.lang.Object

com.aquima.interactions.test.templates.AbstractReportingTemplate

com.aquima.interactions.test.templates.composer.ElementReference

com.aquima.interactions.test.templates.composer.Reference

Direct Known Subclasses:

ContainerReference, ContentReference, FieldReference, ImageReference, TextReference

public class Reference
extends ElementReference

Base class for references to document element.

Since:

6.0

Author:

O. Kerpershoek

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Reference(com.aquima.interactions.foundation.report.IInitializationReport report, String name, com.aquima.interactions.composer.ElementType elementType)

Method Summary

Modifier and Type	Method	Description
protected String	getRepeatExpression()
protected String	getSortAttribute()
protected com.aquima.interactions.composer.ElementType	getTargetType()
protected boolean	isLinkedViaRelationAttribute()
protected boolean	isSortAscending()
protected void	setIsLinkedViaRelationAttribute(boolean isLinkedViaRelationAttribute)
void	setRepeatExpression(String repeatExpression)	This method can be used to override the repeat expression of the reference.
void	setSortAscending(boolean sortAscending)	This method can be used to specify if the instances from the context expression should be sorted in an ascending order.
void	setSortAttribute(String sortAttribute)	This method can be used to specify the attribute that should be used to sort the instances from the context expression on.
com.aquima.interactions.composer.ds.IReferenceDS	toDataSource()	This method converts the reference template to a data source that can be used to initialize a reference.

Methods inherited from class com.aquima.interactions.test.templates.composer.ElementReference

addPresentationStyle, addPresentationStyle, getCondition, getContentStyle, getName, getPresentationStyleCondition, getPresentationStyles, getReadonlyCondition, setCondition, setPresentationStyle, setPresentationStyle, setReadonly, setReadonlyCondition

Methods inherited from class com.aquima.interactions.test.templates.AbstractReportingTemplate

getInitializationReport

Methods inherited from class java.lang.Object

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

Constructor Details

Reference

protected Reference(com.aquima.interactions.foundation.report.IInitializationReport report,
 String name,
 com.aquima.interactions.composer.ElementType elementType)

Method Details

getRepeatExpression

protected String getRepeatExpression()

setRepeatExpression

public void setRepeatExpression(String repeatExpression)

This method can be used to override the repeat expression of the reference. The default context expression is null (no context expression).

Parameters:

repeatExpression - The repeat expression for the reference.

getSortAttribute

protected String getSortAttribute()

setSortAttribute

public void setSortAttribute(String sortAttribute)

This method can be used to specify the attribute that should be used to sort the instances from the context expression on.

Parameters:

sortAttribute - the attribute that should be used to sort the instances from the context expression on.

isSortAscending

protected boolean isSortAscending()

setSortAscending

public void setSortAscending(boolean sortAscending)

This method can be used to specify if the instances from the context expression should be sorted in an ascending order. The default value is true.

Parameters:

sortAscending - Boolean indicating if the instances should be sorted ascending.

toDataSource

public com.aquima.interactions.composer.ds.IReferenceDS toDataSource()

This method converts the reference template to a data source that can be used to initialize a reference.

Specified by:

toDataSource in class ElementReference

Returns:

a data source that can be used to initialize a reference.

getTargetType

protected com.aquima.interactions.composer.ElementType getTargetType()

setIsLinkedViaRelationAttribute

protected void setIsLinkedViaRelationAttribute(boolean isLinkedViaRelationAttribute)

isLinkedViaRelationAttribute

protected boolean isLinkedViaRelationAttribute()