com.pyxis.greenhopper.jira.boards.stats
Interface WatchedField

All Known Implementing Classes:

AbstractWatchedCustomField, AbstractWatchedField, CrossWatchField, DefaultWatchedField, IssueCountField, RemainingField

public interface WatchedField

Field that is watched for a given project Watched fields are created by adding custom fields to the statistics, thus making them "watched". Examples are story points, standard issue count or time remaining. The field as such is therefore NOT a JIRA field, but a computed value

Field Summary

static java.lang.String

ALIAS

Method Summary

java.lang.String	getId() Retrieves the id of the watched field
java.lang.String	getName() Retrieves the name of the watched field
java.lang.String	getTooltipLabel(I18n2 i18n, java.lang.Double value)
java.lang.String	getTooltipLabel(I18n i18n, java.lang.Double value) Retrieves the tooltip label of the watched field
java.lang.Double	getValue(com.atlassian.jira.issue.Issue issue) Retrieves the value for the specified Issue
java.lang.Double	getValue(java.lang.String luceneValue) Retrieves the value from the lucene value
boolean	isASystemField()
boolean	isChartSupported()
boolean	isEditable()
boolean	isRemovable()
java.lang.Double	parse(java.lang.String value) Parses the value into a Double
java.lang.String	render(java.lang.Double value) Renders the value into a displayable String
boolean	shouldReportDisplay()

Field Detail

ALIAS

static final java.lang.String ALIAS

See Also:

Constant Field Values

Method Detail

getValue

java.lang.Double getValue(com.atlassian.jira.issue.Issue issue)

Retrieves the value for the specified Issue

Parameters:

issue -

Returns:

the value for the specified Issue

getValue

java.lang.Double getValue(java.lang.String luceneValue)

Retrieves the value from the lucene value

Parameters:

luceneValue -

Returns:

the value from the lucene value

getName

java.lang.String getName()

Retrieves the name of the watched field

Returns:

the name of the watched field

getTooltipLabel

java.lang.String getTooltipLabel(I18n i18n,
                                 java.lang.Double value)

Retrieves the tooltip label of the watched field

Parameters:

value - the value to create the tooltip with

Returns:

the name of the watched field

getTooltipLabel

java.lang.String getTooltipLabel(I18n2 i18n,
                                 java.lang.Double value)

getId

java.lang.String getId()

Retrieves the id of the watched field

Returns:

the id of the watched field

isEditable

boolean isEditable()

Returns:

whether or not the field can be remove

isRemovable

boolean isRemovable()

Returns:

whether or not the field can be remove

isChartSupported

boolean isChartSupported()

Returns:

whether or not the field supports charts

shouldReportDisplay

boolean shouldReportDisplay()

Returns:

whether or not the field should be displayed in the reports

render

java.lang.String render(java.lang.Double value)

Renders the value into a displayable String

Parameters:

value - to render

Returns:

the value rendered.

parse

java.lang.Double parse(java.lang.String value)
                       throws GreenHopperException

Parses the value into a Double

Parameters:

value - to parse

Returns:

the value parsed.

Throws:

GreenHopperException

isASystemField

boolean isASystemField()

Returns:

whether or not it is a system field