KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sourceforge > cruisecontrol > util > PruneElementFilter


1 /********************************************************************************
2  * CruiseControl, a Continuous Integration Toolkit
3  * Copyright (c) 2001, ThoughtWorks, Inc.
4  * 651 W Washington Ave. Suite 600
5  * Chicago, IL 60661 USA
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * + Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * + Redistributions in binary form must reproduce the above
16  * copyright notice, this list of conditions and the following
17  * disclaimer in the documentation and/or other materials provided
18  * with the distribution.
19  *
20  * + Neither the name of ThoughtWorks, Inc., CruiseControl, nor the
21  * names of its contributors may be used to endorse or promote
22  * products derived from this software without specific prior
23  * written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
29  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  ********************************************************************************/
37
38 package net.sourceforge.cruisecontrol.util;
39
40 import org.apache.log4j.Logger;
41 import org.xml.sax.Attributes JavaDoc;
42 import org.xml.sax.SAXException JavaDoc;
43 import org.xml.sax.XMLReader JavaDoc;
44 import org.xml.sax.helpers.XMLFilterImpl JavaDoc;
45
46 /**
47  * This filter prunes branches that start with an element with
48  * the given tagname.
49  * It is used by the MergeLogger to get rid of
50  * <properties>-tags in JUnit test results / reports.
51  *
52  * @author <a HREF="mailto:joriskuipers@xs4all.nl">Joris Kuipers</a>
53  */
54 public class PruneElementFilter extends XMLFilterImpl JavaDoc {
55
56     private static final Logger LOG = Logger.getLogger(PruneElementFilter.class);
57
58     private final String JavaDoc tagName;
59
60     private int depth = 0;
61
62     /**
63      * Constructor for PruneElementFilter.
64      */
65     public PruneElementFilter(String JavaDoc tagName) {
66         super();
67         this.tagName = tagName;
68     }
69
70     /**
71      * Constructor for PruneElementFilter.
72      * @param arg0
73      */
74     public PruneElementFilter(String JavaDoc tagName, XMLReader JavaDoc arg0) {
75         super(arg0);
76         this.tagName = tagName;
77     }
78
79     /**
80      * @see org.xml.sax.ContentHandler#characters(char[], int, int)
81      */
82     public void characters(char[] ch, int start, int length) throws SAXException JavaDoc {
83         if (!isPruning()) {
84             super.characters(ch, start, length);
85         }
86     }
87
88     /**
89      * @see org.xml.sax.ContentHandler#ignorableWhitespace(char[], int, int)
90      */
91     public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException JavaDoc {
92         if (!isPruning()) {
93             super.ignorableWhitespace(ch, start, length);
94         }
95     }
96
97     /**
98      * @see org.xml.sax.ContentHandler#endElement(String, String, String)
99      */
100     public void endElement(String JavaDoc uri, String JavaDoc localName, String JavaDoc qName) throws SAXException JavaDoc {
101         if (isPruning()) {
102             depth--;
103         } else {
104             super.endElement(uri, localName, qName);
105         }
106     }
107
108     /**
109      * @see org.xml.sax.ContentHandler#startElement(String, String, String, Attributes)
110      */
111     public void startElement(String JavaDoc uri, String JavaDoc localName, String JavaDoc qName, Attributes JavaDoc atts) throws SAXException JavaDoc {
112         if (!isPruning() && localName.equals(tagName)) {
113             // prune the tree that starts with this element
114 depth = 1;
115             LOG.debug("pruning branch starting with element named " + tagName);
116         } else if (isPruning()) {
117             depth++;
118         } else {
119             super.startElement(uri, localName, qName, atts);
120         }
121     }
122     
123     private boolean isPruning() {
124         return depth > 0;
125     }
126
127 }
128
Popular Tags