com.almworks.jira.structure.api.export

Interface ExportRow

@PublicApi
public interface ExportRow

An ExportRow represents a particular item in an exported Forest.

Method Summary

Modifier and Type	Method and Description
<T> T	get(AttributeSpec<T> attribute) Gets a value of an attribute for this row.
<T> T	get(AttributeSpec<T> attribute, boolean afterFiltering) Deprecated. Since Structure 5.3 you don't need to track the afterFiltering flag, please use get(AttributeSpec) instead.
int	getDepth()
StructureRow	getRow() Returns the current StructureRow instance.
long	getRowId()
boolean	isExpanded()
boolean	isLeaf()

Method Detail

getRow

@NotNull
StructureRow getRow()

Returns the current StructureRow instance.

Returns:

The current row.

getRowId

long getRowId()

getDepth

int getDepth()

Returns:

The depth of the current row in the exported Forest.

isExpanded

boolean isExpanded()

Returns:

true if the current row is expanded in the exported Forest.

isLeaf

boolean isLeaf()

Returns:

true if the current row has no sub-rows in the exported Forest.

get

@Nullable
<T> T get(AttributeSpec<T> attribute)

Gets a value of an attribute for this row. The attribute must have previously been requested by calling ExportRequestContext.requireAttribute(AttributeSpec) from ExportRenderer.prepare(ExportRequestContext) or ExportRendererProvider.getColumnRenderer(ExportFormat, ViewSpecification.Column, ExportRequestContext).

Type Parameters:

T - attribute format type

Parameters:

attribute - attribute specification

Returns:

the value or null

get

@Deprecated
 @Nullable
<T> T get(AttributeSpec<T> attribute,
                                 boolean afterFiltering)

Deprecated. Since Structure 5.3 you don't need to track the afterFiltering flag, please use get(AttributeSpec) instead.

Gets a value of an attribute for this row. This method lets you specify whether you need a value from the forest being exported or from the forest with Filter transformation removed. The attribute must have previously been requested by calling ExportRequestContext.requireAttribute(AttributeSpec, boolean) from ExportRenderer.prepare(ExportRequestContext) or ExportRendererProvider.getColumnRenderer(ExportFormat, ViewSpecification.Column, ExportRequestContext) with exactly the same value of afterFiltering.

Type Parameters:

T - attribute format type

Parameters:

attribute - attribute specification

afterFiltering - If true, then values are taken for the forest being exported; if false, the values are taken for the same forest, but without filtering transformations.

Returns:

the value or null