toxiclibs 0.4.0 → 0.8.0

data/src/toxi/data/feeds/RSSEnclosure.java

@@ -0,0 +1,60 @@
+/*
+ *   __               .__       .__  ._____.           
+ * _/  |_  _______  __|__| ____ |  | |__\_ |__   ______
+ * \   __\/  _ \  \/  /  |/ ___\|  | |  || __ \ /  ___/
+ *  |  | (  <_> >    <|  \  \___|  |_|  || \_\ \\___ \ 
+ *  |__|  \____/__/\_ \__|\___  >____/__||___  /____  >
+ *                   \/       \/             \/     \/ 
+ *
+ * Copyright (c) 2006-2011 Karsten Schmidt
+ * 
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ * 
+ * http://creativecommons.org/licenses/LGPL/2.1/
+ * 
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+package toxi.data.feeds;
+
+import javax.xml.bind.annotation.XmlAttribute;
+
+/**
+ *
+ * @author tux
+ */
+public class RSSEnclosure {
+
+    @XmlAttribute
+    public String url,
+
+    /**
+     *
+     */
+    type;
+
+    /**
+     *
+     */
+    @XmlAttribute
+    public int length;
+
+    /**
+     *
+     * @return
+     */
+    public String toString() {
+        return url + " (" + type + ")";
+    }
+
+}

data/src/toxi/data/feeds/RSSFeed.java

@@ -0,0 +1,99 @@
+/*
+ *   __               .__       .__  ._____.           
+ * _/  |_  _______  __|__| ____ |  | |__\_ |__   ______
+ * \   __\/  _ \  \/  /  |/ ___\|  | |  || __ \ /  ___/
+ *  |  | (  <_> >    <|  \  \___|  |_|  || \_\ \\___ \ 
+ *  |__|  \____/__/\_ \__|\___  >____/__||___  /____  >
+ *                   \/       \/             \/     \/ 
+ *
+ * Copyright (c) 2006-2011 Karsten Schmidt
+ * 
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ * 
+ * http://creativecommons.org/licenses/LGPL/2.1/
+ * 
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+package toxi.data.feeds;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.util.Iterator;
+
+import javax.xml.bind.JAXBContext;
+import javax.xml.bind.JAXBException;
+import javax.xml.bind.annotation.XmlAttribute;
+import javax.xml.bind.annotation.XmlRootElement;
+
+/**
+ *
+ * @author tux
+ */
+@XmlRootElement(name = "rss")
+public class RSSFeed implements Iterable<RSSItem> {
+
+    /**
+     *
+     * @param stream
+     * @return
+     */
+    public static RSSFeed newFromStream(InputStream stream) {
+        RSSFeed feed = null;
+        try {
+            JAXBContext context = JAXBContext.newInstance(RSSFeed.class);
+            feed = (RSSFeed) context.createUnmarshaller().unmarshal(stream);
+        } catch (JAXBException e) {
+            e.printStackTrace();
+        }
+        return feed;
+    }
+
+    /**
+     *
+     * @param url
+     * @return
+     */
+    public static RSSFeed newFromURL(String url) {
+        RSSFeed feed = null;
+        try {
+            feed = newFromStream(new URL(url).openStream());
+        } catch (MalformedURLException e) {
+            e.printStackTrace();
+        } catch (IOException e) {
+            e.printStackTrace();
+        }
+        return feed;
+    }
+
+    /**
+     *
+     */
+    @XmlAttribute(name = "version")
+    public float version;
+
+    /**
+     *
+     */
+    public RSSChannel channel;
+
+    /**
+     *
+     * @return
+     */
+    public Iterator<RSSItem> iterator() {
+        return channel.items.iterator();
+    }
+}

data/src/toxi/data/feeds/RSSItem.java

@@ -0,0 +1,104 @@
+/*
+ *   __               .__       .__  ._____.           
+ * _/  |_  _______  __|__| ____ |  | |__\_ |__   ______
+ * \   __\/  _ \  \/  /  |/ ___\|  | |  || __ \ /  ___/
+ *  |  | (  <_> >    <|  \  \___|  |_|  || \_\ \\___ \ 
+ *  |__|  \____/__/\_ \__|\___  >____/__||___  /____  >
+ *                   \/       \/             \/     \/ 
+ *
+ * Copyright (c) 2006-2011 Karsten Schmidt
+ * 
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ * 
+ * http://creativecommons.org/licenses/LGPL/2.1/
+ * 
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+package toxi.data.feeds;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
+import javax.xml.datatype.XMLGregorianCalendar;
+
+import toxi.data.feeds.util.EntityStripper;
+import toxi.data.feeds.util.Rfc822DateAdapter;
+
+/**
+ *
+ * @author tux
+ */
+public class RSSItem {
+
+    /**
+     *
+     */
+    @XmlElement
+    public String title;
+
+    /**
+     *
+     */
+    @XmlElement
+    public String description;
+
+    /**
+     *
+     */
+    @XmlElement(required = true)
+    @XmlJavaTypeAdapter(Rfc822DateAdapter.class)
+    public XMLGregorianCalendar pubDate;
+
+    /**
+     *
+     */
+    @XmlElement
+    public String guid;
+
+    /**
+     *
+     */
+    @XmlElement
+    public String link;
+
+    /**
+     *
+     */
+    @XmlElement(name = "category")
+    public List<String> categories = new ArrayList<String>();
+
+    /**
+     *
+     */
+    @XmlElement(name = "enclosure")
+    public List<RSSEnclosure> enclosures = new ArrayList<RSSEnclosure>();
+
+    /**
+     *
+     * @return
+     */
+    public String getDescriptionPlain() {
+        return EntityStripper.flattenXML(description);
+    }
+
+    /**
+     *
+     * @return
+     */
+    public String getTitlePlain() {
+        return EntityStripper.flattenXML(title);
+    }
+}

data/src/toxi/data/feeds/util/EntityStripper.java

@@ -0,0 +1,2480 @@
+/*
+ * @(#)StripEntities.java
+ *
+ * Summary: Strips HTML entities such as " from a string, replacing them by their Unicode equivalents.
+ *
+ * Copyright: (c) 2002-2009 Roedy Green, Canadian Mind Products, http://mindprod.com
+ *
+ * Licence: This software may be copied and used freely for any purpose but military.
+ *          http://mindprod.com/contact/nonmil.html
+ *
+ * Requires: JDK 1.5+
+ *
+ * Created with: IntelliJ IDEA IDE.
+ *
+ * Version History:
+ *  2.6 2009-04-05 - StripEntities now leaves a space behind when it removes a <br><p><td> etc tag.
+ */
+package toxi.data.feeds.util;
+
+import java.util.HashMap;
+
+/**
+ * Strips HTML entities such as &quot; from a string, replacing them by their
+ * Unicode equivalents.
+ * 
+ * @author Roedy Green, Canadian Mind Products
+ * @version 2.6 2009-04-05 - StripEntities now leaves a space behind when it
+ *          removes a <br>
+ *          <p>
+ *          <td>etc tag.
+ * @since 2002-07-14
+ */
+public class EntityStripper {
+
+    // ------------------------------ CONSTANTS ------------------------------
+
+    /**
+     * true to enable the testing code.
+     */
+    private static final boolean DEBUGGING = true;
+
+    /**
+     * unicode nbsp control char, 160, 0x0a.
+     */
+    @SuppressWarnings({ "WeakerAccess" })
+    public static final char UNICODE_NBSP_160_0x0a = 160;
+
+    /**
+     * Longest an entity can be {@value #LONGEST_ENTITY}, at least in our
+     * tables, including the lead & and trail ;.
+     * 
+     */
+    public static final int LONGEST_ENTITY = 10;/* &thetasym; */
+
+    /**
+     * The shortest an entity can be {@value #SHORTEST_ENTITY}, at least in our
+     * tables, including the lead & and trailing ;.
+     * 
+     */
+    public static final int SHORTEST_ENTITY = 4;/* &#1; &lt; */
+
+    // ------------------------------ FIELDS ------------------------------
+
+    /**
+     * allows lookup by entity name, to get the corresponding char. Loaded from
+     * two hard-coded generated arrays burning into this class.
+     */
+    private static final HashMap<String, Character> entityToChar;
+
+    /**
+     * tags, that when removed should leave a space behind.
+     */
+    private static String[] spacingTags = { "tr", "td", "th", "p", "br", "dl",
+            "dt", "li" };
+
+    // -------------------------- PUBLIC STATIC METHODS
+    // --------------------------
+
+    static {
+        // build HashMap to look up entity name to get corresponding Unicode
+        // char number. Following code generated by Entities.
+        String[] entityKeys = {
+                // W A R N I N G ! _ M A N U A L L Y _ I N S E R T E D _
+                // G E N E
+                // R A T E D _ C O D E
+                // generated by Entities. Insert from
+                // com\mindprod\entities\entitiesjustkeys.javafrag
+                "quot"/* 34 : &#x22; quotation mark */, "amp"/*
+                                                              * 38 : &#x26;
+                                                              * ampersand
+                                                              */, "lt"/*
+                                                                       * 60 :
+                                                                       * &#x3c;
+                                                                       * less
+                                                                       * -than
+                                                                       * sign
+                                                                       */,
+                "gt"/* 62 : &#x3e; greater-than sign */, "nbsp"/*
+                                                                * 160 : &#xa0;
+                                                                * non-breaking
+                                                                * space
+                                                                */, "iexcl"/*
+                                                                            * 161
+                                                                            * :
+                                                                            * &
+                                                                            * #xa1
+                                                                            * ;
+                                                                            * inverted
+                                                                            * exclamation
+                                                                            * mark
+                                                                            */,
+                "cent"/* 162 : &#xa2; cent sign */, "pound"/*
+                                                            * 163 : &#xa3; pound
+                                                            * sign
+                                                            */, "curren"/*
+                                                                         * 164 :
+                                                                         * &
+                                                                         * #xa4;
+                                                                         * currency
+                                                                         * sign
+                                                                         */,
+                "yen"/* 165 : &#xa5; yen sign */, "brvbar"/*
+                                                           * 166 : &#xa6; broken
+                                                           * bar
+                                                           */, "sect"/*
+                                                                      * 167 :
+                                                                      * &#xa7;
+                                                                      * section
+                                                                      * sign
+                                                                      */,
+                "uml"/* 168 : &#xa8; diaeresis */, "copy"/*
+                                                          * 169 : &#xa9;
+                                                          * copyright sign
+                                                          */, "ordf"/*
+                                                                     * 170 :
+                                                                     * &#xaa;
+                                                                     * feminine
+                                                                     * ordinal
+                                                                     * indicator
+                                                                     */,
+                "laquo"/* 171 : &#xab; left guillemot */, "not"/*
+                                                                * 172 : &#xac;
+                                                                * not sign
+                                                                */, "shy"/*
+                                                                          * 173
+                                                                          * :
+                                                                          * &#xad
+                                                                          * ;
+                                                                          * soft
+                                                                          * hyphen
+                                                                          */,
+                "reg"/* 174 : &#xae; registered sign */, "macr"/*
+                                                                * 175 : &#xaf;
+                                                                * macron
+                                                                */, "deg"/*
+                                                                          * 176
+                                                                          * :
+                                                                          * &#xb0
+                                                                          * ;
+                                                                          * degree
+                                                                          * sign
+                                                                          */,
+                "plusmn"/* 177 : &#xb1; plus-minus sign */, "sup2"/*
+                                                                   * 178 :
+                                                                   * &#xb2;
+                                                                   * superscript
+                                                                   * two
+                                                                   */,
+                "sup3"/* 179 : &#xb3; superscript three */, "acute"/*
+                                                                    * 180 :
+                                                                    * &#xb4;
+                                                                    * acute
+                                                                    * accent
+                                                                    */,
+                "micro"/* 181 : &#xb5; micro sign */, "para"/*
+                                                             * 182 : &#xb6;
+                                                             * pilcrow sign
+                                                             */, "middot"/*
+                                                                          * 183
+                                                                          * :
+                                                                          * &#xb7
+                                                                          * ;
+                                                                          * middle
+                                                                          * dot
+                                                                          */,
+                "cedil"/* 184 : &#xb8; cedilla */, "sup1"/*
+                                                          * 185 : &#xb9;
+                                                          * superscript one
+                                                          */, "ordm"/*
+                                                                     * 186 :
+                                                                     * &#xba;
+                                                                     * masculine
+                                                                     * ordinal
+                                                                     * indicator
+                                                                     */,
+                "raquo"/* 187 : &#xbb; right guillemot */, "frac14"/*
+                                                                    * 188 :
+                                                                    * &#xbc;
+                                                                    * vulgar
+                                                                    * fraction
+                                                                    * 1/4
+                                                                    */,
+                "frac12"/* 189 : &#xbd; vulgar fraction 1/2 */, "frac34"/*
+                                                                         * 190 :
+                                                                         * &
+                                                                         * #xbe;
+                                                                         * vulgar
+                                                                         * fraction
+                                                                         * 3/4
+                                                                         */,
+                "iquest"/* 191 : &#xbf; inverted question mark */, "Agrave"/*
+                                                                            * 192
+                                                                            * :
+                                                                            * &
+                                                                            * #xc0
+                                                                            * ;
+                                                                            * Latin
+                                                                            * capital
+                                                                            * letter
+                                                                            * A
+                                                                            * with
+                                                                            * grave
+                                                                            */,
+                "Aacute"/*
+                         * 193 : &#xc1; Latin capital letter A with acute
+                         */, "Acirc"/*
+                                     * 194 : &#xc2; Latin capital letter A with
+                                     * circumflex
+                                     */, "Atilde"/*
+                                                  * 195 : &#xc3; Latin capital
+                                                  * letter A with tilde
+                                                  */, "Auml"/*
+                                                             * 196 : &#xc4;
+                                                             * Latin capital
+                                                             * letter A with
+                                                             * diaeresis
+                                                             */, "Aring"/*
+                                                                         * 197 :
+                                                                         * &
+                                                                         * #xc5;
+                                                                         * Latin
+                                                                         * capital
+                                                                         * letter
+                                                                         * A
+                                                                         * with
+                                                                         * ring
+                                                                         * above
+                                                                         */,
+                "AElig"/* 198 : &#xc6; Latin capital letter AE */, "Ccedil"/*
+                                                                            * 199
+                                                                            * :
+                                                                            * &
+                                                                            * #xc7
+                                                                            * ;
+                                                                            * Latin
+                                                                            * capital
+                                                                            * letter
+                                                                            * C
+                                                                            * with
+                                                                            * cedilla
+                                                                            */,
+                "Egrave"/*
+                         * 200 : &#xc8; Latin capital letter E with grave
+                         */, "Eacute"/*
+                                      * 201 : &#xc9; Latin capital letter E with
+                                      * acute
+                                      */, "Ecirc"/*
+                                                  * 202 : &#xca; Latin capital
+                                                  * letter E with circumflex
+                                                  */, "Euml"/*
+                                                             * 203 : &#xcb;
+                                                             * Latin capital
+                                                             * letter E with
+                                                             * diaeresis
+                                                             */, "Igrave"/*
+                                                                          * 204
+                                                                          * :
+                                                                          * &#xcc
+                                                                          * ;
+                                                                          * Latin
+                                                                          * capital
+                                                                          * letter
+                                                                          * I
+                                                                          * with
+                                                                          * grave
+                                                                          */,
+                "Iacute"/*
+                         * 205 : &#xcd; Latin capital letter I with acute
+                         */, "Icirc"/*
+                                     * 206 : &#xce; Latin capital letter I with
+                                     * circumflex
+                                     */, "Iuml"/*
+                                                * 207 : &#xcf; Latin capital
+                                                * letter I with diaeresis
+                                                */, "ETH"/*
+                                                          * 208 : &#xd0; Latin
+                                                          * capital letter eth
+                                                          */, "Ntilde"/*
+                                                                       * 209 :
+                                                                       * &#xd1;
+                                                                       * Latin
+                                                                       * capital
+                                                                       * letter
+                                                                       * N with
+                                                                       * tilde
+                                                                       */,
+                "Ograve"/*
+                         * 210 : &#xd2; Latin capital letter O with grave
+                         */, "Oacute"/*
+                                      * 211 : &#xd3; Latin capital letter O with
+                                      * acute
+                                      */, "Ocirc"/*
+                                                  * 212 : &#xd4; Latin capital
+                                                  * letter O with circumflex
+                                                  */, "Otilde"/*
+                                                               * 213 : &#xd5;
+                                                               * Latin capital
+                                                               * letter O with
+                                                               * tilde
+                                                               */, "Ouml"/*
+                                                                          * 214
+                                                                          * :
+                                                                          * &#xd6
+                                                                          * ;
+                                                                          * Latin
+                                                                          * capital
+                                                                          * letter
+                                                                          * O
+                                                                          * with
+                                                                          * diaeresis
+                                                                          */,
+                "times"/* 215 : &#xd7; multiplication sign */, "Oslash"/*
+                                                                        * 216 :
+                                                                        * &#xd8;
+                                                                        * Latin
+                                                                        * capital
+                                                                        * letter
+                                                                        * O with
+                                                                        * stroke
+                                                                        */,
+                "Ugrave"/*
+                         * 217 : &#xd9; Latin capital letter U with grave
+                         */, "Uacute"/*
+                                      * 218 : &#xda; Latin capital letter U with
+                                      * acute
+                                      */, "Ucirc"/*
+                                                  * 219 : &#xdb; Latin capital
+                                                  * letter U with circumflex
+                                                  */, "Uuml"/*
+                                                             * 220 : &#xdc;
+                                                             * Latin capital
+                                                             * letter U with
+                                                             * diaeresis
+                                                             */, "Yacute"/*
+                                                                          * 221
+                                                                          * :
+                                                                          * &#xdd
+                                                                          * ;
+                                                                          * Latin
+                                                                          * capital
+                                                                          * letter
+                                                                          * Y
+                                                                          * with
+                                                                          * acute
+                                                                          */,
+                "THORN"/* 222 : &#xde; Latin capital letter Thorn */,
+                "szlig"/* 223 : &#xdf; Latin small letter sharp s */,
+                "agrave"/* 224 : &#xe0; Latin small letter a with grave */,
+                "aacute"/* 225 : &#xe1; Latin small letter a with acute */,
+                "acirc"/*
+                        * 226 : &#xe2; Latin small letter a with circumflex
+                        */, "atilde"/*
+                                     * 227 : &#xe3; Latin small letter a with
+                                     * tilde
+                                     */, "auml"/*
+                                                * 228 : &#xe4; Latin small
+                                                * letter a with diaeresis
+                                                */, "aring"/*
+                                                            * 229 : &#xe5; Latin
+                                                            * small letter a
+                                                            * with ring above
+                                                            */, "aelig"/*
+                                                                        * 230 :
+                                                                        * &#xe6;
+                                                                        * Latin
+                                                                        * lowercase
+                                                                        * ligature
+                                                                        * ae
+                                                                        */,
+                "ccedil"/*
+                         * 231 : &#xe7; Latin small letter c with cedilla
+                         */, "egrave"/*
+                                      * 232 : &#xe8; Latin small letter e with
+                                      * grave
+                                      */, "eacute"/*
+                                                   * 233 : &#xe9; Latin small
+                                                   * letter e with acute
+                                                   */, "ecirc"/*
+                                                               * 234 : &#xea;
+                                                               * Latin small
+                                                               * letter e with
+                                                               * circumflex
+                                                               */, "euml"/*
+                                                                          * 235
+                                                                          * :
+                                                                          * &#xeb
+                                                                          * ;
+                                                                          * Latin
+                                                                          * small
+                                                                          * letter
+                                                                          * e
+                                                                          * with
+                                                                          * diaeresis
+                                                                          */,
+                "igrave"/* 236 : &#xec; Latin small letter i with grave */,
+                "iacute"/* 237 : &#xed; Latin small letter i with acute */,
+                "icirc"/*
+                        * 238 : &#xee; Latin small letter i with circumflex
+                        */, "iuml"/*
+                                   * 239 : &#xef; Latin small letter i with
+                                   * diaeresis
+                                   */, "eth"/*
+                                             * 240 : &#xf0; Latin small letter
+                                             * eth
+                                             */, "ntilde"/*
+                                                          * 241 : &#xf1; Latin
+                                                          * small letter n with
+                                                          * tilde
+                                                          */, "ograve"/*
+                                                                       * 242 :
+                                                                       * &#xf2;
+                                                                       * Latin
+                                                                       * small
+                                                                       * letter
+                                                                       * o with
+                                                                       * grave
+                                                                       */,
+                "oacute"/* 243 : &#xf3; Latin small letter o with acute */,
+                "ocirc"/*
+                        * 244 : &#xf4; Latin small letter o with circumflex
+                        */, "otilde"/*
+                                     * 245 : &#xf5; Latin small letter o with
+                                     * tilde
+                                     */, "ouml"/*
+                                                * 246 : &#xf6; Latin small
+                                                * letter o with diaeresis
+                                                */, "divide"/*
+                                                             * 247 : &#xf7;
+                                                             * division sign
+                                                             */, "oslash"/*
+                                                                          * 248
+                                                                          * :
+                                                                          * &#xf8
+                                                                          * ;
+                                                                          * Latin
+                                                                          * small
+                                                                          * letter
+                                                                          * o
+                                                                          * with
+                                                                          * stroke
+                                                                          */,
+                "ugrave"/* 249 : &#xf9; Latin small letter u with grave */,
+                "uacute"/* 250 : &#xfa; Latin small letter u with acute */,
+                "ucirc"/*
+                        * 251 : &#xfb; Latin small letter u with circumflex
+                        */, "uuml"/*
+                                   * 252 : &#xfc; Latin small letter u with
+                                   * diaeresis
+                                   */, "yacute"/*
+                                                * 253 : &#xfd; Latin small
+                                                * letter y with acute
+                                                */, "thorn"/*
+                                                            * 254 : &#xfe; Latin
+                                                            * small letter thorn
+                                                            */, "yuml"/*
+                                                                       * 255 :
+                                                                       * &#xff;
+                                                                       * Latin
+                                                                       * small
+                                                                       * letter
+                                                                       * y with
+                                                                       * diaeresis
+                                                                       */,
+                "OElig"/* 338 : &#x152; Latin capital ligature oe */,
+                "oelig"/* 339 : &#x153; Latin small ligature oe */,
+                "Scaron"/*
+                         * 352 : &#x160; Latin capital letter S with caron
+                         */, "scaron"/*
+                                      * 353 : &#x161; Latin small letter s with
+                                      * caron
+                                      */, "Yuml"/*
+                                                 * 376 : &#x178; Latin capital
+                                                 * letter Y with diaeresis
+                                                 */, "fnof"/*
+                                                            * 402 : &#x192;
+                                                            * Latin small letter
+                                                            * f with hook
+                                                            */, "circ"/*
+                                                                       * 710 :
+                                                                       * &#x2c6;
+                                                                       * modifier
+                                                                       * letter
+                                                                       * circumflex
+                                                                       * accent
+                                                                       */,
+                "tilde"/* 732 : &#x2dc; small tilde */, "Alpha"/*
+                                                                * 913 : &#x391;
+                                                                * Greek capital
+                                                                * letter Alpha
+                                                                */, "Beta"/*
+                                                                           * 914
+                                                                           * :
+                                                                           * &#
+                                                                           * x392
+                                                                           * ;
+                                                                           * Greek
+                                                                           * capital
+                                                                           * letter
+                                                                           * Beta
+                                                                           */,
+                "Gamma"/*
+                        * 915 : & #x393 ; Greek capital letter Gamma
+                        */,
+                "Delta"/* 916 : &#x394; Greek capital letter Delta */,
+                "Epsilon"/* 917 : &#x395; Greek capital letter Epsilon */,
+                "Zeta"/* 918 : &#x396; Greek capital letter Zeta */, "Eta"/*
+                                                                           * 919
+                                                                           * : &
+                                                                           * #
+                                                                           * x397
+                                                                           * ;
+                                                                           * Greek
+                                                                           * capital
+                                                                           * letter
+                                                                           * Eta
+                                                                           */,
+                "Theta"/* 920 : &#x398; Greek capital letter Theta */,
+                "Iota"/* 921 : &#x399; Greek capital letter Iota */,
+                "Kappa"/*
+                        * 922 : & #x39a ; Greek capital letter Kappa
+                        */,
+                "Lambda"/* 923 : &#x39b; Greek capital letter Lambda */,
+                "Mu"/* 924 : &#x39c; Greek capital letter Mu */, "Nu"/*
+                                                                      * 925 :
+                                                                      * &#x39d;
+                                                                      * Greek
+                                                                      * capital
+                                                                      * letter
+                                                                      * Nu
+                                                                      */,
+                "Xi"/* 926 : &#x39e; Greek capital letter Xi */, "Omicron"/*
+                                                                           * 927
+                                                                           * : &
+                                                                           * #
+                                                                           * x39f
+                                                                           * ;
+                                                                           * Greek
+                                                                           * capital
+                                                                           * letter
+                                                                           * Omicron
+                                                                           */,
+                "Pi"/* 928 : &#x3a0; Greek capital letter Pi */, "Rho"/*
+                                                                       * 929 :
+                                                                       * &#x3a1;
+                                                                       * Greek
+                                                                       * capital
+                                                                       * letter
+                                                                       * Rho
+                                                                       */,
+                "Sigma"/* 931 : &#x3a3; Greek capital letter Sigma */,
+                "Tau"/* 932 : &#x3a4; Greek capital letter Tau */,
+                "Upsilon"/* 933 : &#x3a5; Greek capital letter Upsilon */,
+                "Phi"/* 934 : &#x3a6; Greek capital letter Phi */, "Chi"/*
+                                                                         * 935 :
+                                                                         * &
+                                                                         * #x3a7
+                                                                         * ;
+                                                                         * Greek
+                                                                         * capital
+                                                                         * letter
+                                                                         * Chi
+                                                                         */,
+                "Psi"/* 936 : &#x3a8; Greek capital letter Psi */, "Omega"/*
+                                                                           * 937
+                                                                           * : &
+                                                                           * #
+                                                                           * x3a9
+                                                                           * ;
+                                                                           * Greek
+                                                                           * capital
+                                                                           * letter
+                                                                           * Omega
+                                                                           */,
+                "alpha"/* 945 : &#x3b1; Greek small letter alpha */, "beta"/*
+                                                                            * 946
+                                                                            * :
+                                                                            * &
+                                                                            * #x3b2
+                                                                            * ;
+                                                                            * Greek
+                                                                            * small
+                                                                            * letter
+                                                                            * beta
+                                                                            */,
+                "gamma"/*
+                        * 947 : & #x3b3 ; Greek small letter gamma
+                        */,
+                "delta"/* 948 : &#x3b4; Greek small letter delta */,
+                "epsilon"/* 949 : &#x3b5; Greek small letter epsilon */,
+                "zeta"/* 950 : &#x3b6; Greek small letter zeta */, "eta"/*
+                                                                         * 951 :
+                                                                         * &
+                                                                         * #x3b7
+                                                                         * ;
+                                                                         * Greek
+                                                                         * small
+                                                                         * letter
+                                                                         * eta
+                                                                         */,
+                "theta"/* 952 : &#x3b8; Greek small letter theta */, "iota"/*
+                                                                            * 953
+                                                                            * :
+                                                                            * &
+                                                                            * #x3b9
+                                                                            * ;
+                                                                            * Greek
+                                                                            * small
+                                                                            * letter
+                                                                            * iota
+                                                                            */,
+                "kappa"/*
+                        * 954 : & #x3ba ; Greek small letter kappa
+                        */,
+                "lambda"/* 955 : &#x3bb; Greek small letter lambda */, "mu"/*
+                                                                            * 956
+                                                                            * :
+                                                                            * &
+                                                                            * #x3bc
+                                                                            * ;
+                                                                            * Greek
+                                                                            * small
+                                                                            * letter
+                                                                            * mu
+                                                                            */,
+                "nu"/*
+                     * 957 : &#x3bd; Greek small letter nu
+                     */, "xi"/* 958 : &#x3be; Greek small letter xi */,
+                "omicron"/*
+                          * 959 : & #x3bf ; Greek small letter omicron
+                          */, "pi"/* 960 : &#x3c0; Greek small letter pi */,
+                "rho"/*
+                      * 961 : &#x3c1; Greek small letter rho
+                      */, "sigmaf"/*
+                                   * 962 : &#x3c2; Greek small letter final
+                                   * sigma
+                                   */, "sigma"/*
+                                               * 963 : &#x3c3; Greek small
+                                               * letter sigma
+                                               */, "tau"/*
+                                                         * 964 : &#x3c4; Greek
+                                                         * small letter tau
+                                                         */, "upsilon"/*
+                                                                       * 965 : &
+                                                                       * #x3c5 ;
+                                                                       * Greek
+                                                                       * small
+                                                                       * letter
+                                                                       * upsilon
+                                                                       */,
+                "phi"/* 966 : &#x3c6; Greek small letter phi */, "chi"/*
+                                                                       * 967 :
+                                                                       * &#x3c7;
+                                                                       * Greek
+                                                                       * small
+                                                                       * letter
+                                                                       * chi
+                                                                       */,
+                "psi"/* 968 : &#x3c8; Greek small letter psi */, "omega"/*
+                                                                         * 969 :
+                                                                         * &
+                                                                         * #x3c9
+                                                                         * ;
+                                                                         * Greek
+                                                                         * small
+                                                                         * letter
+                                                                         * omega
+                                                                         */,
+                "thetasym"/* 977 : &#x3d1; Greek theta symbol */, "upsih"/*
+                                                                          * 978
+                                                                          * : &
+                                                                          * #
+                                                                          * x3d2
+                                                                          * ;
+                                                                          * Greek
+                                                                          * upsilon
+                                                                          * with
+                                                                          * hook
+                                                                          * symbol
+                                                                          */,
+                "piv"/* 982 : &#x3d6; Greek pi symbol */, "ensp"/*
+                                                                 * 8194 :
+                                                                 * &#x2002; en
+                                                                 * space
+                                                                 */, "emsp"/*
+                                                                            * 8195
+                                                                            * :
+                                                                            * &
+                                                                            * #x2003
+                                                                            * ;
+                                                                            * em
+                                                                            * space
+                                                                            */,
+                "thinsp"/*
+                         * 8201 : &#x2009; thin space
+                         */, "zwnj"/*
+                                    * 8204 : &#x200c ; zero width non -joiner
+                                    */, "zwj"/*
+                                              * 8205 : &#x200d; zero width
+                                              * joiner
+                                              */, "lrm"/*
+                                                        * 8206 : &#x200e;
+                                                        * left-to-right mark
+                                                        */, "rlm"/*
+                                                                  * 8207 :
+                                                                  * &#x200f ;
+                                                                  * right -
+                                                                  * to-left mark
+                                                                  */,
+                "ndash"/* 8211 : &#x2013; en dash */, "mdash"/*
+                                                              * 8212 : &#x2014;
+                                                              * em dash
+                                                              */, "lsquo"/*
+                                                                          * 8216
+                                                                          * :
+                                                                          * &#x2018
+                                                                          * ;
+                                                                          * left
+                                                                          * single
+                                                                          * -6
+                                                                          * quotation
+                                                                          * mark
+                                                                          */,
+                "rsquo"/* 8217 : &#x2019; right single-9 quotation mark */,
+                "sbquo"/* 8218 : &#x201a; single low-9 quotation mark */,
+                "ldquo"/* 8220 : &#x201c; left double-66 quotation mark */,
+                "rdquo"/* 8221 : &#x201d; right double-99 quotation mark */,
+                "bdquo"/* 8222 : &#x201e; double low-99 quotation mark */,
+                "dagger"/* 8224 : &#x2020; dagger */, "Dagger"/*
+                                                               * 8225 : &#x2021;
+                                                               * double dagger
+                                                               */, "bull"/*
+                                                                          * 8226
+                                                                          * :
+                                                                          * &#x2022
+                                                                          * ;
+                                                                          * bullet
+                                                                          */,
+                "hellip"/* 8230 : &#x2026; horizontal ellipsis */, "permil"/*
+                                                                            * 8240
+                                                                            * :
+                                                                            * &
+                                                                            * #x2030
+                                                                            * ;
+                                                                            * per
+                                                                            * mille
+                                                                            * sign
+                                                                            */,
+                "prime"/*
+                        * 8242 : &#x2032; prime
+                        */, "Prime"/* 8243 : &#x2033; double prime */,
+                "lsaquo"/*
+                         * 8249 : &#x2039; single left -pointing angle quotation
+                         * mark
+                         */, "rsaquo"/*
+                                      * 8250 : &#x203a; single right-pointing
+                                      * angle quotation mark
+                                      */,
+                "oline"/* 8254 : &#x203e; overline */, "frasl"/*
+                                                               * 8260 : &#x2044;
+                                                               * fraction slash
+                                                               */, "euro"/*
+                                                                          * 8364
+                                                                          * :
+                                                                          * &#x20ac
+                                                                          * ;
+                                                                          * Euro
+                                                                          * currency
+                                                                          * sign
+                                                                          */,
+                "image"/* 8465 : &#x2111; black-letter capital i */,
+                "weierp"/* 8472 : &#x2118; script capital p */, "real"/*
+                                                                       * 8476 :
+                                                                       * &
+                                                                       * #x211c;
+                                                                       * black
+                                                                       * -letter
+                                                                       * capital
+                                                                       * r
+                                                                       */,
+                "trade"/* 8482 : &#x2122; trademark sign */, "alefsym"/*
+                                                                       * 8501 :
+                                                                       * &#x2135
+                                                                       * ; alef
+                                                                       * symbol
+                                                                       */,
+                "larr"/* 8592 : &#x2190; leftwards arrow */, "uarr"/*
+                                                                    * 8593 :
+                                                                    * &#x2191;
+                                                                    * upwards
+                                                                    * arrow
+                                                                    */,
+                "rarr"/* 8594 : &#x2192; rightwards arrow */, "darr"/*
+                                                                     * 8595 :
+                                                                     * &#x2193;
+                                                                     * downwards
+                                                                     * arrow
+                                                                     */,
+                "harr"/* 8596 : &#x2194; left right arrow */, "crarr"/*
+                                                                      * 8629 :
+                                                                      * &#x21b5;
+                                                                      * downwards
+                                                                      * arrow
+                                                                      * with
+                                                                      * corner
+                                                                      * leftwards
+                                                                      */,
+                "lArr"/* 8656 : &#x21d0; leftwards double arrow */, "uArr"/*
+                                                                           * 8657
+                                                                           * :
+                                                                           * &#
+                                                                           * x21d1
+                                                                           * ;
+                                                                           * upwards
+                                                                           * double
+                                                                           * arrow
+                                                                           */,
+                "rArr"/* 8658 : &#x21d2; rightwards double arrow */, "dArr"/*
+                                                                            * 8659
+                                                                            * :
+                                                                            * &
+                                                                            * #x21d3
+                                                                            * ;
+                                                                            * downwards
+                                                                            * double
+                                                                            * arrow
+                                                                            */,
+                "hArr"/* 8660 : &#x21d4; left right double arrow */,
+                "forall"/* 8704 : &#x2200; for all */, "part"/*
+                                                              * 8706 : &#x2202;
+                                                              * partial
+                                                              * differential
+                                                              */, "exist"/*
+                                                                          * 8707
+                                                                          * :
+                                                                          * &#x2203
+                                                                          * ;
+                                                                          * there
+                                                                          * exists
+                                                                          */,
+                "empty"/* 8709 : &#x2205; empty set */, "nabla"/*
+                                                                * 8711 :
+                                                                * &#x2207; nabla
+                                                                */, "isin"/*
+                                                                           * 8712
+                                                                           * :
+                                                                           * &#
+                                                                           * x2208
+                                                                           * ;
+                                                                           * element
+                                                                           * of
+                                                                           */,
+                "notin"/*
+                        * 8713 : &#x2209; not an element of
+                        */, "ni"/*
+                                 * 8715 : &#x220b; contains as member
+                                 */, "prod"/* 8719 : &#x220f; n-ary product */,
+                "sum"/*
+                      * 8721 : &#x2211; n-ary summation
+                      */, "minus"/*
+                                  * 8722 : &#x2212 ; minus sign
+                                  */, "lowast"/*
+                                               * 8727 : &#x2217; asterisk
+                                               * operator
+                                               */, "radic"/*
+                                                           * 8730 : &#x221a ;
+                                                           * square root
+                                                           */, "prop"/*
+                                                                      * 8733 :
+                                                                      * &#x221d;
+                                                                      * proportional
+                                                                      * to
+                                                                      */,
+                "infin"/*
+                        * 8734 : &#x221e; infinity
+                        */, "ang"/*
+                                  * 8736 : &#x2220 ; angle
+                                  */, "and"/* 8743 : &#x2227; logical and */,
+                "or"/*
+                     * 8744 : &#x2228; logical or
+                     */, "cap"/*
+                               * 8745 : &#x2229; intersection
+                               */, "cup"/* 8746 : &#x222a; union */, "int"/*
+                                                                           * 8747
+                                                                           * :
+                                                                           * &#
+                                                                           * x222b
+                                                                           * ;
+                                                                           * integral
+                                                                           */,
+                "there4"/*
+                         * 8756 : &#x2234; therefore
+                         */, "sim"/*
+                                   * 8764 : &#x223c; tilde operator
+                                   */,
+                "cong"/* 8773 : &#x2245; congruent to */, "asymp"/*
+                                                                  * 8776 :
+                                                                  * &#x2248;
+                                                                  * asymptotic
+                                                                  * to
+                                                                  */, "ne"/*
+                                                                           * 8800
+                                                                           * :
+                                                                           * &#
+                                                                           * x2260
+                                                                           * ;
+                                                                           * not
+                                                                           * equal
+                                                                           * to
+                                                                           */,
+                "equiv"/* 8801 : &#x2261; identical to */, "le"/*
+                                                                * 8804 :
+                                                                * &#x2264;
+                                                                * less-than or
+                                                                * equal to
+                                                                */, "ge"/*
+                                                                         * 8805
+                                                                         * :
+                                                                         * &#x2265
+                                                                         * ;
+                                                                         * greater
+                                                                         * -than
+                                                                         * or
+                                                                         * equal
+                                                                         * to
+                                                                         */,
+                "sub"/* 8834 : &#x2282; subset of */, "sup"/*
+                                                            * 8835 : &#x2283;
+                                                            * superset of
+                                                            */, "nsub"/*
+                                                                       * 8836 :
+                                                                       * &
+                                                                       * #x2284;
+                                                                       * not a
+                                                                       * subset
+                                                                       * of
+                                                                       */,
+                "sube"/* 8838 : &#x2286; subset of or equal to */, "supe"/*
+                                                                          * 8839
+                                                                          * :
+                                                                          * &#x2287
+                                                                          * ;
+                                                                          * superset
+                                                                          * of
+                                                                          * or
+                                                                          * equal
+                                                                          * to
+                                                                          */,
+                "oplus"/* 8853 : &#x2295; circled plus */, "otimes"/*
+                                                                    * 8855 :
+                                                                    * &#x2297;
+                                                                    * circled
+                                                                    * times
+                                                                    */,
+                "perp"/* 8869 : &#x22a5; up tack */, "sdot"/*
+                                                            * 8901 : &#x22c5;
+                                                            * dot operator
+                                                            */, "lceil"/*
+                                                                        * 8968 :
+                                                                        * &
+                                                                        * #x2308
+                                                                        * ; left
+                                                                        * ceiling
+                                                                        */,
+                "rceil"/* 8969 : &#x2309; right ceiling */, "lfloor"/*
+                                                                     * 8970 :
+                                                                     * &#x230a;
+                                                                     * left
+                                                                     * floor
+                                                                     */,
+                "rfloor"/* 8971 : &#x230b; right floor */, "lang"/*
+                                                                  * 9001 :
+                                                                  * &#x2329;
+                                                                  * left
+                                                                  * -pointing
+                                                                  * angle
+                                                                  * bracket
+                                                                  */,
+                "rang"/* 9002 : &#x232a; right-pointing angle bracket */,
+                "loz"/* 9674 : &#x25ca; lozenge */, "spades"/*
+                                                             * 9824 : &#x2660;
+                                                             * black spade suit
+                                                             */, "clubs"/*
+                                                                         * 9827
+                                                                         * :
+                                                                         * &#x2663
+                                                                         * ;
+                                                                         * black
+                                                                         * club
+                                                                         * suit
+                                                                         */,
+                "hearts"/* 9829 : &#x2665; black heart suit */, "diams"/*
+                                                                        * 9830 :
+                                                                        * &
+                                                                        * #x2666
+                                                                        * ;
+                                                                        * black
+                                                                        * diamond
+                                                                        * suit
+                                                                        */, };
+        char[] entityValues = {
+                // W A R N I N G ! _ M A N U A L L Y _ I N S E R T E D _
+                // G E N E
+                // R A T E D _ C O D E
+                // generated by Entities. Insert from
+                // com\mindprod\entities\entitiesjustkeys.javafrag
+                34/* &quot; : &#x22; quotation mark */, 38/*
+                                                           * &amp; : &#x26;
+                                                           * ampersand
+                                                           */, 60/*
+                                                                  * &lt; :
+                                                                  * &#x3c;
+                                                                  * less-than
+                                                                  * sign
+                                                                  */, 62/*
+                                                                         * &gt;
+                                                                         * :
+                                                                         * &#x3e
+                                                                         * ;
+                                                                         * greater
+                                                                         * -than
+                                                                         * sign
+                                                                         */,
+                160/* &nbsp; : &#xa0; non-breaking space */, 161/*
+                                                                 * &iexcl; :
+                                                                 * &#xa1;
+                                                                 * inverted
+                                                                 * exclamation
+                                                                 * mark
+                                                                 */, 162/*
+                                                                         * &cent;
+                                                                         * :
+                                                                         * &#xa2
+                                                                         * ;
+                                                                         * cent
+                                                                         * sign
+                                                                         */,
+                163/* &pound; : &#xa3; pound sign */, 164/*
+                                                          * &curren; : &#xa4;
+                                                          * currency sign
+                                                          */, 165/*
+                                                                  * &yen; :
+                                                                  * &#xa5; yen
+                                                                  * sign
+                                                                  */, 166/*
+                                                                          * &brvbar
+                                                                          * ; :
+                                                                          * &
+                                                                          * #xa6
+                                                                          * ;
+                                                                          * broken
+                                                                          * bar
+                                                                          */,
+                167/* &sect; : &#xa7; section sign */, 168/*
+                                                           * &uml; : &#xa8;
+                                                           * diaeresis
+                                                           */, 169/*
+                                                                   * &copy; :
+                                                                   * &#xa9;
+                                                                   * copyright
+                                                                   * sign
+                                                                   */, 170/*
+                                                                           * &ordf
+                                                                           * ; :
+                                                                           * &
+                                                                           * #xaa
+                                                                           * ;
+                                                                           * feminine
+                                                                           * ordinal
+                                                                           * indicator
+                                                                           */,
+                171/* &laquo; : &#xab; left guillemot */, 172/*
+                                                              * &not; : &#xac;
+                                                              * not sign
+                                                              */, 173/*
+                                                                      * &shy; :
+                                                                      * &#xad;
+                                                                      * soft
+                                                                      * hyphen
+                                                                      */,
+                174/* &reg; : &#xae; registered sign */, 175/*
+                                                             * &macr; : &#xaf;
+                                                             * macron
+                                                             */, 176/*
+                                                                     * &deg; :
+                                                                     * &#xb0;
+                                                                     * degree
+                                                                     * sign
+                                                                     */,
+                177/* &plusmn; : &#xb1; plus-minus sign */, 178/*
+                                                                * &sup2; :
+                                                                * &#xb2;
+                                                                * superscript
+                                                                * two
+                                                                */, 179/*
+                                                                        * &sup3;
+                                                                        * :
+                                                                        * &#xb3;
+                                                                        * superscript
+                                                                        * three
+                                                                        */,
+                180/* &acute; : &#xb4; acute accent */, 181/*
+                                                            * &micro; : &#xb5;
+                                                            * micro sign
+                                                            */, 182/*
+                                                                    * &para; :
+                                                                    * &#xb6;
+                                                                    * pilcrow
+                                                                    * sign
+                                                                    */, 183/*
+                                                                            * &
+                                                                            * middot
+                                                                            * ;
+                                                                            * :
+                                                                            * &
+                                                                            * #xb7
+                                                                            * ;
+                                                                            * middle
+                                                                            * dot
+                                                                            */,
+                184/* &cedil; : &#xb8; cedilla */, 185/*
+                                                       * &sup1; : &#xb9;
+                                                       * superscript one
+                                                       */, 186/*
+                                                               * &ordm; : &#xba;
+                                                               * masculine
+                                                               * ordinal
+                                                               * indicator
+                                                               */, 187/*
+                                                                       * &raquo;
+                                                                       * :
+                                                                       * &#xbb;
+                                                                       * right
+                                                                       * guillemot
+                                                                       */,
+                188/* &frac14; : &#xbc; vulgar fraction 1/4 */, 189/*
+                                                                    * &frac12; :
+                                                                    * &#xbd;
+                                                                    * vulgar
+                                                                    * fraction
+                                                                    * 1/2
+                                                                    */, 190/*
+                                                                            * &
+                                                                            * frac34
+                                                                            * ;
+                                                                            * :
+                                                                            * &
+                                                                            * #xbe
+                                                                            * ;
+                                                                            * vulgar
+                                                                            * fraction
+                                                                            * 3
+                                                                            * /4
+                                                                            */,
+                191/* &iquest; : &#xbf; inverted question mark */, 192/*
+                                                                       * &Agrave;
+                                                                       * :
+                                                                       * &#xc0;
+                                                                       * Latin
+                                                                       * capital
+                                                                       * letter
+                                                                       * A with
+                                                                       * grave
+                                                                       */,
+                193/*
+                    * &Aacute; : &#xc1; Latin capital letter A with acute
+                    */, 194/*
+                            * &Acirc; : &#xc2; Latin capital letter A with
+                            * circumflex
+                            */, 195/*
+                                    * &Atilde; : &#xc3; Latin capital letter A
+                                    * with tilde
+                                    */, 196/*
+                                            * &Auml; : &#xc4; Latin capital
+                                            * letter A with diaeresis
+                                            */, 197/*
+                                                    * &Aring; : &#xc5; Latin
+                                                    * capital letter A with ring
+                                                    * above
+                                                    */, 198/*
+                                                            * &AElig; : &#xc6;
+                                                            * Latin capital
+                                                            * letter AE
+                                                            */, 199/*
+                                                                    * &Ccedil; :
+                                                                    * &#xc7;
+                                                                    * Latin
+                                                                    * capital
+                                                                    * letter C
+                                                                    * with
+                                                                    * cedilla
+                                                                    */, 200/*
+                                                                            * &
+                                                                            * Egrave
+                                                                            * ;
+                                                                            * :
+                                                                            * &
+                                                                            * #xc8
+                                                                            * ;
+                                                                            * Latin
+                                                                            * capital
+                                                                            * letter
+                                                                            * E
+                                                                            * with
+                                                                            * grave
+                                                                            */,
+                201/*
+                    * &Eacute; : &#xc9; Latin capital letter E with acute
+                    */, 202/*
+                            * &Ecirc; : &#xca; Latin capital letter E with
+                            * circumflex
+                            */, 203/*
+                                    * &Euml; : &#xcb; Latin capital letter E
+                                    * with diaeresis
+                                    */, 204/*
+                                            * &Igrave; : &#xcc; Latin capital
+                                            * letter I with grave
+                                            */, 205/*
+                                                    * &Iacute; : &#xcd; Latin
+                                                    * capital letter I with
+                                                    * acute
+                                                    */, 206/*
+                                                            * &Icirc; : &#xce;
+                                                            * Latin capital
+                                                            * letter I with
+                                                            * circumflex
+                                                            */, 207/*
+                                                                    * &Iuml; :
+                                                                    * &#xcf;
+                                                                    * Latin
+                                                                    * capital
+                                                                    * letter I
+                                                                    * with
+                                                                    * diaeresis
+                                                                    */, 208/*
+                                                                            * &ETH
+                                                                            * ;
+                                                                            * :
+                                                                            * &
+                                                                            * #xd0
+                                                                            * ;
+                                                                            * Latin
+                                                                            * capital
+                                                                            * letter
+                                                                            * eth
+                                                                            */,
+                209/*
+                    * &Ntilde; : &#xd1; Latin capital letter N with tilde
+                    */, 210/*
+                            * &Ograve; : &#xd2; Latin capital letter O with
+                            * grave
+                            */, 211/*
+                                    * &Oacute; : &#xd3; Latin capital letter O
+                                    * with acute
+                                    */, 212/*
+                                            * &Ocirc; : &#xd4; Latin capital
+                                            * letter O with circumflex
+                                            */, 213/*
+                                                    * &Otilde; : &#xd5; Latin
+                                                    * capital letter O with
+                                                    * tilde
+                                                    */, 214/*
+                                                            * &Ouml; : &#xd6;
+                                                            * Latin capital
+                                                            * letter O with
+                                                            * diaeresis
+                                                            */, 215/*
+                                                                    * &times; :
+                                                                    * &#xd7;
+                                                                    * multiplication
+                                                                    * sign
+                                                                    */, 216/*
+                                                                            * &
+                                                                            * Oslash
+                                                                            * ;
+                                                                            * :
+                                                                            * &
+                                                                            * #xd8
+                                                                            * ;
+                                                                            * Latin
+                                                                            * capital
+                                                                            * letter
+                                                                            * O
+                                                                            * with
+                                                                            * stroke
+                                                                            */,
+                217/*
+                    * &Ugrave; : &#xd9; Latin capital letter U with grave
+                    */, 218/*
+                            * &Uacute; : &#xda; Latin capital letter U with
+                            * acute
+                            */, 219/*
+                                    * &Ucirc; : &#xdb; Latin capital letter U
+                                    * with circumflex
+                                    */, 220/*
+                                            * &Uuml; : &#xdc; Latin capital
+                                            * letter U with diaeresis
+                                            */, 221/*
+                                                    * &Yacute; : &#xdd; Latin
+                                                    * capital letter Y with
+                                                    * acute
+                                                    */, 222/*
+                                                            * &THORN; : &#xde;
+                                                            * Latin capital
+                                                            * letter Thorn
+                                                            */, 223/*
+                                                                    * &szlig; :
+                                                                    * &#xdf;
+                                                                    * Latin
+                                                                    * small
+                                                                    * letter
+                                                                    * sharp s
+                                                                    */, 224/*
+                                                                            * &
+                                                                            * agrave
+                                                                            * ;
+                                                                            * :
+                                                                            * &
+                                                                            * #xe0
+                                                                            * ;
+                                                                            * Latin
+                                                                            * small
+                                                                            * letter
+                                                                            * a
+                                                                            * with
+                                                                            * grave
+                                                                            */,
+                225/* &aacute; : &#xe1; Latin small letter a with acute */,
+                226/*
+                    * &acirc; : &#xe2; Latin small letter a with circumflex
+                    */,
+                227/* &atilde; : &#xe3; Latin small letter a with tilde */,
+                228/*
+                    * &auml; : &#xe4; Latin small letter a with diaeresis
+                    */, 229/*
+                            * &aring; : &#xe5; Latin small letter a with ring
+                            * above
+                            */, 230/*
+                                    * &aelig; : &#xe6; Latin lowercase ligature
+                                    * ae
+                                    */, 231/*
+                                            * &ccedil; : &#xe7; Latin small
+                                            * letter c with cedilla
+                                            */, 232/*
+                                                    * &egrave; : &#xe8; Latin
+                                                    * small letter e with grave
+                                                    */, 233/*
+                                                            * &eacute; : &#xe9;
+                                                            * Latin small letter
+                                                            * e with acute
+                                                            */, 234/*
+                                                                    * &ecirc; :
+                                                                    * &#xea;
+                                                                    * Latin
+                                                                    * small
+                                                                    * letter e
+                                                                    * with
+                                                                    * circumflex
+                                                                    */, 235/*
+                                                                            * &euml
+                                                                            * ;
+                                                                            * :
+                                                                            * &
+                                                                            * #xeb
+                                                                            * ;
+                                                                            * Latin
+                                                                            * small
+                                                                            * letter
+                                                                            * e
+                                                                            * with
+                                                                            * diaeresis
+                                                                            */,
+                236/* &igrave; : &#xec; Latin small letter i with grave */,
+                237/* &iacute; : &#xed; Latin small letter i with acute */,
+                238/*
+                    * &icirc; : &#xee; Latin small letter i with circumflex
+                    */, 239/*
+                            * &iuml; : &#xef; Latin small letter i with
+                            * diaeresis
+                            */, 240/* &eth; : &#xf0; Latin small letter eth */,
+                241/* &ntilde; : &#xf1; Latin small letter n with tilde */,
+                242/* &ograve; : &#xf2; Latin small letter o with grave */,
+                243/* &oacute; : &#xf3; Latin small letter o with acute */,
+                244/*
+                    * &ocirc; : &#xf4; Latin small letter o with circumflex
+                    */, 245/*
+                            * &otilde; : &#xf5; Latin small letter o with tilde
+                            */, 246/*
+                                    * &ouml; : &#xf6; Latin small letter o with
+                                    * diaeresis
+                                    */, 247/*
+                                            * &divide; : &#xf7; division sign
+                                            */, 248/*
+                                                    * &oslash; : &#xf8; Latin
+                                                    * small letter o with stroke
+                                                    */, 249/*
+                                                            * &ugrave; : &#xf9;
+                                                            * Latin small letter
+                                                            * u with grave
+                                                            */, 250/*
+                                                                    * &uacute ;
+                                                                    * : & #xfa ;
+                                                                    * Latin
+                                                                    * small
+                                                                    * letter u
+                                                                    * with acute
+                                                                    */, 251/*
+                                                                            * &ucirc
+                                                                            * ;
+                                                                            * :
+                                                                            * &
+                                                                            * #xfb
+                                                                            * ;
+                                                                            * Latin
+                                                                            * small
+                                                                            * letter
+                                                                            * u
+                                                                            * with
+                                                                            * circumflex
+                                                                            */,
+                252/*
+                    * &uuml; : &#xfc; Latin small letter u with diaeresis
+                    */, 253/*
+                            * &yacute; : &#xfd; Latin small letter y with acute
+                            */, 254/*
+                                    * &thorn; : &#xfe; Latin small letter thorn
+                                    */, 255/*
+                                            * &yuml; : &#xff; Latin small letter
+                                            * y with diaeresis
+                                            */, 338/*
+                                                    * &OElig; : &#x152; Latin
+                                                    * capital ligature oe
+                                                    */, 339/*
+                                                            * &oelig ; : & #x153
+                                                            * ; Latin small
+                                                            * ligature oe
+                                                            */, 352/*
+                                                                    * &Scaron; :
+                                                                    * &#x160;
+                                                                    * Latin
+                                                                    * capital
+                                                                    * letter S
+                                                                    * with caron
+                                                                    */, 353/*
+                                                                            * &
+                                                                            * scaron
+                                                                            * ;
+                                                                            * :
+                                                                            * &
+                                                                            * #x161
+                                                                            * ;
+                                                                            * Latin
+                                                                            * small
+                                                                            * letter
+                                                                            * s
+                                                                            * with
+                                                                            * caron
+                                                                            */,
+                376/*
+                    * &Yuml; : &#x178; Latin capital letter Y with diaeresis
+                    */, 402/*
+                            * &fnof; : &#x192; Latin small letter f with hook
+                            */, 710/*
+                                    * &circ; : &#x2c6; modifier letter
+                                    * circumflex accent
+                                    */, 732/*
+                                            * &tilde; : &#x2dc; small tilde
+                                            */, 913/*
+                                                    * &Alpha ; : & #x391 ; Greek
+                                                    * capital letter Alpha
+                                                    */, 914/*
+                                                            * &Beta; : &#x392;
+                                                            * Greek capital
+                                                            * letter Beta
+                                                            */, 915/*
+                                                                    * &Gamma; :
+                                                                    * &#x393;
+                                                                    * Greek
+                                                                    * capital
+                                                                    * letter
+                                                                    * Gamma
+                                                                    */, 916/*
+                                                                            * &Delta
+                                                                            * ;
+                                                                            * :
+                                                                            * &
+                                                                            * #x394
+                                                                            * ;
+                                                                            * Greek
+                                                                            * capital
+                                                                            * letter
+                                                                            * Delta
+                                                                            */,
+                917/*
+                    * &Epsilon; : &#x395; Greek capital letter Epsilon
+                    */, 918/*
+                            * &Zeta; : &#x396; Greek capital letter Zeta
+                            */, 919/*
+                                    * &Eta; : &#x397 ; Greek capital letter Eta
+                                    */, 920/*
+                                            * &Theta ; : & #x398 ; Greek capital
+                                            * letter Theta
+                                            */, 921/*
+                                                    * &Iota; : &#x399; Greek
+                                                    * capital letter Iota
+                                                    */, 922/*
+                                                            * &Kappa ; : &#
+                                                            * x39a; Greek
+                                                            * capital letter
+                                                            * Kappa
+                                                            */, 923/*
+                                                                    * &Lambda; :
+                                                                    * &#x39b;
+                                                                    * Greek
+                                                                    * capital
+                                                                    * letter
+                                                                    * Lambda
+                                                                    */, 924/*
+                                                                            * &Mu
+                                                                            * ;
+                                                                            * :
+                                                                            * &
+                                                                            * #x39c
+                                                                            * ;
+                                                                            * Greek
+                                                                            * capital
+                                                                            * letter
+                                                                            * Mu
+                                                                            */,
+                925/*
+                    * &Nu; : &#x39d; Greek capital letter Nu
+                    */, 926/*
+                            * &Xi; : &#x39e; Greek capital letter Xi
+                            */, 927/*
+                                    * &Omicron; : &#x39f; Greek capital letter
+                                    * Omicron
+                                    */, 928/*
+                                            * &Pi ; : & #x3a0 ; Greek capital
+                                            * letter Pi
+                                            */, 929/*
+                                                    * &Rho; : &#x3a1; Greek
+                                                    * capital letter Rho
+                                                    */, 931/*
+                                                            * &Sigma; : &#x3a3;
+                                                            * Greek capital
+                                                            * letter Sigma
+                                                            */, 932/*
+                                                                    * &Tau; :
+                                                                    * &#x3a4;
+                                                                    * Greek
+                                                                    * capital
+                                                                    * letter Tau
+                                                                    */, 933/*
+                                                                            * &
+                                                                            * Upsilon
+                                                                            * ;
+                                                                            * :
+                                                                            * &#
+                                                                            * x3a5
+                                                                            * ;
+                                                                            * Greek
+                                                                            * capital
+                                                                            * letter
+                                                                            * Upsilon
+                                                                            */,
+                934/*
+                    * &Phi; : &#x3a6; Greek capital letter Phi
+                    */, 935/*
+                            * &Chi; : &#x3a7 ; Greek capital letter Chi
+                            */, 936/*
+                                    * &Psi ; : & #x3a8 ; Greek capital letter
+                                    * Psi
+                                    */, 937/*
+                                            * &Omega ; : &# x3a9; Greek capital
+                                            * letter Omega
+                                            */, 945/*
+                                                    * &alpha; : &#x3b1; Greek
+                                                    * small letter alpha
+                                                    */, 946/*
+                                                            * &beta; : &#x3b2 ;
+                                                            * Greek small letter
+                                                            * beta
+                                                            */, 947/*
+                                                                    * &gamma; :
+                                                                    * &#x3b3;
+                                                                    * Greek
+                                                                    * small
+                                                                    * letter
+                                                                    * gamma
+                                                                    */, 948/*
+                                                                            * &delta
+                                                                            * ;
+                                                                            * :
+                                                                            * &#
+                                                                            * x3b4
+                                                                            * ;
+                                                                            * Greek
+                                                                            * small
+                                                                            * letter
+                                                                            * delta
+                                                                            */,
+                949/*
+                    * &epsilon; : &#x3b5; Greek small letter epsilon
+                    */, 950/*
+                            * &zeta; : &#x3b6; Greek small letter zeta
+                            */, 951/*
+                                    * &eta; : &#x3b7 ; Greek small letter eta
+                                    */, 952/*
+                                            * &theta; : &#x3b8; Greek small
+                                            * letter theta
+                                            */, 953/*
+                                                    * &iota; : &#x3b9 ; Greek
+                                                    * small letter iota
+                                                    */, 954/*
+                                                            * &kappa ; : & #x3ba
+                                                            * ; Greek small
+                                                            * letter kappa
+                                                            */, 955/*
+                                                                    * &lambda ;
+                                                                    * : &# x3bb;
+                                                                    * Greek
+                                                                    * small
+                                                                    * letter
+                                                                    * lambda
+                                                                    */, 956/*
+                                                                            * &mu
+                                                                            * ;
+                                                                            * :
+                                                                            * &
+                                                                            * #x3bc
+                                                                            * ;
+                                                                            * Greek
+                                                                            * small
+                                                                            * letter
+                                                                            * mu
+                                                                            */,
+                957/*
+                    * &nu; : &#x3bd; Greek small letter nu
+                    */, 958/* &xi; : &#x3be; Greek small letter xi */, 959/*
+                                                                           * &
+                                                                           * omicron
+                                                                           * ; :
+                                                                           * &
+                                                                           * #x3bf
+                                                                           * ;
+                                                                           * Greek
+                                                                           * small
+                                                                           * letter
+                                                                           * omicron
+                                                                           */,
+                960/* &pi; : &#x3c0; Greek small letter pi */, 961/*
+                                                                   * &rho; :
+                                                                   * &#x3c1;
+                                                                   * Greek small
+                                                                   * letter rho
+                                                                   */, 962/*
+                                                                           * &sigmaf
+                                                                           * ; :
+                                                                           * &
+                                                                           * #x3c2
+                                                                           * ;
+                                                                           * Greek
+                                                                           * small
+                                                                           * letter
+                                                                           * final
+                                                                           * sigma
+                                                                           */,
+                963/*
+                    * &sigma; : &#x3c3; Greek small letter sigma
+                    */, 964/*
+                            * &tau; : &#x3c4 ; Greek small letter tau
+                            */, 965/*
+                                    * &upsilon; : &#x3c5; Greek small letter
+                                    * upsilon
+                                    */, 966/*
+                                            * &phi; : &#x3c6; Greek small letter
+                                            * phi
+                                            */, 967/*
+                                                    * &chi ; : & #x3c7 ; Greek
+                                                    * small letter chi
+                                                    */, 968/*
+                                                            * &psi; : &#x3c8;
+                                                            * Greek small letter
+                                                            * psi
+                                                            */, 969/*
+                                                                    * &omega; :
+                                                                    * &#x3c9;
+                                                                    * Greek
+                                                                    * small
+                                                                    * letter
+                                                                    * omega
+                                                                    */, 977/*
+                                                                            * &
+                                                                            * thetasym
+                                                                            * ;
+                                                                            * :
+                                                                            * &
+                                                                            * #x3d1
+                                                                            * ;
+                                                                            * Greek
+                                                                            * theta
+                                                                            * symbol
+                                                                            */,
+                978/*
+                    * &upsih; : &#x3d2; Greek upsilon with hook symbol
+                    */, 982/* &piv; : &#x3d6; Greek pi symbol */, 8194/*
+                                                                       * &ensp;
+                                                                       * :
+                                                                       * &#x2002
+                                                                       * ; en
+                                                                       * space
+                                                                       */,
+                8195/*
+                     * &emsp; : &#x2003 ; em space
+                     */, 8201/* &thinsp; : &#x2009; thin space */, 8204/*
+                                                                        * &zwnj;
+                                                                        * :
+                                                                        * &#x200c
+                                                                        * ; zero
+                                                                        * width
+                                                                        * non
+                                                                        * -joiner
+                                                                        */,
+                8205/*
+                     * &zwj; : &#x200d; zero width joiner
+                     */, 8206/* &lrm; : &#x200e; left-to-right mark */,
+                8207/*
+                     * &rlm; : &#x200f; right -to-left mark
+                     */, 8211/* &ndash; : &#x2013; en dash */, 8212/*
+                                                                    * &mdash ; :
+                                                                    * & #x2014 ;
+                                                                    * em dash
+                                                                    */,
+                8216/*
+                     * &lsquo; : &#x2018; left single-6 quotation mark
+                     */, 8217/*
+                              * &rsquo ; : &# x2019 ; right single -9 quotation
+                              * mark
+                              */, 8218/*
+                                       * &sbquo; : &#x201a; single low-9
+                                       * quotation mark
+                                       */, 8220/*
+                                                * &ldquo; : &#x201c; left
+                                                * double-66 quotation mark
+                                                */, 8221/*
+                                                         * &rdquo; : &#x201d;
+                                                         * right double-99
+                                                         * quotation mark
+                                                         */, 8222/*
+                                                                  * &bdquo ; : &
+                                                                  * #x201e ;
+                                                                  * double low
+                                                                  * -99
+                                                                  * quotation
+                                                                  * mark
+                                                                  */, 8224/*
+                                                                           * &dagger
+                                                                           * ; :
+                                                                           * &
+                                                                           * #x2020
+                                                                           * ;
+                                                                           * dagger
+                                                                           */,
+                8225/*
+                     * &Dagger; : &#x2021; double dagger
+                     */, 8226/*
+                              * &bull ; : & #x2022 ; bullet
+                              */, 8230/*
+                                       * &hellip ; : &# x2026 ; horizontal
+                                       * ellipsis
+                                       */, 8240/*
+                                                * &permil; : &#x2030; per mille
+                                                * sign
+                                                */, 8242/*
+                                                         * &prime; : &#x2032;
+                                                         * prime
+                                                         */, 8243/*
+                                                                  * &Prime ; :
+                                                                  * &# x2033 ;
+                                                                  * double prime
+                                                                  */, 8249/*
+                                                                           * &lsaquo
+                                                                           * ; :
+                                                                           * &
+                                                                           * #x2039
+                                                                           * ;
+                                                                           * single
+                                                                           * left
+                                                                           * -
+                                                                           * pointing
+                                                                           * angle
+                                                                           * quotation
+                                                                           * mark
+                                                                           */,
+                8250/*
+                     * &rsaquo; : &#x203a; single right-pointing angle quotation
+                     * mark
+                     */, 8254/*
+                              * &oline; : &#x203e; overline
+                              */, 8260/*
+                                       * &frasl ; : & #x2044 ; fraction slash
+                                       */, 8364/*
+                                                * &euro; : &#x20ac; Euro
+                                                * currency sign
+                                                */, 8465/*
+                                                         * &image ; : &# x2111 ;
+                                                         * black - letter
+                                                         * capital i
+                                                         */, 8472/*
+                                                                  * &weierp; :
+                                                                  * &#x2118;
+                                                                  * script
+                                                                  * capital p
+                                                                  */, 8476/*
+                                                                           * &real
+                                                                           * ; :
+                                                                           * &
+                                                                           * #x211c
+                                                                           * ;
+                                                                           * black
+                                                                           * -
+                                                                           * letter
+                                                                           * capital
+                                                                           * r
+                                                                           */,
+                8482/*
+                     * &trade; : &#x2122; trademark sign
+                     */, 8501/*
+                              * &alefsym ; : & #x2135 ; alef symbol
+                              */, 8592/*
+                                       * &larr; : &#x2190 ; leftwards arrow
+                                       */, 8593/*
+                                                * &uarr; : &#x2191; upwards
+                                                * arrow
+                                                */, 8594/*
+                                                         * &rarr; : &#x2192;
+                                                         * rightwards arrow
+                                                         */, 8595/*
+                                                                  * &darr; :
+                                                                  * &#x2193 ;
+                                                                  * downwards
+                                                                  * arrow
+                                                                  */, 8596/*
+                                                                           * &harr
+                                                                           * ; :
+                                                                           * &
+                                                                           * #x2194
+                                                                           * ;
+                                                                           * left
+                                                                           * right
+                                                                           * arrow
+                                                                           */,
+                8629/*
+                     * &crarr; : &#x21b5; downwards arrow with corner leftwards
+                     */, 8656/*
+                              * &lArr; : &#x21d0 ; leftwards double arrow
+                              */, 8657/*
+                                       * &uArr ; : & #x21d1 ; upwards double
+                                       * arrow
+                                       */, 8658/*
+                                                * &rArr; : &#x21d2; rightwards
+                                                * double arrow
+                                                */, 8659/*
+                                                         * &dArr; : &#x21d3;
+                                                         * downwards double
+                                                         * arrow
+                                                         */, 8660/*
+                                                                  * &hArr; :
+                                                                  * &#x21d4 ;
+                                                                  * left right
+                                                                  * double arrow
+                                                                  */, 8704/*
+                                                                           * &forall
+                                                                           * ; :
+                                                                           * &
+                                                                           * #x2200
+                                                                           * ;
+                                                                           * for
+                                                                           * all
+                                                                           */,
+                8706/*
+                     * &part; : &#x2202; partial differential
+                     */, 8707/*
+                              * &exist; : &#x2203; there exists
+                              */, 8709/* &empty; : &#x2205; empty set */,
+                8711/*
+                     * &nabla; : &#x2207; nabla
+                     */, 8712/*
+                              * &isin; : &#x2208; element of
+                              */,
+                8713/* &notin; : &#x2209; not an element of */, 8715/*
+                                                                     * &ni; :
+                                                                     * &#x220b;
+                                                                     * contains
+                                                                     * as member
+                                                                     */,
+                8719/* &prod; : &#x220f; n-ary product */, 8721/*
+                                                                * &sum; :
+                                                                * &#x2211; n-ary
+                                                                * summation
+                                                                */, 8722/*
+                                                                         * &minus
+                                                                         * ; :
+                                                                         * &#
+                                                                         * x2212
+                                                                         * ;
+                                                                         * minus
+                                                                         * sign
+                                                                         */,
+                8727/*
+                     * &lowast; : &#x2217; asterisk operator
+                     */, 8730/*
+                              * &radic; : &#x221a; square root
+                              */, 8733/*
+                                       * &prop; : &#x221d; proportional to
+                                       */, 8734/*
+                                                * &infin ; : & #x221e ; infinity
+                                                */, 8736/*
+                                                         * &ang; : &#x2220 ;
+                                                         * angle
+                                                         */, 8743/*
+                                                                  * &and; :
+                                                                  * &#x2227;
+                                                                  * logical and
+                                                                  */, 8744/*
+                                                                           * &or;
+                                                                           * :
+                                                                           * &#
+                                                                           * x2228
+                                                                           * ;
+                                                                           * logical
+                                                                           * or
+                                                                           */,
+                8745/*
+                     * &cap; : &#x2229; intersection
+                     */, 8746/* &cup; : &#x222a; union */, 8747/*
+                                                                * &int; :
+                                                                * &#x222b;
+                                                                * integral
+                                                                */, 8756/*
+                                                                         * &there4
+                                                                         * ; :
+                                                                         * &#
+                                                                         * x2234
+                                                                         * ;
+                                                                         * therefore
+                                                                         */,
+                8764/*
+                     * &sim ; : & #x223c ; tilde operator
+                     */, 8773/*
+                              * &cong; : &#x2245 ; congruent to
+                              */, 8776/* &asymp; : &#x2248; asymptotic to */,
+                8800/*
+                     * &ne; : &#x2260; not equal to
+                     */, 8801/*
+                              * &equiv ; : &# x2261 ; identical to
+                              */, 8804/*
+                                       * &le; : &#x2264; less-than or equal to
+                                       */, 8805/*
+                                                * &ge; : &#x2265; greater -than
+                                                * or equal to
+                                                */, 8834/*
+                                                         * &sub; : &#x2282;
+                                                         * subset of
+                                                         */, 8835/*
+                                                                  * &sup; :
+                                                                  * &#x2283 ;
+                                                                  * superset of
+                                                                  */, 8836/*
+                                                                           * &nsub
+                                                                           * ; :
+                                                                           * &
+                                                                           * #x2284
+                                                                           * ;
+                                                                           * not
+                                                                           * a
+                                                                           * subset
+                                                                           * of
+                                                                           */,
+                8838/*
+                     * &sube; : &#x2286 ; subset of or equal to
+                     */, 8839/*
+                              * &supe; : &#x2287; superset of or equal to
+                              */, 8853/*
+                                       * &oplus ; : &# x2295 ; circled plus
+                                       */, 8855/*
+                                                * &otimes; : &#x2297; circled
+                                                * times
+                                                */, 8869/*
+                                                         * &perp ; : & #x22a5 ;
+                                                         * up tack
+                                                         */, 8901/*
+                                                                  * &sdot; :
+                                                                  * &#x22c5 ;
+                                                                  * dot operator
+                                                                  */, 8968/*
+                                                                           * &lceil
+                                                                           * ; :
+                                                                           * &
+                                                                           * #x2308
+                                                                           * ;
+                                                                           * left
+                                                                           * ceiling
+                                                                           */,
+                8969/*
+                     * &rceil; : &#x2309; right ceiling
+                     */, 8970/*
+                              * &lfloor ; : &# x230a ; left floor
+                              */, 8971/* &rfloor; : &#x230b; right floor */,
+                9001/*
+                     * &lang; : &#x2329 ; left- pointing angle bracket
+                     */, 9002/*
+                              * &rang; : &#x232a ; right - pointing angle
+                              * bracket
+                              */, 9674/* &loz; : &#x25ca; lozenge */, 9824/*
+                                                                           * &spades
+                                                                           * ; :
+                                                                           * &
+                                                                           * #x2660
+                                                                           * ;
+                                                                           * black
+                                                                           * spade
+                                                                           * suit
+                                                                           */,
+                9827/*
+                     * &clubs; : &#x2663; black club suit
+                     */, 9829/*
+                              * &hearts ; : &# x2665 ; black heart suit
+                              */, 9830/*
+                                       * &diams; : &#x2666; black diamond suit
+                                       */, };
+        // allow 50% extra space for faster lookup.
+        entityToChar = new HashMap<String, Character>(
+                entityKeys.length * 150 / 100);
+        for (int i = 0; i < entityKeys.length; i++) {
+            // leave out nbsp so it can be specially handled if entity not
+            // found.
+            if (!entityKeys[i].equals("nbsp")) {
+                entityToChar.put(entityKeys[i], entityValues[i]);
+            }
+            // add also &apos; for strip but not insert. optional for XML, not
+            // used in HTML.
+            entityToChar.put("apos", (char) 39);
+        }
+    }// end static
+
+    /**
+     * convert an entity to a single char.
+     * 
+     * @param bareEntity
+     *            String entity to convert convert. must have lead & and trail ;
+     *            stripped; may have form: #x12ff or #123 or lt or nbsp style
+     *            entity. Works faster if entity in lower case.
+     * @param howToTranslateNbsp
+     *            char you would like &nbsp translated to, usually ' ' or (char)
+     *            160
+     * 
+     * @return equivalent character. 0 if not recognised.
+     */
+    public static char bareHTMLEntityToChar(String bareEntity,
+            char howToTranslateNbsp) {
+        // first check for alpha entity
+        Character code = entityToChar.get(bareEntity);
+        if (code != null) {
+            return code;
+        }
+        code = entityToChar.get(bareEntity.toLowerCase());
+        if (code != null) {
+            return code;
+        }
+        // nbsp is not in hashMap. We test for it specially.
+        if (bareEntity.length() == 4 && bareEntity.equals("nbsp")
+                || bareEntity.equals("NBSP")) {
+            return howToTranslateNbsp;
+        }
+        // check at least have &_#1_; (no & or ; at this point )
+        if (bareEntity.length() < 2) {
+            return 0;
+        }
+        try {
+            if (bareEntity.charAt(0) == '#') {
+                final char secondChar = bareEntity.charAt(1);
+                if (secondChar == 'x' || secondChar == 'X') {
+                    // handle hex entities of form &_#x12ff_;
+                    // ensure at least have &_#xf_;
+                    if (bareEntity.length() < 3) {
+                        return 0;
+                    }
+                    // had &_#x123D_;
+                    return (char) Integer.parseInt(bareEntity.substring(2),
+                    /* hex */
+                    16);
+                } else {
+                    // handle decimal entities
+                    // had &_#123_;
+                    return (char) Integer.parseInt(bareEntity.substring(1));
+                }
+            } else {
+                // some unrecognized/malformed bareEntity
+                return 0;
+            }
+        } catch (NumberFormatException e) {
+            return 0;
+        }
+    }// end entityToChar
+
+    /**
+     * strips tags and entities from HTML. Leaves \n \r unchanged.
+     * 
+     * @param text
+     *            to flatten
+     * @param translateNbspTo
+     *            char you would like &nbsp; translated to, usually ' ' or
+     *            (char) 160 .
+     * 
+     * @return flattened text
+     */
+    public static String flattenHTML(String text, char translateNbspTo) {
+        return stripHTMLEntities(stripHTMLTags(text), translateNbspTo);
+    }
+
+    /**
+     * strips tags and entities from XML..
+     * 
+     * @param text
+     *            to flatten
+     * 
+     * @return flattened text
+     */
+    public static String flattenXML(String text) {
+        return stripXMLEntities(stripXMLTags(text));
+    }
+
+    /**
+     * Checks a number of gauntlet conditions to ensure this is a valid entity.
+     * Converts Entity to corresponding char.
+     * 
+     * @param possBareEntityWithSemicolon
+     *            string that may hold an entity. Lead & must be stripped, but
+     *            may optionally contain text past the ;
+     * @param translateNbspTo
+     *            char you would like nbsp translated to, usually ' ' or (char)
+     *            160 .
+     * 
+     * @return corresponding unicode character, or 0 if the entity is invalid.
+     */
+    protected static char possBareHTMLEntityWithSemicolonToChar(
+            String possBareEntityWithSemicolon, char translateNbspTo) {
+        if (possBareEntityWithSemicolon.length() < SHORTEST_ENTITY - 1) {
+            return 0;
+        }
+
+        // find the trailing ;
+        int whereSemi = possBareEntityWithSemicolon.indexOf(';',
+                SHORTEST_ENTITY - 2/* where start looking */);
+        if (whereSemi < SHORTEST_ENTITY - 2) {
+            return 0;
+        }
+
+        return bareHTMLEntityToChar(
+                possBareEntityWithSemicolon.substring(0, whereSemi),
+                translateNbspTo);
+    }
+
+    /**
+     * Checks a number of gauntlet conditions to ensure this is a valid entity.
+     * Converts Entity to corresponding char.
+     * 
+     * @param possBareEntityWithSemicolon
+     *            string that may hold an entity. Lead & must be stripped, but
+     *            may optionally contain text past the ;
+     * 
+     * @return corresponding unicode character, or 0 if the entity is invalid.
+     *         nbsp -> (char) 160
+     */
+    public static char possEntityToChar(String possBareEntityWithSemicolon) {
+        return possBareHTMLEntityWithSemicolonToChar(
+                possBareEntityWithSemicolon, UNICODE_NBSP_160_0x0a);
+    }
+
+    /**
+     * Prepares tags for removal, to ensure they are replaced by a space
+     * <tr>
+     * <td>
+     * <th><br>
+     * <p>
+     * </tr>
+     * </td></th></br></p> --> _
+     * <tr
+     * _
+     * </tr
+     * etc.
+     * 
+     * @param html
+     *            input HTML or XML
+     * 
+     * @return raw text, with spacing tags fluffed up with a space so they will
+     *         later be removed with a space.
+     */
+    private static String preStripIndividualTags(String html) {
+        StringBuilder sb = new StringBuilder(html.length() * 110 / 100);
+        char prevChar = 0;
+        for (int i = 0; i < html.length(); i++) {
+            final char c = html.charAt(i);
+            if (c == '<') {
+                // startsWith index need not be inside the String.
+                int look = (html.startsWith("/", i + 1)) ? i + 2 : i + 1;
+
+                // handle <tr </tr etc.
+                for (String tag : spacingTags) {
+                    if (html.startsWith(tag, look)) {
+                        // no need to add space if one there already.
+                        if (prevChar > ' ') {
+                            // insert space before <
+                            sb.append(' ');
+                        }
+                        break;
+                    }
+                }
+            }
+            sb.append(c);
+            prevChar = c;
+        }
+        return sb.toString();
+    }
+
+    /**
+     * Converts HTML to text converting entities such as &quot; back to " and
+     * &lt; back to &lt; Ordinary text passes unchanged. Also strips decimal and
+     * hex entities and stray HTML entities.
+     * 
+     * @param text
+     *            raw text to be processed. Must not be null.
+     * @param translateNbspTo
+     *            char you would like &nbsp; translated to, usually ' ' or
+     *            (char) 160 .
+     * 
+     * @return translated text. It also handles HTML 4.0 entities such as
+     *         &hearts; &#123; and &#xffff; &nbsp; -> 160. null input returns
+     *         null.
+     */
+    public static String stripHTMLEntities(String text, char translateNbspTo) {
+        if (text == null) {
+            return null;
+        }
+        if (text.indexOf('&') < 0) {
+            // are no entities, nothing to do
+            return text;
+        }
+        int originalTextLength = text.length();
+        StringBuilder sb = new StringBuilder(originalTextLength);
+        for (int i = 0; i < originalTextLength; i++) {
+            int whereAmp = text.indexOf('&', i);
+            if (whereAmp < 0) {
+                // no more &s, we are done
+                // append all remaining text
+                sb.append(text.substring(i));
+                break;
+            } else {
+                // append all text to left of next &
+                sb.append(text.substring(i, whereAmp));
+                // avoid reprocessing those chars
+                i = whereAmp;
+                // text.charAt(i) is an &
+                // possEntity has lead & stripped.
+                String possEntity = text.substring(i + 1,
+                        Math.min(i + LONGEST_ENTITY, text.length()));
+                char t = possBareHTMLEntityWithSemicolonToChar(possEntity,
+                        translateNbspTo);
+                if (t != 0) {
+                    // was a good entity, keep its equivalent char.
+                    sb.append(t);
+                    // avoid reprocessing chars forming the entity
+                    int whereSemi = possEntity
+                            .indexOf(";", SHORTEST_ENTITY - 2);
+                    i += whereSemi + 1;
+                } else {
+                    // treat & just as ordinary character
+                    sb.append('&');
+                }
+            }// end else
+        }// end for
+         // if result is not shorter, we did not do anything. Saves RAM.
+        return (sb.length() == originalTextLength) ? text : sb.toString();
+    }// end stripEntities
+
+    // -------------------------- STATIC METHODS --------------------------
+
+    /**
+     * remove all text between &lt;applet.. &lt;/applet&gt;, &lt;style...
+     * &lt;/style&gt; &lt;script... &lt;/script&gt;
+     * 
+     * @param s
+     *            HTML string to strip tag pairs out of.
+     * 
+     * @return string with tag pairs stripped out.
+     */
+    private static String stripHTMLTagPairs(String s) {
+        String[] tags = { "applet", "APPLET", "style", "STYLE", "script",
+                "SCRIPT" };
+        for (final String tag : tags) {
+            final String beginTag = "<" + tag;
+            final String endTag = "</" + tag + ">";
+            int begin = 0;
+            while (begin < s.length()
+                    && (begin = s.indexOf(beginTag, begin)) >= 0) {
+                final int end;
+                if ((end = s.indexOf(endTag, begin + beginTag.length())) > 0) {
+                    // chop out the <applet ... </applet>
+
+                    s = s.substring(0, begin)
+                            + s.substring(end + endTag.length());
+                } else {
+                    // no matching end tag, chop off entire end
+                    s = s.substring(0, begin);
+                }
+            }
+        }
+        return s;
+    }
+
+    /**
+     * Removes tags from HTML leaving just the raw text. Leaves entities as is,
+     * e.g. does not convert &amp; back to &. similar to code in Quoter. Also
+     * removes &lt;!-- --&gt; comments. Presumes perfectly formed HTML, no &gt;
+     * in comments, all &lt;...&gt; balanced. Also removes text between applet,
+     * style and script tag pairs. Leaves &nbsp; and other entities as is.
+     * 
+     * @param html
+     *            input HTML
+     * 
+     * @return raw text, with whitespaces collapsed to a single space, trimmed.
+     */
+    public static String stripHTMLTags(String html) {
+        html = stripHTMLTagPairs(html);
+        return stripIndividualTags(html);
+    }
+
+    /**
+     * Removes tags from HTML leaving just the raw text. Leaves entities as is,
+     * e.g. Presumes perfectly formed HTML. <b> </b> <i> </i>
+     * <tr xxx>
+     * etc removed leaving nothing behind.
+     * 
+     * @param html
+     *            input HTML or XML
+     * 
+     * @return raw text, with whitespaces collapsed to a single space, trimmed.
+     */
+    private static String stripIndividualTags(String html) {
+        html = html.trim();
+        if (html.indexOf('<') < 0) {
+            return html;
+        }
+        // condition String so that some tags will always turn into space.
+        html = preStripIndividualTags(html);
+        int numChars = html.length();
+        // will only shrink.
+        StringBuilder result = new StringBuilder(numChars);
+
+        /**
+         * are we inside a tag, eg. inside <td xxxx>
+         */
+        boolean inside = false;
+
+        /**
+         * Have we cleaned any White Space?
+         */
+        boolean cleanedAnyWhitespace = false;
+
+        /**
+         * Was the last char we saw a space? We use this to collapse spaces.
+         */
+        boolean lastCharSpace = false;
+        for (int i = 0; i < numChars; i++) {
+            char c = html.charAt(i);
+            switch (c) {
+                default:
+                    if (c < ' ') {
+                        // handle stray whitespace
+                        if (!inside) {
+                            lastCharSpace = true;
+                            cleanedAnyWhitespace = true;
+                        }
+                    } else {
+                        // ordinary character, ignored inside a tag
+                        if (!inside) {
+                            if (lastCharSpace) {
+                                // deal with pending whitespace
+                                result.append(' ');
+                                lastCharSpace = false;
+                            }
+                            result.append(c);
+                        }
+                    }
+                    break;
+
+                case '<':
+                    inside = true;
+                    // ignore
+                    break;
+
+                case '>':
+                    inside = false;
+                    // ignore
+                    break;
+
+                case ' ':
+                    if (!inside) {
+                        lastCharSpace = true;
+                    }
+                    break;
+
+                // whitespace
+                case '\r':
+                case '\t':
+                case '\n':
+                case 127:
+                case UNICODE_NBSP_160_0x0a:
+
+                    if (!inside) {
+                        lastCharSpace = true;
+                        cleanedAnyWhitespace = true;
+                    }
+                    break;
+            }
+        }// end for
+         // return original string trimmed if we did not really change anything
+        return (cleanedAnyWhitespace || result.length() != numChars) ? result
+                .toString().trim() : html;
+    }
+
+    /**
+     * Converts XML to text converting entities such as &quot; back to " and
+     * &lt; back to &lt; Ordinary text passes unchanged. Also strips decimal and
+     * hex entities and stray HTML entities.
+     * 
+     * @param text
+     *            raw XML text to be processed. Must not be null.
+     * 
+     * @return translated text. null input returns null.
+     */
+    public static String stripXMLEntities(String text) {
+        return stripHTMLEntities(text, ' ');
+    }
+
+    /**
+     * Removes tags from XML leaving just the raw text. Leaves entities as is,
+     * e.g. does not convert &amp; back to &. similar to code in Quoter. Also
+     * removes &lt;!-- --&gt; comments. Presumes perfectly formed XML, no &gt;
+     * in comments, all &lt;...&gt; balanced. Leaves entities as is.
+     * 
+     * @param xml
+     *            input XML
+     * 
+     * @return raw text, with whitespaces collapsed to a single space, trimmed.
+     */
+    public static String stripXMLTags(String xml) {
+        return stripIndividualTags(xml);
+    }
+}