com.atlassian.jira.dev.reference.plugin.imports.project

Class ReferenceAoOverview

java.lang.Object

com.atlassian.jira.dev.reference.plugin.imports.project.ReferenceAoOverview

All Implemented Interfaces:

AoEntityHandler, PluggableOverviewAoEntityHandler

public class ReferenceAoOverview
extends Object
implements PluggableOverviewAoEntityHandler

Reference plugin to gather AO data and add it to the Backup project overview

Since:

v7.0

Constructor Summary

Constructors

Constructor and Description
ReferenceAoOverview()

Method Summary

Modifier and Type	Method and Description
void	endDocument() Provides the implementation an opportunity to perform some action when the document is finished being read.
void	endTable(String tableName) Provides the implementation an opportunity to perform some action once all rows of a table are processed.
void	handleEntity(String entityName, Map<String,Object> attributes) This is the main method to implement when using this ImportEntityHandler.
boolean	handlesEntity(String entityName) Return true if the handler should handle this entity.
void	setBackupOverviewBuilder(BackupOverviewBuilder backupOverviewBuilder)
void	startDocument() Provides the implementation an opportunity to perform some action when the document is starting to be read.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferenceAoOverview

public ReferenceAoOverview()

Method Detail

handleEntity

public void handleEntity(String entityName,
                         Map<String,Object> attributes)
                  throws ParseException,
                         AbortImportException

Description copied from interface: AoEntityHandler

This is the main method to implement when using this ImportEntityHandler. This method will provide the entity name and a complete map of attribute key/value pairs. This includes any nested element tags that will have CDATA bodies.

Specified by:

handleEntity in interface AoEntityHandler

Parameters:

entityName - identifies the entity (i.e. Issue)

attributes - complete list of the attributes listed in the XML element including the nested elements.

Throws:

ParseException - if the entity is invalid a ParseException will be thrown.

AbortImportException - to indicate to Project Import that it should abort its SAX parsing.

handlesEntity

public boolean handlesEntity(String entityName)

Description copied from interface: AoEntityHandler

Return true if the handler should handle this entity.

Specified by:

handlesEntity in interface AoEntityHandler

Returns:

true if the handler should handle this entity.

startDocument

public void startDocument()

Description copied from interface: AoEntityHandler

Provides the implementation an opportunity to perform some action when the document is starting to be read.

Specified by:

startDocument in interface AoEntityHandler

endDocument

public void endDocument()

Description copied from interface: AoEntityHandler

Provides the implementation an opportunity to perform some action when the document is finished being read.

Specified by:

endDocument in interface AoEntityHandler

endTable

public void endTable(String tableName)

Description copied from interface: AoEntityHandler

Provides the implementation an opportunity to perform some action once all rows of a table are processed.

Specified by:

endTable in interface AoEntityHandler

setBackupOverviewBuilder

public void setBackupOverviewBuilder(BackupOverviewBuilder backupOverviewBuilder)

Specified by:

setBackupOverviewBuilder in interface PluggableOverviewAoEntityHandler