Package com.atlassian.jira.imports.project.ao.handler

Interface AoEntityHandler

All Known Subinterfaces:
PluggableImportAoEntityHandler, PluggableOverviewAoEntityHandler
All Known Implementing Classes:
AoPartitionHandler, ReferenceAoImport, ReferenceAoOverview, ReferenceAoPreImport
public interface AoEntityHandler
Base SAX parser entity handler interface for AO data.
Since:
v7.0

  • Method Summary

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

  • Method Details

    • handleEntity

      void handleEntity(String entityName, Map<String,Object> attributes) throws ParseException, AbortImportException
      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.

    • handlesEntity

      boolean handlesEntity(String entityName)
      Return true if the handler should handle this entity.
      Parameters:
      entityName -
      Returns:
      true if the handler should handle this entity.

    • startDocument

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

    • endDocument

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

    • endTable

      void endTable(String tableName)
      Provides the implementation an opportunity to perform some action once all rows of a table are processed.
      Parameters:
      tableName -