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

Class ChainedAoSaxHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

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

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class ChainedAoSaxHandler
extends org.xml.sax.helpers.DefaultHandler

A base class used for processing an AO backup file. This collects Entity information and calls the AoEntityHandler.handleEntity(String, java.util.Map) method on its registered delegates. The attributes map includes any attributes that may be nested as sub-elements.
If you construct this with a TaskProgressSink then the progress of the XML processing will be relayed.

This only processes the elements from the backup.

Since:

v6.5

Field Summary

Fields

Modifier and Type	Field and Description
static String	AO_BACKUP_XML
static String	BOOLEAN
static String	COLUMN
static String	COLUMN_NAME
static String	DATA
static String	DATE
static String	DOUBLE
static SecureXmlEntityResolver	EMPTY_ENTITY_RESOLVER
static String	INTEGER
static String	ROW
static String	STRING
static String	TABLE_NAME

Constructor Summary

Constructors

Constructor and Description
ChainedAoSaxHandler() Simple constructor for creating an AbstractHandler without progress feedback.
ChainedAoSaxHandler(TaskProgressProcessor taskProgressProcessor) Constructor to create an AbstractHandler with progress feedback.

Method Summary

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length)
void	endDocument()
void	endElement(String uri, String localName, String qName)
long	getEntityCount() Provides the number of actual XML elements that the parser encounters.
void	registerHandler(AoEntityHandler handler)
void	registerHandlers(Iterable<? extends AoEntityHandler> aoPluginPreImportHandlers)
InputSource	resolveEntity(String publicId, String systemId)
void	startDocument()
void	startElement(String uri, String localName, String qName, Attributes attributes)

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, setDocumentLocator, skippedEntity, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ENTITY_RESOLVER

public static final SecureXmlEntityResolver EMPTY_ENTITY_RESOLVER

AO_BACKUP_XML

public static final String AO_BACKUP_XML

See Also:

Constant Field Values

DATA

public static final String DATA

See Also:

Constant Field Values

TABLE_NAME

public static final String TABLE_NAME

See Also:

Constant Field Values

COLUMN

public static final String COLUMN

See Also:

Constant Field Values

COLUMN_NAME

public static final String COLUMN_NAME

See Also:

Constant Field Values

ROW

public static final String ROW

See Also:

Constant Field Values

STRING

public static final String STRING

See Also:

Constant Field Values

INTEGER

public static final String INTEGER

See Also:

Constant Field Values

DOUBLE

public static final String DOUBLE

See Also:

Constant Field Values

BOOLEAN

public static final String BOOLEAN

See Also:

Constant Field Values

DATE

public static final String DATE

See Also:

Constant Field Values

Constructor Detail

ChainedAoSaxHandler

public ChainedAoSaxHandler(TaskProgressProcessor taskProgressProcessor)

Constructor to create an AbstractHandler with progress feedback.

Parameters:

taskProgressProcessor - the TaskProgressProcessor that relays the progress information.

ChainedAoSaxHandler

public ChainedAoSaxHandler()

Simple constructor for creating an AbstractHandler without progress feedback.

Method Detail

registerHandler

public void registerHandler(AoEntityHandler handler)

registerHandlers

public void registerHandlers(Iterable<? extends AoEntityHandler> aoPluginPreImportHandlers)

getEntityCount

public long getEntityCount()

Provides the number of actual XML elements that the parser encounters.

Returns:

number of actual XML elements the parser encounters

resolveEntity

public InputSource resolveEntity(String publicId,
                                 String systemId)
                          throws IOException,
                                 SAXException

Specified by:

resolveEntity in interface EntityResolver

Overrides:

resolveEntity in class org.xml.sax.helpers.DefaultHandler

Throws:

IOException

SAXException

startDocument

public final void startDocument()
                         throws SAXException

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

endDocument

public final void endDocument()
                       throws SAXException

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

startElement

public final void startElement(String uri,
                               String localName,
                               String qName,
                               Attributes attributes)
                        throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

endElement

public void endElement(String uri,
                       String localName,
                       String qName)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

characters

public final void characters(char[] ch,
                             int start,
                             int length)
                      throws SAXException

Specified by:

characters in interface ContentHandler

Overrides:

characters in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException