Package com.atlassian.greenhopper.service.rapid.view

Class ColumnServiceImpl

java.lang.Object

com.atlassian.greenhopper.service.rapid.view.ColumnServiceImpl

All Implemented Interfaces:

GreenHopperCache, ColumnService

public class ColumnServiceImpl
extends Object
implements ColumnService

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.greenhopper.service.rapid.view.ColumnService

ColumnService.ColumnProgressMap

Field Summary

Fields

Modifier and Type	Field	Description
protected final LoggerWrapper	log

Fields inherited from interface com.atlassian.greenhopper.service.rapid.view.ColumnService

KANBAN_BACKLOG_COLUMN_POSITION

Constructor Summary

Constructors

Constructor	Description
ColumnServiceImpl()

Method Summary

Modifier and Type	Method	Description
ServiceOutcome<Column>	addColumn(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView, Column sourceColumn)	Add a new column to the Rapid View.
void	flushCache()	Invoked when all caches in the plugin need to be cleared.
List<Column>	getAllColumns(RapidView rapidView)	Return all columns without filtering out any column (eg: KanbanBacklogColumn still be returned when KanPlan lab is disabled)
ServiceOutcome<Column>	getColumn(Long id)
Map<Column,Integer>	getColumnPositions(RapidView rapidView)
Map<com.atlassian.jira.issue.status.Status,Column>	getColumnsByStatus(RapidView view)
List<com.atlassian.jira.issue.status.Status>	getDoneStatuses(Column column, com.atlassian.jira.user.ApplicationUser user)	Get all Done statuses from given Column and ApplicationUser
ServiceOutcome<KanbanBacklogColumn>	getKanbanBacklogColumn(RapidView rapidView)	Get backlog column of kanban board
Set<com.atlassian.jira.issue.status.Status>	getMappedStatuses(RapidView view)
List<com.atlassian.jira.issue.status.Status>	getOrderedStatuses(RapidView view)	Returns the statuses which are mapped to this RapidView in order of which they are mapped (left-most statuses are first.)
ColumnService.ColumnProgressMap	getProgressStatuses(RapidView view)	Calculate the breakdown of Status mapped in the view to their respective ColumnProgress.
List<Column>	getValidColumns(RapidView view)	Get all columns with at least one status mapped to them.
List<Column>	getVisibleColumns(RapidView rapidView)	Returns the visible columns, filtered out unnecessary columns (eg: KanbanBacklogColumn when KanPlan lab is disabled)
void	init()
void	invalidate(RapidView view)
boolean	isKanPlanEnabledForBoard(RapidView rapidView)	Check that the KanPlan feature is enabled, and that RapidView has a mapped Kanban backlog column
ServiceOutcome<List<Column>>	updateColumns(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView, List<Column> newColumns)	Update the rapid view columns
void	validateColumns(RapidView rapidView, List<Column> columns, ErrorCollection errors)
void	validateColumns(List<Column> columns, ErrorCollection errors)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

log

protected final LoggerWrapper log

Constructor Details

ColumnServiceImpl

public ColumnServiceImpl()

Method Details

init

@PostConstruct
public void init()

getColumn

public ServiceOutcome<Column> getColumn(Long id)

Specified by:

getColumn in interface ColumnService

getVisibleColumns

@Nonnull
public List<Column> getVisibleColumns(RapidView rapidView)

Description copied from interface: ColumnService

Returns the visible columns, filtered out unnecessary columns (eg: KanbanBacklogColumn when KanPlan lab is disabled)

Specified by:

getVisibleColumns in interface ColumnService

Parameters:

rapidView - the rapid view

Returns:

the columns

getAllColumns

@Nonnull
public List<Column> getAllColumns(RapidView rapidView)

Description copied from interface: ColumnService

Return all columns without filtering out any column (eg: KanbanBacklogColumn still be returned when KanPlan lab is disabled)

Specified by:

getAllColumns in interface ColumnService

Returns:

getProgressStatuses

@Nonnull
public ColumnService.ColumnProgressMap getProgressStatuses(RapidView view)

Description copied from interface: ColumnService

Calculate the breakdown of Status mapped in the view to their respective ColumnProgress.

Specified by:

getProgressStatuses in interface ColumnService

Parameters:

view - the view

Returns:

the mapping of ColumnProgress to a set of Status.

getMappedStatuses

public Set<com.atlassian.jira.issue.status.Status> getMappedStatuses(RapidView view)

Specified by:

getMappedStatuses in interface ColumnService

getColumnsByStatus

public Map<com.atlassian.jira.issue.status.Status,Column> getColumnsByStatus(RapidView view)

Specified by:

getColumnsByStatus in interface ColumnService

getDoneStatuses

@Nonnull
public List<com.atlassian.jira.issue.status.Status> getDoneStatuses(Column column,
 com.atlassian.jira.user.ApplicationUser user)

Description copied from interface: ColumnService

Get all Done statuses from given Column and ApplicationUser

Specified by:

getDoneStatuses in interface ColumnService

getValidColumns

public List<Column> getValidColumns(RapidView view)

Description copied from interface: ColumnService

Get all columns with at least one status mapped to them. The board, charts and kanban backlog should only show columns that are mapped.

Specified by:

getValidColumns in interface ColumnService

Parameters:

view - the board to get the columns from.

Returns:

List of columns, in the order that they appear in the board.

isKanPlanEnabledForBoard

public boolean isKanPlanEnabledForBoard(RapidView rapidView)

Description copied from interface: ColumnService

Check that the KanPlan feature is enabled, and that RapidView has a mapped Kanban backlog column

Specified by:

isKanPlanEnabledForBoard in interface ColumnService

getKanbanBacklogColumn

@Nonnull
public ServiceOutcome<KanbanBacklogColumn> getKanbanBacklogColumn(RapidView rapidView)

Description copied from interface: ColumnService

Get backlog column of kanban board

Specified by:

getKanbanBacklogColumn in interface ColumnService

getOrderedStatuses

@Nonnull
public List<com.atlassian.jira.issue.status.Status> getOrderedStatuses(RapidView view)

Description copied from interface: ColumnService

Returns the statuses which are mapped to this RapidView in order of which they are mapped (left-most statuses are first.)

Specified by:

getOrderedStatuses in interface ColumnService

Parameters:

view - the rapid view

Returns:

the statuses

addColumn

@Nonnull
public ServiceOutcome<Column> addColumn(com.atlassian.jira.user.ApplicationUser user,
 RapidView rapidView,
 Column sourceColumn)

Description copied from interface: ColumnService

Add a new column to the Rapid View. It will be added as the second-last column.

Specified by:

addColumn in interface ColumnService

Parameters:

user - the user

rapidView - the rapid view

sourceColumn - a model of the new column

Returns:

the newly added column

getColumnPositions

public Map<Column,Integer> getColumnPositions(RapidView rapidView)

Specified by:

getColumnPositions in interface ColumnService

updateColumns

public ServiceOutcome<List<Column>> updateColumns(com.atlassian.jira.user.ApplicationUser user,
 RapidView rapidView,
 List<Column> newColumns)

Update the rapid view columns

needs to be synchronized, because AO doesn't support transactions on JIRA, and this affects multiple rows / columns

Specified by:

updateColumns in interface ColumnService

validateColumns

public void validateColumns(List<Column> columns,
 ErrorCollection errors)

Specified by:

validateColumns in interface ColumnService

validateColumns

public void validateColumns(RapidView rapidView,
 List<Column> columns,
 ErrorCollection errors)

Specified by:

validateColumns in interface ColumnService

invalidate

public void invalidate(RapidView view)

Specified by:

invalidate in interface ColumnService

flushCache

public void flushCache()

Description copied from interface: GreenHopperCache

Invoked when all caches in the plugin need to be cleared.

Specified by:

flushCache in interface GreenHopperCache