uk.ac.soton.harvester
Class EntityWriter

java.lang.Object
  |
  +--java.io.Writer
        |
        +--java.io.PrintWriter
              |
              +--uk.ac.soton.harvester.EntityWriter

public class EntityWriter
extends java.io.PrintWriter

EntityWriter extends the behaviour of PrintWriter so that any non-ASCII characters are printed by their ISO-Latin-1 entity names. This class accompanies EntityReader to allow the processor to read data in from and write data out to XML-based files.


Field Summary
(package private)  java.util.Dictionary d
          d provides a reverse lookup from character number to entity name
 
Fields inherited from class java.io.PrintWriter
out
 
Fields inherited from class java.io.Writer
lock
 
Constructor Summary
(package private) EntityWriter(java.io.BufferedWriter b)
          The main constructor allows an EntityWriter to be based on any kind of BufferedWriter.
 
Method Summary
(package private)  java.lang.String entName(char ch)
          entName is a wrapper function which guarantees a safe name for a character position.
(package private)  java.lang.String entString(java.lang.String s)
          entString encodes any unusual characters in a string as ISOLAtin-1 entities.
 void println(java.lang.String s)
          println prints an entity-encoded version of its parameter.
 
Methods inherited from class java.io.PrintWriter
checkError, close, flush, print, print, print, print, print, print, print, print, print, println, println, println, println, println, println, println, println, println, setError, write, write, write, write, write
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

d

java.util.Dictionary d
d provides a reverse lookup from character number to entity name
Constructor Detail

EntityWriter

EntityWriter(java.io.BufferedWriter b)
The main constructor allows an EntityWriter to be based on any kind of BufferedWriter.
Method Detail

entName

java.lang.String entName(char ch)
entName is a wrapper function which guarantees a safe name for a character position. It defaults to "unknown" for pathalogical cases.
Parameters:
ch - character value to look up
Returns:
ISOLatin-1 entity name of the character parameter (or "unknown" in pathalogical cases).

entString

java.lang.String entString(java.lang.String s)
entString encodes any unusual characters in a string as ISOLAtin-1 entities. Ordinary ASCII characters are left untouched. Some "ordinary" characters ('&','<','>') have to be usurped to conform to the XML standard. e.g. "Carr & René" is transformed into "Carr &mp; Ren&eacute;" .
Parameters:
s - the string to process
Returns:
the string with embedded characters replaced by entity names

println

public void println(java.lang.String s)
println prints an entity-encoded version of its parameter.
Overrides:
println in class java.io.PrintWriter
Parameters:
s - the String to print