uk.ac.ed.epcc.webapp.model.data

Class DumpParser

java.lang.Object

uk.ac.ed.epcc.webapp.AbstractContexed

uk.ac.ed.epcc.webapp.model.data.DumpParser

All Implemented Interfaces:

org.xml.sax.ContentHandler, Contexed

Direct Known Subclasses:

DiffParser, UnDumper

public abstract class DumpParser
extends AbstractContexed
implements org.xml.sax.ContentHandler

A ContentHandler that parses an XML data specification created by the Dumper class The default mode is to try and reproduce the ids present in the dump. Optionally a DumpParser can generate a new id and attempt to rewrite references. Though this is only possible for entries:

• all handled by the same parser
• where the fields are known to be references
• where each record only occurs once

See Also:

Dumper

Field Summary

Fields inherited from class uk.ac.ed.epcc.webapp.AbstractContexed

conn

Constructor Summary

Constructors

Constructor and Description
DumpParser(AppContext conn)
DumpParser(AppContext conn, boolean map_ids)

Method Summary

Modifier and Type	Method and Description
void	characters(char[] dat, int start, int length)
void	endDocument()
void	endElement(java.lang.String arg0, java.lang.String arg1, java.lang.String arg2)
void	endPrefixMapping(java.lang.String arg0)
protected Repository.IdMode	getIdMode()
boolean	getPreserveIds()
void	ignorableWhitespace(char[] arg0, int arg1, int arg2)
void	processingInstruction(java.lang.String arg0, java.lang.String arg1)
abstract int	processRecord(int parse_id, Repository.Record rec) handle a Repository.Record once we have parsed it
abstract void	processSpecification(java.lang.String table, TableSpecification spec) handle a TableSpecification once we have parsed it.
void	setDocumentLocator(org.xml.sax.Locator arg0)
void	setPreserveIds(boolean preserve_ids) Set if we should preserve the ids in the dump or generate new additional ids.
void	skippedEntity(java.lang.String arg0)
boolean	skipRecord(java.lang.String name, java.lang.String id) Should we skip the following Record.
abstract boolean	skipSpecification(java.lang.String table) should we skip parsing the following TableSpecification.
void	startDocument()
void	startElement(java.lang.String arg0, java.lang.String arg1, java.lang.String name, org.xml.sax.Attributes arg3)
void	startPrefixMapping(java.lang.String arg0, java.lang.String arg1)

Methods inherited from class uk.ac.ed.epcc.webapp.AbstractContexed

getContext, getLogger, resetLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

DumpParser

public DumpParser(AppContext conn)

DumpParser

public DumpParser(AppContext conn,
                  boolean map_ids)

Method Detail

characters

public void characters(char[] dat,
                       int start,
                       int length)
                throws org.xml.sax.SAXException

Specified by:

characters in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

endElement

public void endElement(java.lang.String arg0,
                       java.lang.String arg1,
                       java.lang.String arg2)
                throws org.xml.sax.SAXException

Specified by:

endElement in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

processRecord

public abstract int processRecord(int parse_id,
                                  Repository.Record rec)
                           throws ConsistencyError,
                                  DataException,
                                  java.io.IOException

handle a Repository.Record once we have parsed it

Parameters:

parse_id - int id parsed from file.

rec - uncommitted Repository.Record parsed from the file

Returns:

int id to record in id_map.

Throws:

ConsistencyError

DataException

java.io.IOException

processSpecification

public abstract void processSpecification(java.lang.String table,
                                          TableSpecification spec)
                                   throws DataFault

handle a TableSpecification once we have parsed it.

Parameters:

table -

spec -

Throws:

DataFault

skipSpecification

public abstract boolean skipSpecification(java.lang.String table)

should we skip parsing the following TableSpecification.

Parameters:

table -

Returns:

boolean

skipRecord

public boolean skipRecord(java.lang.String name,
                          java.lang.String id)

Should we skip the following Record.

Parameters:

id -

Returns:

endPrefixMapping

public void endPrefixMapping(java.lang.String arg0)
                      throws org.xml.sax.SAXException

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] arg0,
                                int arg1,
                                int arg2)
                         throws org.xml.sax.SAXException

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

processingInstruction

public void processingInstruction(java.lang.String arg0,
                                  java.lang.String arg1)
                           throws org.xml.sax.SAXException

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator arg0)

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

skippedEntity

public void skippedEntity(java.lang.String arg0)
                   throws org.xml.sax.SAXException

Specified by:

skippedEntity in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

startElement

public void startElement(java.lang.String arg0,
                         java.lang.String arg1,
                         java.lang.String name,
                         org.xml.sax.Attributes arg3)
                  throws org.xml.sax.SAXException

Specified by:

startElement in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

getIdMode

protected Repository.IdMode getIdMode()

Returns:

startPrefixMapping

public void startPrefixMapping(java.lang.String arg0,
                               java.lang.String arg1)
                        throws org.xml.sax.SAXException

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

getPreserveIds

public boolean getPreserveIds()

Returns:

the preserve_ids

setPreserveIds

public void setPreserveIds(boolean preserve_ids)

Set if we should preserve the ids in the dump or generate new additional ids.

Parameters:

preserve_ids - the preserve_ids to set