com.atlassian.greenhopper.model.rapid
Class StatisticsFieldConfig

java.lang.Object
  extended by com.atlassian.greenhopper.model.rapid.AbstractModel
      extended by com.atlassian.greenhopper.model.rapid.StatisticsFieldConfig

public class StatisticsFieldConfig
extends AbstractModel

Represents the configuration of a Statistics Field for a RapidView. This configuration closely maps to its representation in persisted storage, namely StatisticsFieldAO.

Note that if you wish to resolve the name of the Statistics Field, you have to get a handle on the StatisticsFieldInstance for this configuration. This can be done using StatisticsFieldService.getInstanceOfField(StatisticsFieldConfig)

See Also:
StatisticsFieldService, StatisticsFieldInstance, StatisticsFieldAO

Nested Class Summary
static class StatisticsFieldConfig.StatisticsFieldConfigBuilder
           
static class StatisticsFieldConfig.Type
          There are three types of configuration: StatisticsFieldConfig.Type.NONE - no statistics will be calculated for the RapidView StatisticsFieldConfig.Type.ISSUE_COUNT - issues (including sub-tasks) will simply be counted per column StatisticsFieldConfig.Type.ISSUE_COUNT_EXCL_SUBS - issues which are not sub-tasks will be counted per column StatisticsFieldConfig.Type.JIRA_FIELD - the values stored within the specified JIRA field will be accumulated per column
 
Field Summary
 
Fields inherited from class com.atlassian.greenhopper.model.rapid.AbstractModel
id
 
Method Summary
static StatisticsFieldConfig.StatisticsFieldConfigBuilder builder()
           
static StatisticsFieldConfig buildIssueCount()
           
static StatisticsFieldConfig buildIssueCountExcludingSubs()
           
static StatisticsFieldConfig buildNone()
           
 java.lang.String getFieldId()
          The ID of the field used insuper(id); this configuration, e.g.
 StatisticsFieldConfig.Type getType()
           
 
Methods inherited from class com.atlassian.greenhopper.model.rapid.AbstractModel
equals, getId, hashCode, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

getType

public StatisticsFieldConfig.Type getType()

getFieldId

public java.lang.String getFieldId()
The ID of the field used insuper(id); this configuration, e.g. customfield_10000. Will be blank if type is StatisticsFieldConfig.Type.NONE, StatisticsFieldConfig.Type.ISSUE_COUNT or StatisticsFieldConfig.Type.ISSUE_COUNT_EXCL_SUBS.

Returns:
the String ID.

builder

public static StatisticsFieldConfig.StatisticsFieldConfigBuilder builder()

buildNone

public static StatisticsFieldConfig buildNone()

buildIssueCount

public static StatisticsFieldConfig buildIssueCount()

buildIssueCountExcludingSubs

public static StatisticsFieldConfig buildIssueCountExcludingSubs()


Copyright © 2007-2014 Atlassian. All Rights Reserved.