Package com.piketec.tpt.api.requirements.excel

Class ExcelFileRequirementsImportSettings

java.lang.Object

com.piketec.tpt.api.requirements.RequirementsImportSettings

com.piketec.tpt.api.requirements.tabular.TabularRequirementsImportSettings

com.piketec.tpt.api.requirements.excel.ExcelFileRequirementsImportSettings

All Implemented Interfaces:

java.io.Serializable

public class ExcelFileRequirementsImportSettings
extends TabularRequirementsImportSettings

The settings for the requirements import from an Excel file.

Author:

Copyright (c) 2014-2024 PikeTec GmbH - MIT License (MIT) - All rights reserved

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExcelFileRequirementsImportSettings.ExcelRangeDeterminationMethod	The choice for determining the range of cells within the sheet for the import.

Constructor Summary

Constructors

Constructor	Description
ExcelFileRequirementsImportSettings()	The constructor for the settings of the requirements import from an Excel file. The path to the Excel file for the import must be set via TabularRequirementsImportSettings.setImportFilePath(String).
ExcelFileRequirementsImportSettings(java.lang.String importFilePath)	The constructor for the settings of the requirements import from an Excel file.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getRange()
ExcelFileRequirementsImportSettings.ExcelRangeDeterminationMethod	getRangeDeterminationMethod()
java.lang.String	getSheet()
boolean	isCheckForHyperlinks()
void	setCheckForHyperlinks(boolean checkForHyperlinks)
void	setRange(java.lang.String range)
void	setRangeDeterminationMethod(ExcelFileRequirementsImportSettings.ExcelRangeDeterminationMethod rangeDeterminationMethod)
void	setSheet(java.lang.String sheet)

Methods inherited from class com.piketec.tpt.api.requirements.tabular.TabularRequirementsImportSettings

getAttributeColumns, getDocumentVersionColumn, getIdColumn, getImportFilePath, getLevelColumn, getLinksColumn, getManualDocumentVersion, getTestCaseIdAttribute, getTextColumns, getTypeAssignments, getTypeColumn, getUriColumn, isShouldImportAttachments, isWithHeaderLine, setAttributeColumns, setDocumentVersionColumn, setIdColumn, setImportFilePath, setLevelColumn, setLinksColumn, setManualDocumentVersion, setShouldImportAttachments, setTestCaseIdAttribute, setTextColumns, setTypeAssignments, setTypeColumn, setUriColumn, setWithHeaderLine

Methods inherited from class com.piketec.tpt.api.requirements.RequirementsImportSettings

getAutoReviewColumns, getDocument, setAutoReviewColumns, setDocument

Methods inherited from class java.lang.Object

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

Constructor Detail

ExcelFileRequirementsImportSettings

public ExcelFileRequirementsImportSettings(java.lang.String importFilePath)

The constructor for the settings of the requirements import from an Excel file.

Parameters:

importFilePath - The source file for the import.

ExcelFileRequirementsImportSettings

public ExcelFileRequirementsImportSettings()

The constructor for the settings of the requirements import from an Excel file.
The path to the Excel file for the import must be set via TabularRequirementsImportSettings.setImportFilePath(String).

Method Detail

getRangeDeterminationMethod

public ExcelFileRequirementsImportSettings.ExcelRangeDeterminationMethod getRangeDeterminationMethod()

Returns:

The choice for determining the range of cells within the sheet for the import.

setRangeDeterminationMethod

public void setRangeDeterminationMethod(ExcelFileRequirementsImportSettings.ExcelRangeDeterminationMethod rangeDeterminationMethod)

Parameters:

rangeDeterminationMethod - The choice for determining the range of cells within the sheet for the import.

getRange

public java.lang.String getRange()

Returns:

The range between the upper-left most cell and the lower-right most cell within the sheet for the import. Only relevant if the range determination is ExcelFileRequirementsImportSettings.ExcelRangeDeterminationMethod.MANUAL.

setRange

public void setRange(java.lang.String range)

Parameters:

range - The range between the upper-left most cell and the lower-right most cell within the sheet for the import. Only relevant if the range determination is ExcelFileRequirementsImportSettings.ExcelRangeDeterminationMethod.MANUAL. Must not be null in this case and of the form e.g., "A1:X27".

getSheet

public java.lang.String getSheet()

Returns:

The source sheet of the Excel file for the import. If null, the first ofthe Excel file is used.

setSheet

public void setSheet(java.lang.String sheet)

Parameters:

sheet - The source sheet of the Excel file for the import. If null, the first ofthe Excel file is used.

isCheckForHyperlinks

public boolean isCheckForHyperlinks()

Returns:

Whether the importer creates additional columns to import them as well if hyperlinks are found in Excel cells.

setCheckForHyperlinks

public void setCheckForHyperlinks(boolean checkForHyperlinks)

Parameters:

checkForHyperlinks - If set to true, the importer creates additional columns to import them as well if hyperlinks are found in Excel cells.