org.htmlparser.util
Class Translate
Translate numeric character references and character entity references to unicode characters.
Based on tables found at
http://www.w3.org/TR/REC-html40/sgml/entities.html
Typical usage:
String s = Translate.decode (getTextFromHtmlPage ());
or
String s = "<HTML>" + Translate.encode (getArbitraryText ()) + "</HTML>";
static void | decode(InputStream in, PrintStream out) - Decode a stream containing references.
|
static String | decode(String string) - Decode a string containing references.
|
static String | decode(StringBuffer buffer) - Decode the characters in a string buffer containing references.
|
static void | encode(InputStream in, PrintStream out) - Encode a stream to use references.
|
static String | encode(String string) - Encode a string to use references.
|
static String | encode(int character) - Convert a character to a numeric character reference.
|
static CharacterReference | lookup(String kernel, int start, int end) - Look up a reference by kernel.
|
static CharacterReference | lookup(char character) - Look up a reference by character.
|
protected static CharacterReference | lookup(CharacterReference key) - Look up a reference by kernel.
|
protected static int | lookup(CharacterReference[] array, char ref, int lo, int hi) - Binary search for a reference.
|
static void | main(String[] args) - Numeric character reference and character entity reference to unicode codec.
|
BREAKPOINT
protected static final int BREAKPOINT
The dividing point between a simple table lookup and a binary search.
Characters below the break point are stored in a sparse array allowing
direct index lookup.
DECODE_LINE_BY_LINE
public static boolean DECODE_LINE_BY_LINE
If this member is set true
, decoding of streams is
done line by line in order to reduce the maximum memory required.
ENCODE_HEXADECIMAL
public static boolean ENCODE_HEXADECIMAL
If this member is set true
, encoding of numeric character
references uses hexadecimal digits, i.e. ○, instead of decimal
digits.
mCharacterList
protected static final CharacterReference[] mCharacterList
List of references sorted by character.
The first part of this array, up to BREAKPOINT
is stored
in a direct translational table, indexing into the table with a character
yields the reference. The second part is dense and sorted by character,
suitable for binary lookup.
mCharacterReferences
protected static final CharacterReference[] mCharacterReferences
Table mapping entity reference kernel to character.
This is sorted by kernel when the class is loaded.
decode
public static void decode(InputStream in,
PrintStream out)
Decode a stream containing references.
Change all numeric character reference and character entity references
to unicode characters. If DECODE_LINE_BY_LINE
is true,
the input stream is broken up into lines, terminated by either
carriage return or newline, in order to reduce the latency and maximum
buffering memory size required.
in
- The stream to translate. It is assumed that the input
stream is encoded with ISO-8859-1 since the table of character
entity references in this class applies only to ISO-8859-1.out
- The stream to write the decoded stream to.
decode
public static String decode(String string)
Decode a string containing references.
Change all numeric character reference and character entity references
to unicode characters.
string
- The string to translate.
decode
public static String decode(StringBuffer buffer)
Decode the characters in a string buffer containing references.
Change all numeric character reference and character entity references
to unicode characters.
buffer
- The StringBuffer containing references.
encode
public static void encode(InputStream in,
PrintStream out)
Encode a stream to use references.
Change all characters that are not ISO-8859-1 to their numeric character
reference or character entity reference.
in
- The stream to translate. It is assumed that the input
stream is encoded with ISO-8859-1 since the table of character
entity references in this class applies only to ISO-8859-1.out
- The stream to write the decoded stream to.
encode
public static String encode(String string)
Encode a string to use references.
Change all characters that are not ISO-8859-1 to their numeric character
reference or character entity reference.
string
- The string to translate.
encode
public static String encode(int character)
Convert a character to a numeric character reference.
Convert a unicode character to a numeric character reference of
the form &#xxxx;.
character
- The character to convert.
lookup
public static CharacterReference lookup(String kernel,
int start,
int end)
Look up a reference by kernel.
Use a binary search on the ordered list of known references.
This is not very efficient, use lookup(CharacterReference)
instead.
kernel
- The string to lookup, i.e. "amp".start
- The starting point in the string of the kernel.end
- The ending point in the string of the kernel.
This should be the index of the semicolon if it exists, or failing that,
at least an index past the last character of the kernel.
- The reference that matches the given string, or
null
if it wasn't found.
lookup
public static CharacterReference lookup(char character)
Look up a reference by character.
Use a combination of direct table lookup and binary search to find
the reference corresponding to the character.
character
- The character to be looked up.
- The entity reference for that character or
null
.
lookup
protected static CharacterReference lookup(CharacterReference key)
Look up a reference by kernel.
Use a binary search on the ordered list of known references.
Since the binary search returns the position at which a new item should
be inserted, we check the references earlier in the list if there is
a failure.
key
- A character reference with the kernel set to the string
to be found. It need not be truncated at the exact end of the reference.
lookup
protected static int lookup(CharacterReference[] array,
char ref,
int lo,
int hi)
Binary search for a reference.
array
- The array of CharacterReference
objects.ref
- The character to search for.lo
- The lower index within which to look.hi
- The upper index within which to look.
- The index at which reference was found or is to be inserted.
main
public static void main(String[] args)
Numeric character reference and character entity reference to unicode codec.
Translate the System.in
input into an encoded or decoded
stream and send the results to System.out
.
args
- If arg[0] is -encode
perform an encoding on
System.in
, otherwise perform a decoding.
| © 2005 Derrick Oswald Mai 08, 2008 |
HTML Parser is an open source library released under LGPL. |  |