View Javadoc

1   /**
2    * This file Copyright (c) 2003-2010 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.importexport.filters;
35  
36  import org.xml.sax.Attributes;
37  import org.xml.sax.SAXException;
38  import org.xml.sax.XMLReader;
39  import org.xml.sax.helpers.XMLFilterImpl;
40  
41  /**
42   * A simple filter that removes whole nodes
43   *
44   * @author tmiyar
45   * @version $Revision: $ ($Author: $)
46   */
47  public abstract class SkipNodeFilter extends XMLFilterImpl {
48  
49      private final static String NODE_TAG = "sv:node";
50      private final static String NAME_TAG = "sv:name";
51  
52      private boolean skipping;
53  
54      private int skipDepth;
55  
56      public SkipNodeFilter(XMLReader parent) {
57          super(parent);
58      }
59  
60      public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException {
61          if (!skipping) {
62              ignorableWhitespace(ch, start, length);
63          }
64      }
65  
66      public void characters(char[] ch, int start, int length)
67              throws SAXException {
68          if (!skipping) {
69              super.characters(ch, start, length);
70          }
71      }
72  
73      public void startElement(String uri, String localName, String qName, Attributes atts) throws SAXException {
74  
75          String svname = atts.getValue(NAME_TAG);
76  
77          if (skipping) {
78              skipDepth++;
79              return;
80          }
81          if (NODE_TAG.equals(qName) && getFilteredNodeName().equals(svname)) {
82              skipping = true;
83              return;
84          }
85  
86          super.startElement(uri, localName, qName, atts);
87      }
88  
89      public void endElement(String uri, String localName, String qName)
90              throws SAXException {
91  
92          if (skipping) {
93              if (skipDepth == 0) {
94                  skipping = false;
95              } else {
96                  skipDepth--;
97              }
98              return;
99          }
100 
101         super.endElement(uri, localName, qName);
102     }
103 
104     /**
105      * Implement this method to specify the name of the node you want to filter.
106      *
107      * @return filtered node name
108      */
109     protected abstract String getFilteredNodeName();
110 
111 }