19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2007 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.sax; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport org.xml.sax.helpers.DefaultHandler; 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport org.xml.sax.Attributes; 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport org.xml.sax.SAXException; 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport org.xml.sax.ContentHandler; 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport org.xml.sax.Locator; 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The root XML element. The entry point for this API. Not safe for concurrent 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * use. 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>For example, passing this XML: 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <pre> 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <feed xmlns='http://www.w3.org/2005/Atom'> 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <entry> 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <id>bob</id> 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </entry> 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </feed> 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </pre> 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to this code: 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <pre> 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * static final String ATOM_NAMESPACE = "http://www.w3.org/2005/Atom"; 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * ... 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * RootElement root = new RootElement(ATOM_NAMESPACE, "feed"); 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Element entry = root.getChild(ATOM_NAMESPACE, "entry"); 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * entry.getChild(ATOM_NAMESPACE, "id").setEndTextElementListener( 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * new EndTextElementListener() { 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * public void end(String body) { 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * System.out.println("Entry ID: " + body); 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * } 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * }); 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * XMLReader reader = ...; 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * reader.setContentHandler(root.getContentHandler()); 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * reader.parse(...); 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </pre> 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * would output: 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <pre> 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Entry ID: bob 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </pre> 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class RootElement extends Element { 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final Handler handler = new Handler(); 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Constructs a new root element with the given name. 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param uri the namespace 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param localName the local name 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public RootElement(String uri, String localName) { 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project super(null, uri, localName, 0); 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Constructs a new root element with the given name. Uses an empty string 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * as the namespace. 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param localName the local name 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public RootElement(String localName) { 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this("", localName); 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Gets the SAX {@code ContentHandler}. Pass this to your SAX parser. 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public ContentHandler getContentHandler() { 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return this.handler; 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project class Handler extends DefaultHandler { 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Locator locator; 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int depth = -1; 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Element current = null; 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project StringBuilder bodyBuilder = null; 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setDocumentLocator(Locator locator) { 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this.locator = locator; 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void startElement(String uri, String localName, String qName, 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Attributes attributes) throws SAXException { 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int depth = ++this.depth; 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (depth == 0) { 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // This is the root element. 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project startRoot(uri, localName, attributes); 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return; 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Prohibit mixed text and elements. 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (bodyBuilder != null) { 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new BadXmlException("Encountered mixed content" 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project + " within text element named " + current + ".", 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project locator); 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // If we're one level below the current element. 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (depth == current.depth + 1) { 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Look for a child to push onto the stack. 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Children children = current.children; 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (children != null) { 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Element child = children.get(uri, localName); 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (child != null) { 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project start(child, attributes); 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void startRoot(String uri, String localName, Attributes attributes) 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throws SAXException { 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Element root = RootElement.this; 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (root.uri.compareTo(uri) != 0 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project || root.localName.compareTo(localName) != 0) { 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new BadXmlException("Root element name does" 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project + " not match. Expected: " + root + ", Got: " 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project + Element.toString(uri, localName), locator); 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project start(root, attributes); 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void start(Element e, Attributes attributes) { 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Push element onto the stack. 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this.current = e; 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (e.startElementListener != null) { 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project e.startElementListener.start(attributes); 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (e.endTextElementListener != null) { 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this.bodyBuilder = new StringBuilder(); 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project e.resetRequiredChildren(); 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project e.visited = true; 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void characters(char[] buffer, int start, int length) 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throws SAXException { 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (bodyBuilder != null) { 1739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project bodyBuilder.append(buffer, start, length); 1749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void endElement(String uri, String localName, String qName) 1799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throws SAXException { 1809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Element current = this.current; 1819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // If we've ended the current element... 1839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (depth == current.depth) { 1849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project current.checkRequiredChildren(locator); 1859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Invoke end element listener. 1879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (current.endElementListener != null) { 1889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project current.endElementListener.end(); 1899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Invoke end text element listener. 1929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (bodyBuilder != null) { 1939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String body = bodyBuilder.toString(); 1949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project bodyBuilder = null; 1959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // We can assume that this listener is present. 1979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project current.endTextElementListener.end(body); 1989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Pop element off the stack. 2019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this.current = current.parent; 2029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project depth--; 2059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 208