Summary: Methods | [Expand All]
public interface

AoEntityHandler

com.atlassian.jira.imports.project.ao.handler.AoEntityHandler
Known Indirect Subclasses

Class Overview

Base SAX parser entity handler interface for AO data.@Internal

Summary

Public Methods
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 startDocument()
Provides the implementation an opportunity to perform some action when the document is starting to be read.

Public Methods

public void endDocument ()

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

public void endTable (String tableName)

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

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

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.

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.

public boolean handlesEntity (String entityName)

Return true if the handler should handle this entity.

Returns
  • true if the handler should handle this entity.

public void startDocument ()

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