com.atlassian.bamboo.index.buildresult

Class BuildResultsSummaryDocument

java.lang.Object

com.atlassian.core.bean.EntityObject

com.atlassian.bamboo.core.BambooEntityObject

com.atlassian.bamboo.resultsummary.BaseResultSummary

com.atlassian.bamboo.resultsummary.AbstractResultsSummary

com.atlassian.bamboo.index.buildresult.BuildResultsSummaryDocument

All Implemented Interfaces:

BambooCustomDataAware, BambooIdProvider, BambooObject, Deletable, ImmutableDeletable, PlanResultKeyProvider, BuildResultsSummary, ImmutableResultsSummary, MutableBuildKeyResultsSummary, ResultsSummary, ResultStatisticsProvider, Cloneable, Comparable<ImmutableResultsSummary>

Direct Known Subclasses:

ChainResultsSummaryDocument

public class BuildResultsSummaryDocument
extends AbstractResultsSummary
implements BuildResultsSummary

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

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	CUSTOM_DATA_MAP_KEYS_TO_INDEX
static String	DOCTYPE_BUILD_RESULT
static String	FIELD_ARTIFACTS
static String	FIELD_AUTHORS
static String	FIELD_AUTHORS_LINKED_USER_SUFFIX
static IndexedEntityLongField	FIELD_BUILD_AGENT_ID
static String	FIELD_BUILD_ID
static String	FIELD_BUILD_KEY
static IndexedEntityIntegerField	FIELD_BUILD_NUMBER
static String	FIELD_BUILD_RESULT_ID ID term that gets added to both test and build result documents
static String	FIELD_COMPLETED_TIMESTAMP
static String	FIELD_CUSTOM_DATA_PREFIX
static String	FIELD_DELTA_STATE
static String	FIELD_DOC_TYPE
static IndexedEntityLongField	FIELD_DURATION
static String	FIELD_ID IF term that only gets added build results documents
static String	FIELD_JIRA_ISSUE_KEY
static String	FIELD_JIRA_ISSUE_KEY_FIXES
static String	FIELD_JIRA_PROJECT_KEY
static String	FIELD_LABELS
static String	FIELD_LIFE_CYCLE_STATE
static String	FIELD_PERMISSION_PLAN_ID
static String	FIELD_QUEUE_TIME
static String	FIELD_STATE
static String	FIELD_STORAGE_KEY
static String	FIELD_TIMESTAMP
static String	FIELD_TRIGGER_REASON_KEY
static String	FIELD_TYPE
static String	FIELD_VCS_REVISION_KEY
static String	FIELD_VCS_UPDATE_TIME

Fields inherited from class com.atlassian.bamboo.resultsummary.AbstractResultsSummary

buildState, cachedPlanManagerRef, lifeCycleState, markedForDeletion

Fields inherited from class com.atlassian.bamboo.resultsummary.BaseResultSummary

DATE_FORMAT

Fields inherited from interface com.atlassian.bamboo.resultsummary.ImmutableResultsSummary

CUSTOM_DATA_BUILD_KEY

Fields inherited from interface com.atlassian.bamboo.plan.PlanResultKeyProvider

getPlanKey

Constructor Summary

Constructors

Constructor and Description
BuildResultsSummaryDocument(org.apache.lucene.document.Document doc, ResultsSummaryManager resultsSummaryManager)

Method Summary

Modifier and Type	Method and Description
int	compareTo(ImmutableResultsSummary obj)
boolean	equals(Object object)
List<ArtifactLink>	getArtifactLinks() Returns all artifacts associated with this build.
ChainResultsSummary	getChainResultsSummary() Not available from Lucene
ExtraBuildResultsData	getExtraBuildResultsData() Allow access to ExtraBuildResultsData
FilteredTestResults	getFilteredTestResults() Return a filtered view of all the tests that ran in this build.
String	getFullPlanName()
ImmutableChain	getImmutableChain() Gets the ImmutableChain that this result belongs to (directly or not)
Set<String>	getJiraIssueKeys() Returns all the JIRA issue keys linked to this build result
Set<LinkedJiraIssue>	getJiraIssues() Returns all the JIRA issues linked to this build result
List<Labelling>	getLabellings() Tags / labels associated with the build
List<String>	getLabelNames() A shortcut method to get all of the label names from the labellings
String	getPlanName()
Collection<ArtifactLink>	getProducedArtifactLinks() Returns all artifacts produced by this build.
long	getQueueDuration() How long build was in the queue (in miliseconds)
Date	getQueueTime() Date when build was queued.
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)
Date	getVcsUpdateTime() When the source syncronisation was kicked off
int	hashCode()
boolean	isMarkedForDeletion()
boolean	isNotRunYet() Tells whether this result belongs to a job that will run when next manual stage is kicked off
void	resetTestClassResults(List<TestClassResult> testClassResults) Overrides all current testClassResults with the new ones
void	setChainResultsSummary(ChainResultsSummary chainResultSummary)
void	setMarkedForDeletion(boolean markedForDeletion)
void	setQueueTime(Date queueTime)
void	setVcsUpdateTime(Date vcsUpdateTime)

Methods inherited from class com.atlassian.bamboo.resultsummary.AbstractResultsSummary

getBuildAgentId, getBuildCancelledDate, getBuildCompletedDate, getBuildDate, getBuildKey, getBuildNumber, getBuildResultKey, getBuildState, getChangesListSummary, getCustomBuildData, getCustomBuildDataRows, getDeltaState, getDiscriminator, getDuration, getFormatVersion, getImmutablePlan, getLifeCycleState, getLogSize, getPlanIfExists, getPlanKey, getProcessingDuration, getReasonSummary, getRepositoryChangesets, getRestartCount, getResultVariables, getStageResultId, getSubscriptions, getSubstitutedVariables, getTestClassResults, getTestResultsSummary, getTimeToFix, getTriggerManager, getTriggerReason, getTriggerReasonKey, getVariableContext, getVariableContextBaseline, getVariableContextBaselineId, getVariableContextLogs, incrementRestartCount, isCustomBuild, isOnceOff, isRebuild, setArtifactLinks, setBuildAgentId, setBuildCancelledDate, setBuildCompletedDate, setBuildDate, setBuildKey, setBuildNumber, setBuildState, setComments, setCustomBuild, setCustomBuildData, setDeltaState, setDiscriminator, setDuration, setFormatVersion, setJiraIssues, setLabellings, setLifeCycleState, setLogSize, setOnceOff, setPlanKey, setPlanName, setProcessingDuration, setRebuild, setRestartCount, setStageResultId, setSubscriptions, setSubstitutedVariables, setTestResultsSummary, setTimeToFix, setTriggerReason, setTriggerReasonKey, setVariableContextBaseline, setVariableContextLogs, toString, updateCustomDataEntry, updateFormatVersion, updateLifeCycleState

Methods inherited from class com.atlassian.bamboo.resultsummary.BaseResultSummary

createChangeListSummary, getArtifactLinksThatExist, getBuildTime, getCommits, getDurationDescription, getFixingJiraIssues, getManuallyOverriddenVariables, getPlanResultKey, getProcessingDurationDescription, getRelatedJiraIssues, getRelativeBuildDate, getRelativeBuildDate, getRelativeBuildStartedDate, getRelativeBuildStartedDate, getRelativeQueueDate, getRelativeQueueDate, getShortReasonSummary, getStatDate, getTestSummary, hasChanges, hasComments, isActive, isFailed, isFinalized, isFinished, isInProgress, isNotBuilt, isPending, isQueued, isSuccessful, isWaiting

Methods inherited from class com.atlassian.core.bean.EntityObject

clone, getCreationDate, getCurrentDate, getId, getLastModificationDate, setClock, setCreationDate, setId, setLastModificationDate

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.bamboo.resultsummary.BuildResultsSummary

getResultVariables

Methods inherited from interface com.atlassian.bamboo.resultsummary.ResultsSummary

getBuildKey, getBuildResultKey, getFormatVersion, getImmutablePlan, getVariableContextBaselineId, incrementRestartCount, setBuildAgentId, setBuildCancelledDate, setBuildCompletedDate, setBuildDate, setCustomBuild, setDeltaState, setDuration, setLogSize, setOnceOff, setProcessingDuration, setRebuild, setTestResultsSummary, setTimeToFix, setTriggerReason, updateFormatVersion, updateLifeCycleState

Methods inherited from interface com.atlassian.bamboo.core.BambooObject

setId

Methods inherited from interface com.atlassian.bamboo.core.BambooIdProvider

getId

Methods inherited from interface com.atlassian.bamboo.resultsummary.ImmutableResultsSummary

getArtifactLinksThatExist, getBuildAgentId, getBuildCancelledDate, getBuildCompletedDate, getBuildTime, getChangesListSummary, getCommits, getCustomBuildData, getDeltaState, getDuration, getDurationDescription, getFixingJiraIssues, getLifeCycleState, getLogSize, getManuallyOverriddenVariables, getPlanIfExists, getPlanKey, getPlanResultKey, getProcessingDuration, getProcessingDurationDescription, getReasonSummary, getRelatedJiraIssues, getRelativeBuildDate, getRelativeBuildDate, getRelativeBuildStartedDate, getRelativeBuildStartedDate, getRelativeQueueDate, getRelativeQueueDate, getRepositoryChangesets, getRestartCount, getShortReasonSummary, getSubscriptions, getSubstitutedVariables, getTestResultsSummary, getTestSummary, getTimeToFix, getTriggerReason, getVariableContext, getVariableContextLogs, hasChanges, hasComments, isActive, isCustomBuild, isFailed, isFinished, isInProgress, isNotBuilt, isOnceOff, isPending, isQueued, isRebuild, isSuccessful, isWaiting

Methods inherited from interface com.atlassian.bamboo.resultsummary.ResultStatisticsProvider

getBuildDate, getBuildNumber, getBuildState, getStatDate

Methods inherited from interface com.atlassian.bamboo.core.BambooCustomDataAware

updateCustomDataEntry

Methods inherited from interface com.atlassian.bamboo.plan.PlanResultKeyProvider

getPlanResultKey

Field Detail

FIELD_ID

public static final String FIELD_ID

IF term that only gets added build results documents

See Also:

Constant Field Values

FIELD_BUILD_RESULT_ID

public static final 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 IndexedEntityIntegerField FIELD_BUILD_NUMBER

FIELD_BUILD_KEY

public static final String FIELD_BUILD_KEY

See Also:

Constant Field Values

FIELD_BUILD_ID

public static final String FIELD_BUILD_ID

See Also:

Constant Field Values

FIELD_STORAGE_KEY

public static final String FIELD_STORAGE_KEY

See Also:

Constant Field Values

FIELD_PERMISSION_PLAN_ID

public static final String FIELD_PERMISSION_PLAN_ID

See Also:

Constant Field Values

FIELD_STATE

public static final String FIELD_STATE

See Also:

Constant Field Values

FIELD_LIFE_CYCLE_STATE

public static final String FIELD_LIFE_CYCLE_STATE

See Also:

Constant Field Values

FIELD_TIMESTAMP

public static final String FIELD_TIMESTAMP

See Also:

Constant Field Values

FIELD_COMPLETED_TIMESTAMP

public static final String FIELD_COMPLETED_TIMESTAMP

See Also:

Constant Field Values

FIELD_DOC_TYPE

public static final String FIELD_DOC_TYPE

See Also:

Constant Field Values

DOCTYPE_BUILD_RESULT

public static final String DOCTYPE_BUILD_RESULT

See Also:

Constant Field Values

FIELD_DURATION

public static final IndexedEntityLongField FIELD_DURATION

FIELD_JIRA_ISSUE_KEY

public static final String FIELD_JIRA_ISSUE_KEY

See Also:

Constant Field Values

FIELD_JIRA_ISSUE_KEY_FIXES

public static final String FIELD_JIRA_ISSUE_KEY_FIXES

See Also:

Constant Field Values

FIELD_JIRA_PROJECT_KEY

public static final String FIELD_JIRA_PROJECT_KEY

See Also:

Constant Field Values

FIELD_AUTHORS

public static final String FIELD_AUTHORS

See Also:

Constant Field Values

FIELD_AUTHORS_LINKED_USER_SUFFIX

public static final String FIELD_AUTHORS_LINKED_USER_SUFFIX

See Also:

Constant Field Values

FIELD_TRIGGER_REASON_KEY

public static final String FIELD_TRIGGER_REASON_KEY

See Also:

Constant Field Values

FIELD_DELTA_STATE

public static final String FIELD_DELTA_STATE

See Also:

Constant Field Values

FIELD_LABELS

public static final String FIELD_LABELS

See Also:

Constant Field Values

FIELD_VCS_REVISION_KEY

public static final String FIELD_VCS_REVISION_KEY

See Also:

Constant Field Values

FIELD_BUILD_AGENT_ID

public static final IndexedEntityLongField FIELD_BUILD_AGENT_ID

FIELD_ARTIFACTS

public static final String FIELD_ARTIFACTS

See Also:

Constant Field Values

FIELD_CUSTOM_DATA_PREFIX

public static final String FIELD_CUSTOM_DATA_PREFIX

See Also:

Constant Field Values

FIELD_QUEUE_TIME

public static final String FIELD_QUEUE_TIME

See Also:

Constant Field Values

FIELD_VCS_UPDATE_TIME

public static final String FIELD_VCS_UPDATE_TIME

See Also:

Constant Field Values

FIELD_TYPE

public static final String FIELD_TYPE

See Also:

Constant Field Values

CUSTOM_DATA_MAP_KEYS_TO_INDEX

public static final List<String> CUSTOM_DATA_MAP_KEYS_TO_INDEX

Constructor Detail

BuildResultsSummaryDocument

public BuildResultsSummaryDocument(org.apache.lucene.document.Document doc,
                                   @NotNull
                                   ResultsSummaryManager resultsSummaryManager)

Method Detail

getImmutableChain

@NotNull
public ImmutableChain getImmutableChain()

Description copied from interface: ImmutableResultsSummary

Gets the ImmutableChain that this result belongs to (directly or not)

Specified by:

getImmutableChain in interface ImmutableResultsSummary

Returns:

the owning plan for the result

getQueueTime

public Date getQueueTime()

Description copied from class: AbstractResultsSummary

Date when build was queued. For chain result this date is set when the whole chain is created - as chain is created in QUEUED state.

Specified by:

getQueueTime in interface ImmutableResultsSummary

Overrides:

getQueueTime in class AbstractResultsSummary

Returns:

getQueueDuration

public long getQueueDuration()

Description copied from interface: BuildResultsSummary

How long build was in the queue (in miliseconds)

Specified by:

getQueueDuration in interface BuildResultsSummary

Returns:

setQueueTime

public void setQueueTime(Date queueTime)

Specified by:

setQueueTime in interface ResultsSummary

Overrides:

setQueueTime in class AbstractResultsSummary

getVcsUpdateTime

public Date getVcsUpdateTime()

Description copied from interface: BuildResultsSummary

When the source syncronisation was kicked off

Specified by:

getVcsUpdateTime in interface BuildResultsSummary

Returns:

getVcsUpdateDuration

public long getVcsUpdateDuration()

Description copied from interface: BuildResultsSummary

How long checkout take (in miliseconds)

Specified by:

getVcsUpdateDuration in interface BuildResultsSummary

Returns:

setVcsUpdateTime

public void setVcsUpdateTime(Date vcsUpdateTime)

getJiraIssues

@NotNull
public Set<LinkedJiraIssue> getJiraIssues()

Description copied from interface: ImmutableResultsSummary

Returns all the JIRA issues linked to this build result

Specified by:

getJiraIssues in interface ImmutableResultsSummary

Overrides:

getJiraIssues in class AbstractResultsSummary

Returns:

getJiraIssueKeys

public Set<String> getJiraIssueKeys()

Description copied from interface: ImmutableResultsSummary

Returns all the JIRA issue keys linked to this build result

Specified by:

getJiraIssueKeys in interface ImmutableResultsSummary

Overrides:

getJiraIssueKeys in class BaseResultSummary

Returns:

getUniqueAuthors

public Set<Author> getUniqueAuthors()

Description copied from interface: ImmutableResultsSummary

A shortcut method to get the unique set of authors contributing to this build.

Specified by:

getUniqueAuthors in interface ImmutableResultsSummary

Overrides:

getUniqueAuthors in class BaseResultSummary

Returns:

Set of Authors

getArtifactLinks

@NotNull
public List<ArtifactLink> getArtifactLinks()

Description copied from interface: ImmutableResultsSummary

Returns all artifacts associated with this build. Even if the files don't exist

Specified by:

getArtifactLinks in interface ImmutableResultsSummary

Overrides:

getArtifactLinks in class AbstractResultsSummary

Returns:

getProducedArtifactLinks

@NotNull
public Collection<ArtifactLink> getProducedArtifactLinks()

Description copied from interface: BuildResultsSummary

Returns all artifacts produced by this build. Even if the files don't exist

Specified by:

getProducedArtifactLinks in interface BuildResultsSummary

Returns:

getLabellings

public List<Labelling> getLabellings()

Description copied from interface: ImmutableResultsSummary

Tags / labels associated with the build

Specified by:

getLabellings in interface ImmutableResultsSummary

Overrides:

getLabellings in class AbstractResultsSummary

Returns:

getLabelNames

@NotNull
public List<String> getLabelNames()

Description copied from interface: ImmutableResultsSummary

A shortcut method to get all of the label names from the labellings

Specified by:

getLabelNames in interface ImmutableResultsSummary

Overrides:

getLabelNames in class BaseResultSummary

Returns:

getChainResultsSummary

public ChainResultsSummary getChainResultsSummary()

Not available from Lucene

Specified by:

getChainResultsSummary in interface BuildResultsSummary

Returns:

chainResultsSummary

setChainResultsSummary

public void setChainResultsSummary(@NotNull
                                   ChainResultsSummary chainResultSummary)

Specified by:

setChainResultsSummary in interface BuildResultsSummary

getFilteredTestResults

@NotNull
public FilteredTestResults getFilteredTestResults()

Description copied from interface: BuildResultsSummary

Return a filtered view of all the tests that ran in this build. Provides some degree of caching but is still relatively intensive.

Specified by:

getFilteredTestResults in interface BuildResultsSummary

Returns:

a filtered view of all the tests ran in this build. Null if the builds hasn't finished yet.

resetTestClassResults

public void resetTestClassResults(@NotNull
                                  List<TestClassResult> testClassResults)

Description copied from interface: ResultsSummary

Overrides all current testClassResults with the new ones

Specified by:

resetTestClassResults in interface ResultsSummary

Overrides:

resetTestClassResults in class AbstractResultsSummary

Parameters:

testClassResults - to set

isMarkedForDeletion

public boolean isMarkedForDeletion()

Specified by:

isMarkedForDeletion in interface ImmutableDeletable

Returns:

Whether or not the Object has been marked for deletion

setMarkedForDeletion

public void setMarkedForDeletion(boolean markedForDeletion)

Specified by:

setMarkedForDeletion in interface Deletable

getFullPlanName

@NotNull
public String getFullPlanName()

Specified by:

getFullPlanName in interface ImmutableResultsSummary

Returns:

full plan name

getPlanName

@NotNull
public String getPlanName()

Specified by:

getPlanName in interface ImmutableResultsSummary

Overrides:

getPlanName in class AbstractResultsSummary

Returns:

short plan name

isNotRunYet

public boolean isNotRunYet()

Description copied from interface: ImmutableResultsSummary

Tells whether this result belongs to a job that will run when next manual stage is kicked off

Specified by:

isNotRunYet in interface ImmutableResultsSummary

Returns:

getExtraBuildResultsData

@Nullable
public ExtraBuildResultsData getExtraBuildResultsData()

Description copied from interface: BuildResultsSummary

Allow access to ExtraBuildResultsData

Specified by:

getExtraBuildResultsData in interface BuildResultsSummary

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class BaseResultSummary

compareTo

public int compareTo(ImmutableResultsSummary obj)

Specified by:

compareTo in interface Comparable<ImmutableResultsSummary>

Overrides:

compareTo in class BaseResultSummary

equals

public boolean equals(Object object)

Overrides:

equals in class BaseResultSummary