Package com.polarion.alm.tracker.exporter

Class MatrixExportConfiguration

java.lang.Object

com.polarion.alm.tracker.exporter.ExportConfiguration

com.polarion.alm.tracker.exporter.MatrixExportConfiguration

All Implemented Interfaces:

IExportConfiguration, IMatrixExportConfiguration

public class MatrixExportConfiguration
extends ExportConfiguration
implements IMatrixExportConfiguration

Author:

Jiri Banszel, POLARION SOFTWARE

Nested Class Summary

Nested classes/interfaces inherited from interface com.polarion.alm.tracker.exporter.IExportConfiguration

IExportConfiguration.IExportField

Field Summary

Fields inherited from interface com.polarion.alm.tracker.exporter.IMatrixExportConfiguration

EXPORT_TYPE

Constructor Summary

Constructors

Constructor	Description
MatrixExportConfiguration(String charset, List<IExportConfiguration.IExportField> fields, IExportTemplate template, Map<String,Object> params)

Method Summary

Modifier and Type	Method	Description
IPObjectList<IPObject>	getColumnObjects()	List of objects that form columns of the matrix.
String	getColumnQuery()	Query used to obtain the column objects, or null.
ILinkRoleOpt	getLinkRole()	Role of links that should be exported, or null if all links should be exported.
String	getQuery()	Deprecated.
IPObjectList<IPObject>	getRowObjects()	List of objects that form rows of the matrix.
String	getRowQuery()	Query used to obtain the row objects, or null.
IPObjectList	getWorkItems()	Deprecated.
IPObjectTree	getWorkItemTree()	Deprecated.
boolean	hasRevisionColumns()	Returns true if columns of the matrix represent Revisions.
boolean	hasRevisionRows()	Returns true if rows of the matrix represent Revisions, i.e.
void	setColumns(String query, IPObjectList<IPObject> objects, boolean revisions)
void	setLinkRole(ILinkRoleOpt linkRole)
void	setRows(String query, IPObjectList<IPObject> objects, boolean revisions)

Methods inherited from class com.polarion.alm.tracker.exporter.ExportConfiguration

getCharset, getContextId, getExportFields, getFields, getModule, getParameter, getTemplate, setContextId, setModule, setTemplate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.polarion.alm.tracker.exporter.IExportConfiguration

getCharset, getContextId, getExportFields, getFields, getModule, getParameter, getTemplate

Constructor Details

MatrixExportConfiguration

public MatrixExportConfiguration(@NotNull
 String charset,
 @Nullable
 List<IExportConfiguration.IExportField> fields,
 @Nullable
 IExportTemplate template,
 @Nullable
 Map<String,Object> params)

Parameters:

charset -

fields - either a list of field ids, or a list of IExportConfiguration.IExportField

template -

params -

Method Details

setRows

public void setRows(@Nullable
 String query,
 @NotNull
 IPObjectList<IPObject> objects,
 boolean revisions)

getRowQuery

@Nullable
public String getRowQuery()

Description copied from interface: IMatrixExportConfiguration

Query used to obtain the row objects, or null.

Specified by:

getRowQuery in interface IMatrixExportConfiguration

getRowObjects

@NotNull
public IPObjectList<IPObject> getRowObjects()

Description copied from interface: IMatrixExportConfiguration

List of objects that form rows of the matrix. The list has to contain either only Work Items or only Revisions. Rows and columns may not both contain Revisions.

Specified by:

getRowObjects in interface IMatrixExportConfiguration

hasRevisionRows

public boolean hasRevisionRows()

Description copied from interface: IMatrixExportConfiguration

Returns true if rows of the matrix represent Revisions, i.e. if IMatrixExportConfiguration.getRowObjects() returns Revisions. Either rows, or columns, or both have to represent Work Items.

Specified by:

hasRevisionRows in interface IMatrixExportConfiguration

setColumns

public void setColumns(@Nullable
 String query,
 @NotNull
 IPObjectList<IPObject> objects,
 boolean revisions)

getColumnQuery

@Nullable
public String getColumnQuery()

Description copied from interface: IMatrixExportConfiguration

Query used to obtain the column objects, or null.

Specified by:

getColumnQuery in interface IMatrixExportConfiguration

getColumnObjects

@NotNull
public IPObjectList<IPObject> getColumnObjects()

Description copied from interface: IMatrixExportConfiguration

List of objects that form columns of the matrix. The list has to contain either only Work Items or only Revisions. Rows and columns may not both contain Revisions.

Specified by:

getColumnObjects in interface IMatrixExportConfiguration

hasRevisionColumns

public boolean hasRevisionColumns()

Description copied from interface: IMatrixExportConfiguration

Returns true if columns of the matrix represent Revisions. i.e. if IMatrixExportConfiguration.getColumnObjects() returns Revisions. Either rows, or columns, or both have to represent Work Items.

Specified by:

hasRevisionColumns in interface IMatrixExportConfiguration

setLinkRole

public void setLinkRole(@Nullable
 ILinkRoleOpt linkRole)

getLinkRole

@Nullable
public ILinkRoleOpt getLinkRole()

Description copied from interface: IMatrixExportConfiguration

Role of links that should be exported, or null if all links should be exported.

Specified by:

getLinkRole in interface IMatrixExportConfiguration

Returns:

link role

getQuery

@Deprecated
public String getQuery()

Deprecated.

Specified by:

getQuery in interface IExportConfiguration

Overrides:

getQuery in class ExportConfiguration

Returns:

The query used.

getWorkItems

@Deprecated
public IPObjectList getWorkItems()

Deprecated.

Description copied from interface: IExportConfiguration

Returns Work Items in the first level of the tree. This is a convenient method for exporters that cannot export a tree. A single level tree is always passed to them so that this method only returns the list of Work Items to export.

Specified by:

getWorkItems in interface IExportConfiguration

Overrides:

getWorkItems in class ExportConfiguration

Returns:

The list of IWorkItems, never null.

See Also:

• IExportConfiguration.getWorkItemTree()

getWorkItemTree

@Deprecated
public IPObjectTree getWorkItemTree()

Deprecated.

Specified by:

getWorkItemTree in interface IExportConfiguration

Overrides:

getWorkItemTree in class ExportConfiguration

Returns:

A tree of Work Items to export.

See Also:

• IExportConfiguration.getWorkItems()