org.jpedal.objects.outlines.OutlineData Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jsign-jpedal Show documentation
JPedal fork
The newest version!
/*
 * ===========================================
 * Java Pdf Extraction Decoding Access Library
 * ===========================================
 *
 * Project Info:  http://www.idrsolutions.com
 * Help section for developers at http://www.idrsolutions.com/java-pdf-library-support/
 *
 * (C) Copyright 1997-2013, IDRsolutions and Contributors.
 *
 * 	This file is part of JPedal
 *
     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.

    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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA


 *
 * ---------------
 * OutlineData.java
 * ---------------
 */
package org.jpedal.objects.outlines;

import java.util.HashMap;
import java.util.Map;

import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;

import org.jpedal.io.ArrayDecoder;
import org.jpedal.io.PdfObjectReader;
import org.jpedal.objects.raw.OutlineObject;
import org.jpedal.objects.raw.PdfArrayIterator;
import org.jpedal.objects.raw.PdfDictionary;
import org.jpedal.objects.raw.PdfObject;
import org.jpedal.utils.StringUtils;
import org.w3c.dom.Document;
import org.w3c.dom.Element;

/**
 * encapsulate the Outline data
 */
public class OutlineData {

	private Document OutlineDataXML;

	private Map DestObjs = new HashMap();

	// private OutlineData(){}

	/** create list when object initialised */
	public OutlineData(int pageCount) {

		DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
		try {
			this.OutlineDataXML = factory.newDocumentBuilder().newDocument();
		}
		catch (ParserConfigurationException e) {
			System.err.println("Exception " + e + " generating XML document");
		}

		// increment so arrays correct size
		// pageCount++;
	}

	/** return the list */
	public Document getList() {
		return this.OutlineDataXML;
	}

	/**
	 * read the outline data
	 */
	public int readOutlineFileMetadata(PdfObject OutlinesObj, PdfObjectReader currentPdfFile) {

		int count = OutlinesObj.getInt(PdfDictionary.Count);

		PdfObject FirstObj = OutlinesObj.getDictionary(PdfDictionary.First);
		currentPdfFile.checkResolved(FirstObj);
		if (FirstObj != null) {

			Element root = this.OutlineDataXML.createElement("root");

			this.OutlineDataXML.appendChild(root);

			int level = 0;
			readOutlineLevel(root, currentPdfFile, FirstObj, level, false);

		}

		/**
		 * //build lookup table int pageCount=this.refTop.length; String lastLink=null,currentBottom; for(int i=1;i 0) {// && type==PdfDictionary.Goto) {

				int count = DestObj.getTokenCount();

				if (count > 0) {
					if (DestObj.isNextValueRef()) ref = DestObj.getNextValueAsString(true);
					else { // its nameString name (name) linking to obj so read that
						String nameString = DestObj.getNextValueAsString(true);

						// check if object and read if so (can also be an indirect name which we lookup
						if (nameString != null) {

							ref = currentPdfFile.convertNameToRef(nameString);

							// allow for direct value
							if (ref != null && ref.startsWith("[")) {

								byte[] raw = StringUtils.toBytes(ref);
								ArrayDecoder objDecoder = new ArrayDecoder(currentPdfFile.getObjectReader(), 0, raw.length,
										PdfDictionary.VALUE_IS_MIXED_ARRAY, null, PdfDictionary.Names);
								objDecoder.readArray(false, raw, Aobj, PdfDictionary.Dest);
								DestObj = Aobj.getMixedArray(PdfDictionary.Dest);
							}
							else
								if (ref != null) {
									Aobj = new OutlineObject(ref);
									currentPdfFile.readObject(Aobj);
									DestObj = Aobj.getMixedArray(PdfDictionary.Dest);
								}

							if (DestObj != null) {
								count = DestObj.getTokenCount();

								if (count > 0 && DestObj.hasMoreTokens() && DestObj.isNextValueRef()) ref = DestObj.getNextValueAsString(true);
							}
						}
					}
				}
			}

			if (ref != null) page = currentPdfFile.convertObjectToPageNumber(ref);

			// add title to tree
			byte[] titleData = outlineObj.getTextStreamValueAsByte(PdfDictionary.Title);
			if (titleData != null) {

				String title = StringUtils.getTextString(titleData, false);

				// add node
				child = this.OutlineDataXML.createElement("title");
				root.appendChild(child);
				child.setAttribute("title", title);

			}

			child.setAttribute("isClosed", String.valueOf(isClosed));

			// store Dest so we can access
			if (Aobj != null) this.DestObjs.put(ID, Aobj);

			if (page != -1) child.setAttribute("page", String.valueOf(page));

			child.setAttribute("level", String.valueOf(level));
			child.setAttribute("objectRef", ID);

			if (FirstObj != null) readOutlineLevel(child, currentPdfFile, FirstObj, level + 1, isClosed);

			if (NextObj == null) break;

			FirstObj = NextObj;

		}
	}

	/**
	 * not recommended for general usage
	 * 
	 * @param ref
	 * @return Aobj
	 */
	public PdfObject getAobj(String ref) {
		return (PdfObject) this.DestObjs.get(ref);
	}
}