Coverage Report

Coverage Report - net.sf.statsvn.input.SvnXmlCacheFileHandler

Classes in this File

Line Coverage

Branch Coverage

Complexity

SvnXmlCacheFileHandler

88%

65/74

61%

22/36

2.364

 package net.sf.statsvn.input;
 
 import javax.xml.parsers.ParserConfigurationException;
 
 import org.xml.sax.Attributes;
 import org.xml.sax.SAXException;
 import org.xml.sax.SAXParseException;
 import org.xml.sax.helpers.DefaultHandler;
 
 /**
  * This is the SAX parser for the our line count persistence mechanism. It feeds information to (@link net.sf.statsvn.input.LineCountsBuilder).
  * 
  * @author Gunter Mussbacher <gunterm@site.uottawa.ca>
  * 
  * @version $Id: SvnXmlCacheFileHandler.java 351 2008-03-28 18:46:26Z benoitx $
  */
 public class SvnXmlCacheFileHandler extends DefaultHandler {
         private static final String FATAL_ERROR_MESSAGE = "Invalid StatSVN cache file.";
 
         private String lastElement = "";
 
         private final CacheBuilder cacheBuilder;
 
         /**
          * Default constructor
          * 
          * @param cacheBuilder
          *            the cacheBuilder to which to send back line count information.
          */
         public SvnXmlCacheFileHandler(final CacheBuilder cacheBuilder) {
                 this.cacheBuilder = cacheBuilder;
         }
 
         /**
          * Makes sure the last element received is appropriate.
          * 
          * @param last
          *            the expected last element.
          * @throws SAXException
          *             unexpected event.
          */
         private void checkLastElement(final String last) throws SAXException {
                 if (!lastElement.equals(last)) {
                         fatalError(FATAL_ERROR_MESSAGE);
                 }
         }
 
         /**
          * Handles the end of an xml element and redirects to the appropriate end* method.
          * 
          * @throws SAXException
          *             unexpected event.
          */
         public void endElement(final String uri, final String localName, final String qName) throws SAXException {
                 super.endElement(uri, localName, qName);
                 String eName = localName; // element name
                 if ("".equals(eName)) {
                         eName = qName; // namespaceAware = false
                 }
 
                 if (eName.equals(CacheConfiguration.CACHE)) {
                         endCache();
                 } else if (eName.equals(CacheConfiguration.PATH)) {
                         endPath();
                 } else if (eName.equals(CacheConfiguration.REVISION)) {
                         endRevision();
                 } else {
                         fatalError(FATAL_ERROR_MESSAGE);
                 }
         }
 
         /**
          * End of line counts element.
          * 
          * @throws SAXException
          *             unexpected event.
          */
         private void endCache() throws SAXException {
                 checkLastElement(CacheConfiguration.CACHE);
                 lastElement = "";
         }
 
         /**
          * End of path element.
          * 
          * @throws SAXException
          *             unexpected event.
          */
         private void endPath() throws SAXException {
                 checkLastElement(CacheConfiguration.PATH);
                 lastElement = CacheConfiguration.CACHE;
         }
 
         /**
          * End of revision element.
          * 
          * @throws SAXException
          *             unexpected event.
          */
         private void endRevision() throws SAXException {
                 checkLastElement(CacheConfiguration.PATH);
         }
 
         /**
          * Throws a fatal error with the specified message.
          * 
          * @param message
          *            the reason for the error
          * @throws SAXException
          *             the error
          */
         private void fatalError(final String message) throws SAXException {
                 fatalError(new SAXParseException(message, null));
         }
 
         /**
          * Handles the start of an xml element and redirects to the appropriate start* method.
          * 
          * @throws SAXException
          *             unexpected event.
          */
         public void startElement(final String uri, final String localName, final String qName, final Attributes attributes) throws SAXException {
                 super.startElement(uri, localName, qName, attributes);
 
                 String eName = localName; // element name
                 if ("".equals(eName)) {
                         eName = qName; // namespaceAware = false
                 }
 
                 if (eName.equals(CacheConfiguration.CACHE)) {
                         startCache();
                 } else if (eName.equals(CacheConfiguration.PATH)) {
                         startPath(attributes);
                 } else if (eName.equals(CacheConfiguration.REVISION)) {
                         startRevision(attributes);
                 } else {
                         fatalError(FATAL_ERROR_MESSAGE);
                 }
         }
 
         /**
          * Handles the start of the document. Initializes the line count builder.
          * 
          * @throws SAXException
          *             unable to build the root.
          */
         private void startCache() throws SAXException {
                 checkLastElement("");
                 lastElement = CacheConfiguration.CACHE;
                 try {
                         cacheBuilder.buildRoot();
                 } catch (final ParserConfigurationException e) {
                         fatalError(FATAL_ERROR_MESSAGE);
                 }
         }
 
         /**
          * Handles start of a path. Initializes line count builder for use with this filename.
          * 
          * @param attributes
          *            element's xml attributes.
          * @throws SAXException
          *             missing some data.
          */
         private void startPath(final Attributes attributes) throws SAXException {
                 checkLastElement(CacheConfiguration.CACHE);
                 lastElement = CacheConfiguration.PATH;
                 if (attributes != null && attributes.getValue(CacheConfiguration.NAME) != null) {
                         final String name = attributes.getValue(CacheConfiguration.NAME);
                         String revision = "0";
                         if (attributes.getValue(CacheConfiguration.LATEST_REVISION) != null) {
                                 revision = attributes.getValue(CacheConfiguration.LATEST_REVISION);
                         }
                         String binaryStatus = CacheConfiguration.UNKNOWN;
                         if (attributes.getValue(CacheConfiguration.BINARY_STATUS) != null) {
                                 binaryStatus = attributes.getValue(CacheConfiguration.BINARY_STATUS);
                         }
                         cacheBuilder.buildPath(name, revision, binaryStatus);
                 } else {
                         fatalError(FATAL_ERROR_MESSAGE);
                 }
         }
 
         /**
          * Handles start of a revision. Gives information back to the line count builder.
          * 
          * @param attributes
          *            element's xml attributes.
          * @throws SAXException
          *             missing some data.
          */
         private void startRevision(final Attributes attributes) throws SAXException {
                 checkLastElement(CacheConfiguration.PATH);
                 if (attributes != null && attributes.getValue(CacheConfiguration.NUMBER) != null && attributes.getValue(CacheConfiguration.ADDED) != null
                         && attributes.getValue(CacheConfiguration.REMOVED) != null) {
                         final String number = attributes.getValue(CacheConfiguration.NUMBER);
                         final String added = attributes.getValue(CacheConfiguration.ADDED);
                         final String removed = attributes.getValue(CacheConfiguration.REMOVED);
                         String binaryStatus = CacheConfiguration.UNKNOWN;
                         if (attributes.getValue(CacheConfiguration.BINARY_STATUS) != null) {
                                 binaryStatus = attributes.getValue(CacheConfiguration.BINARY_STATUS);
                         }
                         cacheBuilder.buildRevision(number, added, removed, binaryStatus);
                 } else {
                         fatalError(FATAL_ERROR_MESSAGE);
                 }
         }
 }

1		package net.sf.statsvn.input;
2
3		import javax.xml.parsers.ParserConfigurationException;
4
5		import org.xml.sax.Attributes;
6		import org.xml.sax.SAXException;
7		import org.xml.sax.SAXParseException;
8		import org.xml.sax.helpers.DefaultHandler;
9
10		/**
11		* This is the SAX parser for the our line count persistence mechanism. It feeds information to (@link net.sf.statsvn.input.LineCountsBuilder).
12		*
13		* @author Gunter Mussbacher <gunterm@site.uottawa.ca>
14		*
15		* @version $Id: SvnXmlCacheFileHandler.java 351 2008-03-28 18:46:26Z benoitx $
16		*/
17		public class SvnXmlCacheFileHandler extends DefaultHandler {
18		private static final String FATAL_ERROR_MESSAGE = "Invalid StatSVN cache file.";
19
20	30	private String lastElement = "";
21
22		private final CacheBuilder cacheBuilder;
23
24		/**
25		* Default constructor
26		*
27		* @param cacheBuilder
28		* the cacheBuilder to which to send back line count information.
29		*/
30	30	public SvnXmlCacheFileHandler(final CacheBuilder cacheBuilder) {
31	30	this.cacheBuilder = cacheBuilder;
32	30	}
33
34		/**
35		* Makes sure the last element received is appropriate.
36		*
37		* @param last
38		* the expected last element.
39		* @throws SAXException
40		* unexpected event.
41		*/
42		private void checkLastElement(final String last) throws SAXException {
43	287760	if (!lastElement.equals(last)) {
44	0	fatalError(FATAL_ERROR_MESSAGE);
45		}
46	287760	}
47
48		/**
49		* Handles the end of an xml element and redirects to the appropriate end* method.
50		*
51		* @throws SAXException
52		* unexpected event.
53		*/
54		public void endElement(final String uri, final String localName, final String qName) throws SAXException {
55	143880	super.endElement(uri, localName, qName);
56	143880	String eName = localName; // element name
57	143880	if ("".equals(eName)) {
58	143880	eName = qName; // namespaceAware = false
59		}
60
61	143880	if (eName.equals(CacheConfiguration.CACHE)) {
62	30	endCache();
63	143850	} else if (eName.equals(CacheConfiguration.PATH)) {
64	31530	endPath();
65	112320	} else if (eName.equals(CacheConfiguration.REVISION)) {
66	112320	endRevision();
67		} else {
68	0	fatalError(FATAL_ERROR_MESSAGE);
69		}
70	143880	}
71
72		/**
73		* End of line counts element.
74		*
75		* @throws SAXException
76		* unexpected event.
77		*/
78		private void endCache() throws SAXException {
79	30	checkLastElement(CacheConfiguration.CACHE);
80	30	lastElement = "";
81	30	}
82
83		/**
84		* End of path element.
85		*
86		* @throws SAXException
87		* unexpected event.
88		*/
89		private void endPath() throws SAXException {
90	31530	checkLastElement(CacheConfiguration.PATH);
91	31530	lastElement = CacheConfiguration.CACHE;
92	31530	}
93
94		/**
95		* End of revision element.
96		*
97		* @throws SAXException
98		* unexpected event.
99		*/
100		private void endRevision() throws SAXException {
101	112320	checkLastElement(CacheConfiguration.PATH);
102	112320	}
103
104		/**
105		* Throws a fatal error with the specified message.
106		*
107		* @param message
108		* the reason for the error
109		* @throws SAXException
110		* the error
111		*/
112		private void fatalError(final String message) throws SAXException {
113	0	fatalError(new SAXParseException(message, null));
114	0	}
115
116		/**
117		* Handles the start of an xml element and redirects to the appropriate start* method.
118		*
119		* @throws SAXException
120		* unexpected event.
121		*/
122		public void startElement(final String uri, final String localName, final String qName, final Attributes attributes) throws SAXException {
123	143880	super.startElement(uri, localName, qName, attributes);
124
125	143880	String eName = localName; // element name
126	143880	if ("".equals(eName)) {
127	143880	eName = qName; // namespaceAware = false
128		}
129
130	143880	if (eName.equals(CacheConfiguration.CACHE)) {
131	30	startCache();
132	143850	} else if (eName.equals(CacheConfiguration.PATH)) {
133	31530	startPath(attributes);
134	112320	} else if (eName.equals(CacheConfiguration.REVISION)) {
135	112320	startRevision(attributes);
136		} else {
137	0	fatalError(FATAL_ERROR_MESSAGE);
138		}
139	143880	}
140
141		/**
142		* Handles the start of the document. Initializes the line count builder.
143		*
144		* @throws SAXException
145		* unable to build the root.
146		*/
147		private void startCache() throws SAXException {
148	30	checkLastElement("");
149	30	lastElement = CacheConfiguration.CACHE;
150		try {
151	30	cacheBuilder.buildRoot();
152	0	} catch (final ParserConfigurationException e) {
153	0	fatalError(FATAL_ERROR_MESSAGE);
154	30	}
155	30	}
156
157		/**
158		* Handles start of a path. Initializes line count builder for use with this filename.
159		*
160		* @param attributes
161		* element's xml attributes.
162		* @throws SAXException
163		* missing some data.
164		*/
165		private void startPath(final Attributes attributes) throws SAXException {
166	31530	checkLastElement(CacheConfiguration.CACHE);
167	31530	lastElement = CacheConfiguration.PATH;
168	31530	if (attributes != null && attributes.getValue(CacheConfiguration.NAME) != null) {
169	31530	final String name = attributes.getValue(CacheConfiguration.NAME);
170	31530	String revision = "0";
171	31530	if (attributes.getValue(CacheConfiguration.LATEST_REVISION) != null) {
172	31530	revision = attributes.getValue(CacheConfiguration.LATEST_REVISION);
173		}
174	31530	String binaryStatus = CacheConfiguration.UNKNOWN;
175	31530	if (attributes.getValue(CacheConfiguration.BINARY_STATUS) != null) {
176	31530	binaryStatus = attributes.getValue(CacheConfiguration.BINARY_STATUS);
177		}
178	31530	cacheBuilder.buildPath(name, revision, binaryStatus);
179	28377	} else {
180	0	fatalError(FATAL_ERROR_MESSAGE);
181		}
182	31530	}
183
184		/**
185		* Handles start of a revision. Gives information back to the line count builder.
186		*
187		* @param attributes
188		* element's xml attributes.
189		* @throws SAXException
190		* missing some data.
191		*/
192		private void startRevision(final Attributes attributes) throws SAXException {
193	112320	checkLastElement(CacheConfiguration.PATH);
194	112320	if (attributes != null && attributes.getValue(CacheConfiguration.NUMBER) != null && attributes.getValue(CacheConfiguration.ADDED) != null
195		&& attributes.getValue(CacheConfiguration.REMOVED) != null) {
196	112320	final String number = attributes.getValue(CacheConfiguration.NUMBER);
197	112320	final String added = attributes.getValue(CacheConfiguration.ADDED);
198	112320	final String removed = attributes.getValue(CacheConfiguration.REMOVED);
199	112320	String binaryStatus = CacheConfiguration.UNKNOWN;
200	112320	if (attributes.getValue(CacheConfiguration.BINARY_STATUS) != null) {
201	112320	binaryStatus = attributes.getValue(CacheConfiguration.BINARY_STATUS);
202		}
203	112320	cacheBuilder.buildRevision(number, added, removed, binaryStatus);
204	101088	} else {
205	0	fatalError(FATAL_ERROR_MESSAGE);
206		}
207	112320	}
208		}