/*
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 1999, 2000 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation and was
* originally based on software copyright (c) 1999, International
* Business Machines, Inc., http://www.apache.org. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package dom;
import util.Arguments;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
import org.w3c.dom.Attr;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
/**
* A sample DOM filter. This sample program illustrates how to
* use the Document#getElementsByTagName() method to quickly
* and easily locate elements by name.
*
* @version $Id: DOMFilter.java,v 1.7 2001/05/17 21:01:31 neilg Exp $
*/
public class DOMFilter {
//
// Constants
//
/** Default parser name. */
private static final String
DEFAULT_PARSER_NAME = "dom.wrappers.DOMParser";
private static boolean setValidation = false; //defaults
private static boolean setNameSpaces = true;
private static boolean setSchemaSupport = true;
private static boolean setSchemaFullSupport = false;
private static boolean setDeferredDOM = true;
//
// Public static methods
//
/** Prints the specified elements in the given document. */
public static void print(String parserWrapperName, String uri,
String elementName, String attributeName) {
try {
// parse document
DOMParserWrapper parser =
(DOMParserWrapper)Class.forName(parserWrapperName).newInstance();
parser.setFeature( "http://apache.org/xml/features/dom/defer-node-expansion",
setDeferredDOM );
parser.setFeature( "http://xml.org/sax/features/validation",
setValidation );
parser.setFeature( "http://xml.org/sax/features/namespaces",
setNameSpaces );
parser.setFeature( "http://apache.org/xml/features/validation/schema",
setSchemaSupport );
parser.setFeature( "http://apache.org/xml/features/validation/schema-full-checking",
setSchemaFullSupport );
Document document = parser.parse(uri);
// get elements that match
NodeList elements = document.getElementsByTagName(elementName);
// print nodes
print(elements, attributeName);
} catch (Exception e) {
e.printStackTrace(System.err);
}
} // print(String,String,String,String)
//
// Private static methods
//
/**
* Prints the contents of the given element node list. If the given
* attribute name is non-null, then all of the elements are printed
* out
*/
private static void print(NodeList elements, String attributeName) {
// is there anything to do?
if (elements == null) {
return;
}
// print all elements
if (attributeName == null) {
int elementCount = elements.getLength();
for (int i = 0; i < elementCount; i++) {
Element element = (Element)elements.item(i);
print(element, element.getAttributes());
}
}
// print elements with given attribute name
else {
int elementCount = elements.getLength();
for (int i = 0; i < elementCount; i++) {
Element element = (Element)elements.item(i);
NamedNodeMap attributes = element.getAttributes();
if (attributes.getNamedItem(attributeName) != null) {
print(element, attributes);
}
}
}
} // print(NodeList,String)
/** Prints the specified element. */
private static void print(Element element, NamedNodeMap attributes) {
System.out.print('<');
System.out.print(element.getNodeName());
if (attributes != null) {
int attributeCount = attributes.getLength();
for (int i = 0; i < attributeCount; i++) {
Attr attribute = (Attr)attributes.item(i);
System.out.print(' ');
System.out.print(attribute.getNodeName());
System.out.print("=\"");
System.out.print(normalize(attribute.getNodeValue()));
System.out.print('"');
}
}
System.out.println('>');
} // print(Element,NamedNodeMap)
/** Normalizes the given string. */
private static String normalize(String s) {
StringBuffer str = new StringBuffer();
int len = (s != null) ? s.length() : 0;
for (int i = 0; i < len; i++) {
char ch = s.charAt(i);
switch (ch) {
case '<': {
str.append("<");
break;
}
case '>': {
str.append(">");
break;
}
case '&': {
str.append("&");
break;
}
case '"': {
str.append(""");
break;
}
case '\r':
case '\n': {
str.append("&#");
str.append(Integer.toString(ch));
str.append(';');
break;
}
default: {
str.append(ch);
}
}
}
return str.toString();
} // normalize(String):String
//
// Main
//
/** Main program entry point. */
public static void main(String argv[]) {
Arguments argopt = new Arguments();
argopt.setUsage( new String[]
{ "usage: java dom.DOMFilter (options) uri ...","",
"options:",
" -p name Specify DOM parser wrapper by name.",
" -e name Specify element name to search for. Default is \"*\".",
" -a name Specify attribute name of specified elements.",
" -p name Specify DOM parser wrapper by name.",
" -n | -N Turn on/off namespace [default=on]",
" -v | -V Turn on/off validation [default=on]",
" -s | -S Turn on/off Schema support [default=on]",
" -f | -F Turn on/off Schema full consraint checking [default=off]",
" -d | -D Turn on/off deferred DOM [default=on]",
" -h This help screen."} );
// is there anything to do?
if (argv.length == 0) {
argopt.printUsage();
System.exit(1);
}
// vars
String parserName = DEFAULT_PARSER_NAME;
String elementName = "*"; // all elements
String attributeName = null;
/////
argopt.parseArgumentTokens(argv , new char[] { 'p', 'e', 'a'} );
int c;
String arg = null;
while ( ( arg = argopt.getlistFiles() ) != null ) {
outer:
while ( (c = argopt.getArguments()) != -1 ){
switch (c) {
case 'v':
setValidation = true;
break;
case 'V':
setValidation = false;
break;
case 'N':
setNameSpaces = false;
break;
case 'n':
setNameSpaces = true;
break;
case 'p':
parserName = argopt.getStringParameter();
break;
case 'd':
setDeferredDOM = true;
break;
case 'D':
setDeferredDOM = false;
break;
case 's':
setSchemaSupport = true;
break;
case 'S':
setSchemaSupport = false;
break;
case 'e':
elementName = argopt.getStringParameter();
break;
case 'a':
attributeName = argopt.getStringParameter();
break;
case 'f':
setSchemaFullSupport = true;
break;
case 'F':
setSchemaFullSupport = false;
break;
case '?':
case 'h':
case '-':
argopt.printUsage();
System.exit(1);
break;
case -1:
break outer;
default:
break;
}
}
// print uri
System.err.println(arg+':');
print(parserName, arg, elementName, attributeName);
}
} // main(String[])
} // class DOMFilter