com.lowagie.text.pdf.XfdfReader Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of itext2 Show documentation
Show all versions of itext2 Show documentation
Itext is a java library to create and manipulate PDFs.
This is a fork of version 2.1.7 the last MPL/LGPL version.
It's focused basically on mantain compatibility with newer bouncycastle releases and small bugfixes.
/*
*
* Copyright 2004 by Leonard Rosenthol.
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (the "License"); you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the License.
*
* The Original Code is 'iText, a free JAVA-PDF library'.
*
* The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
* the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
* All Rights Reserved.
* Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
* are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
*
* Contributor(s): all the names of the contributors are added in the source code
* where applicable.
*
* Alternatively, the contents of this file may be used under the terms of the
* LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
* provisions of LGPL are applicable instead of those above. If you wish to
* allow use of your version of this file only under the terms of the LGPL
* License and not to allow others to use your version of this file under
* the MPL, indicate your decision by deleting the provisions above and
* replace them with the notice and other provisions required by the LGPL.
* If you do not delete the provisions above, a recipient may use your version
* of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MPL as stated above or under the terms of the GNU
* Library General Public License as published by the Free Software Foundation;
* either version 2 of the License, or any later version.
*
* 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 Library general Public License for more
* details.
*
* If you didn't download this code from the following link, you should check if
* you aren't using an obsolete version:
* http://www.lowagie.com/iText/
*/
package com.lowagie.text.pdf;
import java.io.ByteArrayInputStream;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Stack;
import com.lowagie.text.xml.simpleparser.SimpleXMLDocHandler;
import com.lowagie.text.xml.simpleparser.SimpleXMLParser;
/**
* Reads a XFDF.
* @author Leonard Rosenthol ([email protected])
*/
public class XfdfReader implements SimpleXMLDocHandler {
// stuff used during parsing to handle state
private boolean foundRoot = false;
private Stack fieldNames = new Stack();
private Stack fieldValues = new Stack();
// storage for the field list and their values
HashMap fields;
/**
* Storage for field values if there's more than one value for a field.
* @since 2.1.4
*/
protected HashMap listFields;
// storage for the path to referenced PDF, if any
String fileSpec;
/** Reads an XFDF form.
* @param filename the file name of the form
* @throws IOException on error
*/
public XfdfReader(String filename) throws IOException {
this(new FileInputStream(filename));
}
public XfdfReader(InputStream fin) throws IOException {
try {
SimpleXMLParser.parse(this, fin);
}
finally {
try{fin.close();}catch(Exception e){}
}
}
/** Reads an XFDF form.
* @param xfdfIn the byte array with the form
* @throws IOException on error
*/
public XfdfReader(byte xfdfIn[]) throws IOException {
this(new ByteArrayInputStream(xfdfIn));
}
/** Gets all the fields. The map is keyed by the fully qualified
* field name and the value is a merged PdfDictionary
* with the field content.
* @return all the fields
*/
public HashMap getFields() {
return fields;
}
/** Gets the field value.
* @param name the fully qualified field name
* @return the field's value
*/
public String getField(String name) {
return (String)fields.get(name);
}
/** Gets the field value or null if the field does not
* exist or has no value defined.
* @param name the fully qualified field name
* @return the field value or null
*/
public String getFieldValue(String name) {
String field = (String)fields.get(name);
if (field == null) {
return null;
}
else {
return field;
}
}
/**
* Gets the field values for a list or null if the field does not
* exist or has no value defined.
* @param name the fully qualified field name
* @return the field values or null
* @since 2.1.4
*/
public List getListValues(String name) {
return (List)listFields.get(name);
}
/** Gets the PDF file specification contained in the FDF.
* @return the PDF file specification contained in the FDF
*/
public String getFileSpec() {
return fileSpec;
}
/**
* Called when a start tag is found.
* @param tag the tag name
* @param h the tag's attributes
*/
public void startElement(String tag, HashMap h)
{
if ( !foundRoot ) {
if (!tag.equals("xfdf")) {
throw new RuntimeException("Root element is not Bookmark.");
}
else {
foundRoot = true;
}
}
if ( tag.equals("xfdf") ){
} else if ( tag.equals("f") ) {
fileSpec = (String)h.get( "href" );
} else if ( tag.equals("fields") ) {
fields = new HashMap(); // init it!
listFields = new HashMap();
} else if ( tag.equals("field") ) {
String fName = (String) h.get( "name" );
fieldNames.push( fName );
} else if ( tag.equals("value") ) {
fieldValues.push( "" );
}
}
/**
* Called when an end tag is found.
* @param tag the tag name
*/
public void endElement(String tag) {
if ( "value".equals(tag) ) {
StringBuilder fName = new StringBuilder();
for (int k = 0; k < fieldNames.size(); ++k) {
fName.append(".").append((String)fieldNames.elementAt(k));
}
if (fName.charAt(0) == '.') {
fName.deleteCharAt(0);
}
String fNameString = fName.toString();
String fVal = (String) fieldValues.pop();
String old = (String) fields.put( fNameString, fVal );
if (old != null) {
List l = (List) listFields.get(fNameString);
if (l == null) {
l = new ArrayList();
l.add(old);
}
l.add(fVal);
listFields.put(fNameString, l);
}
}
else if ("field".equals(tag)) {
if (!fieldNames.isEmpty()) {
fieldNames.pop();
}
}
}
/**
* Called when the document starts to be parsed.
*/
public void startDocument()
{
fileSpec = "";
}
/**
* Called after the document is parsed.
*/
public void endDocument()
{
}
/**
* Called when a text element is found.
* @param str the text element, probably a fragment.
*/
public void text(String str)
{
if (fieldNames.isEmpty() || fieldValues.isEmpty())
return;
String val = (String)fieldValues.pop();
val += str;
fieldValues.push(val);
}
}