com.atlassian.bamboo.index
Class BuildResultsSummaryDocument

java.lang.Object
  extended by com.atlassian.core.bean.EntityObject
      extended by com.atlassian.bamboo.core.BambooEntityObject
          extended by com.atlassian.bamboo.resultsummary.AbstractBuildResultsSummary
              extended by com.atlassian.bamboo.index.BuildResultsSummaryDocument
All Implemented Interfaces:
BambooObject, BuildResultsSummary, ResultStatisticsProvider, java.lang.Cloneable, java.lang.Comparable<BuildResultsSummary>

public class BuildResultsSummaryDocument
extends AbstractBuildResultsSummary

A lucene implementation of an AbstractBuildResultsSummary which mirrors the BuildResultsSummary object closely.


Field Summary
static java.util.List<java.lang.String> CUSTOM_DATA_MAP_KEYS_TO_INDEX
           
static java.lang.String DOCTYPE_BUILD_RESULT
           
static java.lang.String FIELD_ARTIFACTS
           
static java.lang.String FIELD_AUTHORS
           
static java.lang.String FIELD_AUTHORS_LINKED_USER_SUFFIX
           
static java.lang.String FIELD_BUILD_AGENT_ID
           
static java.lang.String FIELD_BUILD_ID
           
static java.lang.String FIELD_BUILD_KEY
           
static java.lang.String FIELD_BUILD_NUMBER
           
static java.lang.String FIELD_BUILD_RESULT_ID
          ID term that gets added to both test and build result documents
static java.lang.String FIELD_COMMENT_CONTENT
           
static java.lang.String FIELD_COMMENT_DATE
           
static java.lang.String FIELD_COMMENT_USERNAME
           
static java.lang.String FIELD_COMPLETED_TIMESTAMP
           
static java.lang.String FIELD_CUSTOM_DATA_PREFIX
           
static java.lang.String FIELD_DELTA_STATE
           
static java.lang.String FIELD_DOC_TYPE
           
static java.lang.String FIELD_DURATION
           
static java.lang.String FIELD_FAILED_TEST_COUNT
           
static java.lang.String FIELD_ID
          IF term that only gets addded build results documents
static java.lang.String FIELD_JIRA_ISSUE_KEY
           
static java.lang.String FIELD_JIRA_ISSUE_KEY_FIXES
           
static java.lang.String FIELD_JIRA_PROJECT_KEY
           
static java.lang.String FIELD_LABELS
           
static java.lang.String FIELD_QUEUE_TIME
           
static java.lang.String FIELD_STATE
           
static java.lang.String FIELD_SUCCESSFUL_TEST_COUNT
           
static java.lang.String FIELD_TIME_TO_FIX
           
static java.lang.String FIELD_TIMESTAMP
           
static java.lang.String FIELD_TIMESTAMP_DAY
           
static java.lang.String FIELD_TOTAL_TEST_COUNT
           
static java.lang.String FIELD_TRIGGER_REASON_KEY
           
static java.lang.String FIELD_VCS_REVISION_KEY
           
static java.lang.String FIELD_VCS_UPDATE_TIME
           
 
Fields inherited from class com.atlassian.bamboo.core.BambooEntityObject
id
 
Constructor Summary
BuildResultsSummaryDocument(org.apache.lucene.document.Document doc)
           
 
Method Summary
 int compareTo(BuildResultsSummary obj)
           
 boolean equals(java.lang.Object object)
           
 java.util.Collection<ArtifactLink> getAllArtifactLinks()
          Returns all artifacts.
 java.util.Collection getAuthorNames()
           
 java.lang.Long getBuildAgentId()
          The agent Id
 java.util.Date getBuildCompletedDate()
          When the build finished
 java.util.Date getBuildDate()
           
 java.lang.String getBuildKey()
          Full key of the plan.
 int getBuildNumber()
           
 BuildState getBuildState()
           
 java.lang.String getChangedByAuthors()
           
 java.util.List<Comment> getComments()
          Gets the associated user comments for the build
 java.util.Map<java.lang.String,java.lang.String> getCustomBuildData()
          Custom data map to store random metadata about the build
 DeltaState getDeltaState()
          Gets the DeltaState of the summary.
 long getDuration()
          Duration of the build in millisecods
 double getDurationInSeconds()
           
 long getFailedTestCount()
          Number of failing tests
 java.util.Set<java.lang.String> getJiraIssueKeys()
          Returns all the JIRA issue keys linked to this build result
 java.util.Set<LinkedJiraIssue> getJiraIssues()
          Returns all the JIRA issues linked to this build result
 java.util.List getLabellings()
          Tags / labels assocaited with the build
 java.util.List getLabelNames()
          A shortcust method to get all of the label names from the labbellings
 long getQueueDuration()
          How long build was in the queue (in miliseconds)
 java.util.Date getQueueTime()
          When the build queued
 long getSuccessfulTestCount()
          Number of successful tests
 java.lang.Long getTimeToFix()
          A stored version of how long (milli seconds) it took for this build to fix a failure.
 TriggerReason getTriggerReason()
          Why the build was was triggered
 java.util.Set<Author> getUniqueAuthors()
          A shortcut method to get the unique set of authors contributing to this build.
 long getVcsUpdateDuration()
          How long checkout take (in miliseconds)
 java.util.Date getVcsUpdateTime()
          When the source syncronisation was kicked off
 int hashCode()
           
 void setBuildAgentId(java.lang.Long buildAgentId)
           
 void setTriggerReason(TriggerReason triggerReason)
           
 
Methods inherited from class com.atlassian.bamboo.resultsummary.AbstractBuildResultsSummary
createChangedByAuthors, getArtifactLinks, getBuildResultKey, getBuildTime, getDurationDescription, getFixingJiraIssues, getLongReasonSummary, getReasonSummary, getRelatedJiraIssues, getRelativeBuildDate, getRelativeBuildDate, getTestSummary, getTriggerReasonManager, getVcsRevisionKey, isBuiltToday, isFailed, isSuccessful, setTriggerReasonManager, setVcsRevisionKey
 
Methods inherited from class com.atlassian.bamboo.core.BambooEntityObject
getId, setId
 
Methods inherited from class com.atlassian.core.bean.EntityObject
clone, getCreationDate, getCurrentDate, getLastModificationDate, setClock, setCreationDate, setLastModificationDate
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.atlassian.bamboo.resultsummary.BuildResultsSummary
getId
 

Field Detail

FIELD_ID

public static final java.lang.String FIELD_ID
IF term that only gets addded build results documents

See Also:
Constant Field Values

FIELD_BUILD_RESULT_ID

public static final java.lang.String FIELD_BUILD_RESULT_ID
ID term that gets added to both test and build result documents

See Also:
Constant Field Values

FIELD_BUILD_NUMBER

public static final java.lang.String FIELD_BUILD_NUMBER
See Also:
Constant Field Values

FIELD_BUILD_KEY

public static final java.lang.String FIELD_BUILD_KEY
See Also:
Constant Field Values

FIELD_BUILD_ID

public static final java.lang.String FIELD_BUILD_ID
See Also:
Constant Field Values

FIELD_STATE

public static final java.lang.String FIELD_STATE
See Also:
Constant Field Values

FIELD_TIMESTAMP

public static final java.lang.String FIELD_TIMESTAMP
See Also:
Constant Field Values

FIELD_COMPLETED_TIMESTAMP

public static final java.lang.String FIELD_COMPLETED_TIMESTAMP
See Also:
Constant Field Values

FIELD_TIMESTAMP_DAY

public static final java.lang.String FIELD_TIMESTAMP_DAY
See Also:
Constant Field Values

FIELD_DOC_TYPE

public static final java.lang.String FIELD_DOC_TYPE
See Also:
Constant Field Values

DOCTYPE_BUILD_RESULT

public static final java.lang.String DOCTYPE_BUILD_RESULT
See Also:
Constant Field Values

FIELD_DURATION

public static final java.lang.String FIELD_DURATION
See Also:
Constant Field Values

FIELD_JIRA_ISSUE_KEY

public static final java.lang.String FIELD_JIRA_ISSUE_KEY
See Also:
Constant Field Values

FIELD_JIRA_ISSUE_KEY_FIXES

public static final java.lang.String FIELD_JIRA_ISSUE_KEY_FIXES
See Also:
Constant Field Values

FIELD_JIRA_PROJECT_KEY

public static final java.lang.String FIELD_JIRA_PROJECT_KEY
See Also:
Constant Field Values

FIELD_TOTAL_TEST_COUNT

public static final java.lang.String FIELD_TOTAL_TEST_COUNT
See Also:
Constant Field Values

FIELD_SUCCESSFUL_TEST_COUNT

public static final java.lang.String FIELD_SUCCESSFUL_TEST_COUNT
See Also:
Constant Field Values

FIELD_FAILED_TEST_COUNT

public static final java.lang.String FIELD_FAILED_TEST_COUNT
See Also:
Constant Field Values

FIELD_AUTHORS

public static final java.lang.String FIELD_AUTHORS
See Also:
Constant Field Values

FIELD_AUTHORS_LINKED_USER_SUFFIX

public static final java.lang.String FIELD_AUTHORS_LINKED_USER_SUFFIX
See Also:
Constant Field Values

FIELD_TRIGGER_REASON_KEY

public static final java.lang.String FIELD_TRIGGER_REASON_KEY
See Also:
Constant Field Values

FIELD_DELTA_STATE

public static final java.lang.String FIELD_DELTA_STATE
See Also:
Constant Field Values

FIELD_LABELS

public static final java.lang.String FIELD_LABELS
See Also:
Constant Field Values

FIELD_TIME_TO_FIX

public static final java.lang.String FIELD_TIME_TO_FIX
See Also:
Constant Field Values

FIELD_VCS_REVISION_KEY

public static final java.lang.String FIELD_VCS_REVISION_KEY
See Also:
Constant Field Values

FIELD_BUILD_AGENT_ID

public static final java.lang.String FIELD_BUILD_AGENT_ID
See Also:
Constant Field Values

FIELD_ARTIFACTS

public static final java.lang.String FIELD_ARTIFACTS
See Also:
Constant Field Values

FIELD_CUSTOM_DATA_PREFIX

public static final java.lang.String FIELD_CUSTOM_DATA_PREFIX
See Also:
Constant Field Values

FIELD_COMMENT_CONTENT

public static final java.lang.String FIELD_COMMENT_CONTENT
See Also:
Constant Field Values

FIELD_COMMENT_USERNAME

public static final java.lang.String FIELD_COMMENT_USERNAME
See Also:
Constant Field Values

FIELD_COMMENT_DATE

public static final java.lang.String FIELD_COMMENT_DATE
See Also:
Constant Field Values

FIELD_QUEUE_TIME

public static final java.lang.String FIELD_QUEUE_TIME
See Also:
Constant Field Values

FIELD_VCS_UPDATE_TIME

public static final java.lang.String FIELD_VCS_UPDATE_TIME
See Also:
Constant Field Values

CUSTOM_DATA_MAP_KEYS_TO_INDEX

public static final java.util.List<java.lang.String> CUSTOM_DATA_MAP_KEYS_TO_INDEX
Constructor Detail

BuildResultsSummaryDocument

public BuildResultsSummaryDocument(org.apache.lucene.document.Document doc)
Method Detail

getBuildNumber

public int getBuildNumber()

getBuildKey

@NotNull
public java.lang.String getBuildKey()
Description copied from interface: BuildResultsSummary
Full key of the plan. e.g BAM-MAIN

Returns:

getBuildState

public BuildState getBuildState()

getBuildDate

public java.util.Date getBuildDate()

getBuildCompletedDate

public java.util.Date getBuildCompletedDate()
Description copied from interface: BuildResultsSummary
When the build finished

Returns:

getQueueTime

public java.util.Date getQueueTime()
Description copied from interface: BuildResultsSummary
When the build queued

Returns:

getQueueDuration

public long getQueueDuration()
Description copied from interface: BuildResultsSummary
How long build was in the queue (in miliseconds)

Returns:

getVcsUpdateTime

public java.util.Date getVcsUpdateTime()
Description copied from interface: BuildResultsSummary
When the source syncronisation was kicked off

Returns:

getVcsUpdateDuration

public long getVcsUpdateDuration()
Description copied from interface: BuildResultsSummary
How long checkout take (in miliseconds)

Returns:

getDurationInSeconds

public double getDurationInSeconds()

getJiraIssues

@NotNull
public java.util.Set<LinkedJiraIssue> getJiraIssues()
Description copied from interface: BuildResultsSummary
Returns all the JIRA issues linked to this build result

Returns:

getJiraIssueKeys

public java.util.Set<java.lang.String> getJiraIssueKeys()
Description copied from interface: BuildResultsSummary
Returns all the JIRA issue keys linked to this build result

Returns:

getSuccessfulTestCount

public long getSuccessfulTestCount()
Description copied from interface: BuildResultsSummary
Number of successful tests

Returns:

getFailedTestCount

public long getFailedTestCount()
Description copied from interface: BuildResultsSummary
Number of failing tests

Returns:

getAuthorNames

public java.util.Collection getAuthorNames()

getTriggerReason

@NotNull
public TriggerReason getTriggerReason()
Description copied from interface: BuildResultsSummary
Why the build was was triggered

Returns:

setTriggerReason

public void setTriggerReason(TriggerReason triggerReason)

getBuildAgentId

public java.lang.Long getBuildAgentId()
Description copied from interface: BuildResultsSummary
The agent Id

Returns:

setBuildAgentId

public void setBuildAgentId(java.lang.Long buildAgentId)

getChangedByAuthors

public java.lang.String getChangedByAuthors()

getUniqueAuthors

public java.util.Set<Author> getUniqueAuthors()
Description copied from interface: BuildResultsSummary
A shortcut method to get the unique set of authors contributing to this build.

Returns:
Set of Authors

getDeltaState

public DeltaState getDeltaState()
Description copied from interface: BuildResultsSummary
Gets the DeltaState of the summary. It can be a build that fixes, breaks, failing, successfull. Provides a status relative to the previous summary.

Returns:

getCustomBuildData

@NotNull
public java.util.Map<java.lang.String,java.lang.String> getCustomBuildData()
Description copied from interface: BuildResultsSummary
Custom data map to store random metadata about the build

Returns:

getAllArtifactLinks

@NotNull
public java.util.Collection<ArtifactLink> getAllArtifactLinks()
Description copied from interface: BuildResultsSummary
Returns all artifacts. Even if the files don't exist

Specified by:
getAllArtifactLinks in interface BuildResultsSummary
Overrides:
getAllArtifactLinks in class AbstractBuildResultsSummary
Returns:

getLabellings

public java.util.List getLabellings()
Description copied from interface: BuildResultsSummary
Tags / labels assocaited with the build

Returns:

getLabelNames

@NotNull
public java.util.List getLabelNames()
Description copied from interface: BuildResultsSummary
A shortcust method to get all of the label names from the labbellings

Returns:

getDuration

public long getDuration()
Description copied from interface: BuildResultsSummary
Duration of the build in millisecods

Returns:

getTimeToFix

public java.lang.Long getTimeToFix()
Description copied from interface: BuildResultsSummary
A stored version of how long (milli seconds) it took for this build to fix a failure.

Returns:
Null if not a fixing build

getComments

@NotNull
public java.util.List<Comment> getComments()
Description copied from interface: BuildResultsSummary
Gets the associated user comments for the build

Returns:

compareTo

public int compareTo(BuildResultsSummary obj)

equals

public boolean equals(java.lang.Object object)
Overrides:
equals in class com.atlassian.core.bean.EntityObject

hashCode

public int hashCode()
Overrides:
hashCode in class com.atlassian.core.bean.EntityObject


Copyright © 2009 Atlassian Pty Ltd. All Rights Reserved.