com.itextpdf.kernel.utils

Class TaggedPdfReaderTool

java.lang.Object

com.itextpdf.kernel.utils.TaggedPdfReaderTool

public class TaggedPdfReaderTool
extends Object

Converts a tagged PDF document into an XML file.

Field Summary

Fields

Modifier and Type	Field and Description
protected PdfDocument	document
protected OutputStreamWriter	out
protected Map<PdfDictionary,Map<Integer,String>>	parsedTags
protected String	rootTag

Constructor Summary

Constructors

Constructor and Description
TaggedPdfReaderTool(PdfDocument document) Constructs a TaggedPdfReaderTool via a given PdfDocument.

Method Summary

Modifier and Type	Method and Description
void	convertToXml(OutputStream os) Converts the current tag structure into an XML file with default encoding (UTF-8).
void	convertToXml(OutputStream os, String charset) Converts the current tag structure into an XML file with provided encoding.
protected static String	escapeXML(String s, boolean onlyASCII) NOTE: copied from itext5 XMLUtils class Escapes a string with the appropriated XML codes.
protected static String	fixTagName(String tag)
protected void	inspectAttributes(PdfStructElem kid)
protected void	inspectKid(IPdfStructElem kid)
protected void	inspectKids(List<IPdfStructElem> kids)
static boolean	isValidCharacterValue(int c) Checks if a character value should be escaped/unescaped.
protected void	parseTag(PdfMcr kid)
TaggedPdfReaderTool	setRootTag(String rootTagName) Sets the name of the root tag of the resultant XML file

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

document

protected PdfDocument document

out

protected OutputStreamWriter out

rootTag

protected String rootTag

parsedTags

protected Map<PdfDictionary,Map<Integer,String>> parsedTags

Constructor Detail

TaggedPdfReaderTool

public TaggedPdfReaderTool(PdfDocument document)

Constructs a TaggedPdfReaderTool via a given PdfDocument.

Parameters:

document - the document to read tag structure from

Method Detail

isValidCharacterValue

public static boolean isValidCharacterValue(int c)

Checks if a character value should be escaped/unescaped.

Parameters:

c - a character value

Returns:

true if it's OK to escape or unescape this value

convertToXml

public void convertToXml(OutputStream os)
                  throws IOException

Converts the current tag structure into an XML file with default encoding (UTF-8).

Parameters:

os - the output stream to save XML file to

Throws:

IOException

convertToXml

public void convertToXml(OutputStream os,
                         String charset)
                  throws IOException

Converts the current tag structure into an XML file with provided encoding.

Parameters:

os - the output stream to save XML file to

charset - the charset of the resultant XML file

Throws:

IOException

setRootTag

public TaggedPdfReaderTool setRootTag(String rootTagName)

Sets the name of the root tag of the resultant XML file

Parameters:

rootTagName - the name of the root tag

Returns:

this object

inspectKids

protected void inspectKids(List<IPdfStructElem> kids)

inspectKid

protected void inspectKid(IPdfStructElem kid)

inspectAttributes

protected void inspectAttributes(PdfStructElem kid)

parseTag

protected void parseTag(PdfMcr kid)

fixTagName

protected static String fixTagName(String tag)

escapeXML

protected static String escapeXML(String s,
                                  boolean onlyASCII)

NOTE: copied from itext5 XMLUtils class Escapes a string with the appropriated XML codes.

Parameters:

s - the string to be escaped

onlyASCII - codes above 127 will always be escaped with &#nn; if true

Returns:

the escaped string