public class RYReportColumn extends Object
Modifier and Type | Class and Description |
---|---|
static class |
RYReportColumn.DataType
The data type doesn't determine much, but it helps the programmer visualizing how cells render.
|
static class |
RYReportColumn.RYReportColumnEnum |
Modifier and Type | Field and Description |
---|---|
(package private) String |
column
The part before the @.
|
private RYReportColumn.RYReportColumnEnum |
columnAsEnum
The
column field, but as an enum. |
Map<String,String> |
options
Options:
- li=true/false/default/last/cell.
|
(package private) String |
relationship
The part after the @, if any.
|
Constructor and Description |
---|
RYReportColumn(RYReportColumn.RYReportColumnEnum column,
String relationship,
String... options)
Same as
RYReportColumn(String, String, String...) , but using the proper enum as the first column |
RYReportColumn(RYReportColumn clone)
Cloning constructor
|
RYReportColumn(RYReportColumn clone,
RYReportColumn.RYReportColumnEnum newType)
Cloning constructor after changing the type
|
RYReportColumn(String column) |
RYReportColumn(String column,
String relationship,
String... options)
Explicitly build a RYReportColumn without going through the URL parsing.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o)
equals() is necessary for PathDefinition's equal() method.
|
String |
getColumn() |
@NotNull RYReportColumn.RYReportColumnEnum |
getColumnAsEnum()
Returns the type of column, or UNKNOWN.
|
@NotNull RYReportColumn.RYReportColumnEnum |
getColumnAsEnum2()
Same as
getColumnAsEnum() ,
except we return PROPERTIES if the column is in the form "@property". |
String |
getFilterBy()
A filter, for some renderers (XrayTestRunCellRenderer).
|
String |
getOption(String key)
Deprecated.
since 2.2.0. Build specific getters instead, so that we know which values are valid for the options
|
String |
getOptionAccumulator()
Returns the accumulator.
|
String |
getOptionDuplicates()
You can use ?duplicates=false if you want to remove duplicate references to the same page
|
com.playsql.requirementyogi.reporting.renderers.enums.ECellFormat |
getOptionFormat() |
String |
getOptionJiraLabel()
It is mainly used for the custom fields
|
String |
getOptionJiraType() |
com.playsql.requirementyogi.reporting.renderers.enums.ECellList |
getOptionLi()
The form of list:
- "true" to display an array as a bullet list in 1 cell,
- "false"/null to display 1 row per result,
- "last" to only display the last test result (specific to TCCell)
- "cell" to display 1 cell per result
- "default" otherwise
|
Map<String,String> |
getOptions()
Do not use.
|
String |
getOptionWithValidation(String key)
Used for validating Jira option fields
|
String |
getRelationship() |
int |
hashCode() |
boolean |
isOptionDisplayJiraStatus() |
boolean |
isOptionDisplayTitle() |
boolean |
isOptionLast()
For zephyr, display latest TestCase.
|
boolean |
isOptionLi() |
boolean |
isOptionLiLast() |
boolean |
isOptionReadonly()
Internal information to tell that an external property should be displayed as readonly
|
private boolean |
isOptionSubqueryEpic() |
String |
setOptionReadonly()
Sets the readonly option
|
String |
toString() |
String[] |
toTitle() |
String[] |
toTitle(boolean developDependencyRelationship)
Returns the title of the column
|
@Nullable final String column
@Nullable final String relationship
public Map<String,String> options
private transient RYReportColumn.RYReportColumnEnum columnAsEnum
column
field, but as an enum.public RYReportColumn(String column)
public RYReportColumn(@Nullable RYReportColumn.RYReportColumnEnum column, @Nullable String relationship, String... options)
RYReportColumn(String, String, String...)
, but using the proper enum as the first columnpublic RYReportColumn(@Nullable String column, @Nullable String relationship, String... options)
column
- the type of column, preferably one of RYReportColumn.RYReportColumnEnum
. Use null if it is a property.relationship
- the relationship or the name of the property.options
- the display options (whether or not to fetch the Jira status, etc)public RYReportColumn(RYReportColumn clone)
public RYReportColumn(RYReportColumn clone, RYReportColumn.RYReportColumnEnum newType)
public String[] toTitle()
public String[] toTitle(boolean developDependencyRelationship)
public String getOption(String key)
public String getOptionWithValidation(String key)
public boolean isOptionDisplayJiraStatus()
public boolean isOptionDisplayTitle()
private boolean isOptionSubqueryEpic()
public com.playsql.requirementyogi.reporting.renderers.enums.ECellFormat getOptionFormat()
public String getOptionDuplicates()
public String getOptionJiraLabel()
public String getOptionJiraType()
public boolean isOptionReadonly()
public String setOptionReadonly()
public com.playsql.requirementyogi.reporting.renderers.enums.ECellList getOptionLi()
public boolean isOptionLi()
public boolean isOptionLiLast()
public boolean isOptionLast()
public String getOptionAccumulator()
public String getFilterBy()
@NotNull public @NotNull RYReportColumn.RYReportColumnEnum getColumnAsEnum()
@NotNull public @NotNull RYReportColumn.RYReportColumnEnum getColumnAsEnum2()
getColumnAsEnum()
,
except we return PROPERTIES if the column is in the form "@property".
Otherwise, return UNKNOWN.public boolean equals(Object o)
Copyright © 2022 Requirement Yogi. All rights reserved.