org.dstadler.commons.svn

Class SVNLogFileParser

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.dstadler.commons.xml.AbstractSimpleContentHandler<java.lang.Long,LogEntry>

org.dstadler.commons.svn.SVNLogFileParser

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class SVNLogFileParser
extends AbstractSimpleContentHandler<java.lang.Long,LogEntry>

An XML SAX Parser which converts an SVN XML-Log into a Map<Long, LogEntry> where the key is the subversion revision number and the value provides information about the SVN log entry.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SVNLogFileParser.LogEntryRunnable Callback which is invoked for each log-entry to allow streaming handling of large svn-log queries.

Field Summary

Fields inherited from class org.dstadler.commons.xml.AbstractSimpleContentHandler

characters, configs, currentTags

Constructor Summary

Constructors

Constructor and Description
SVNLogFileParser(java.lang.String[] branches) Construct the parser with the list of branches that we are looking at.
SVNLogFileParser(java.lang.String[] branches, SVNLogFileParser.LogEntryRunnable runnable, int pathLimit) Construct the parser with the list of branches and a runnable that is invoked for each log-entry.

Method Summary

Modifier and Type	Method and Description
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName) Internal method used for XML parsing
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attributes) Internal method used for XML parsing

Methods inherited from class org.dstadler.commons.xml.AbstractSimpleContentHandler

adjustParser, characters, error, fatalError, getConfigs, parseContent, parseContent, warning

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

endDocument, endPrefixMapping, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl

Methods inherited from class java.lang.Object

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

Constructor Detail

SVNLogFileParser

public SVNLogFileParser(java.lang.String[] branches)

Construct the parser with the list of branches that we are looking at. The resulting log-entries can be queried after parsing via getConfigs().

Parameters:

branches - An array of branch-names.

SVNLogFileParser

public SVNLogFileParser(java.lang.String[] branches,
                        SVNLogFileParser.LogEntryRunnable runnable,
                        int pathLimit)

Construct the parser with the list of branches and a runnable that is invoked for each log-entry. This can be used for streaming parsing of log-entries, e.g. for potentially large results which would consume a large amount of memory otherwise. The found log-entries are not stored and thus getConfigs() will return an empty map after parsing in this case.

Parameters:

branches - An array of branch-names.

runnable - A SVNLogFileParser.LogEntryRunnable runnable which is invoked once for each log-entry.

pathLimit - The maximum number of path-elements that are stored. This can be used to limit the amount of memory that is used if the actual affected path names are not important.

Method Detail

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes attributes)
                  throws org.xml.sax.SAXException

Internal method used for XML parsing

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

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

Throws:

org.xml.sax.SAXException

endElement

public void endElement(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException

Internal method used for XML parsing

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

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

Throws:

org.xml.sax.SAXException