PdfStructureTreeRoot.java

/*
 * $Id: PdfStructureTreeRoot.java 3914 2009-04-26 09:16:47Z blowagie $
 *
 * Copyright 2005 by Paulo Soares.
 *
 * 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.IOException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * The structure tree root corresponds to the highest hierarchy level in a tagged PDF.
 * @author Paulo Soares (psoares@consiste.pt)
 */
public class PdfStructureTreeRoot extends PdfDictionary {
    
    private Map<Integer,PdfArray> parentTree = new HashMap<>();
    private PdfIndirectReference reference;

    /**
     * Holds value of property writer.
     */
    private PdfWriter writer;
    
    /** Creates a new instance of PdfStructureTreeRoot */
    PdfStructureTreeRoot(PdfWriter writer) {
        super(PdfName.STRUCTTREEROOT);
        this.writer = writer;
        reference = writer.getPdfIndirectReference();
    }
    
    /**
     * Maps the user tags to the standard tags. The mapping will allow a standard application to make some sense of the tagged
     * document whatever the user tags may be.
     * @param used the user tag
     * @param standard the standard tag
     */    
    public void mapRole(PdfName used, PdfName standard) {
        PdfDictionary rm = (PdfDictionary)get(PdfName.ROLEMAP);
        if (rm == null) {
            rm = new PdfDictionary();
            put(PdfName.ROLEMAP, rm);
        }
        rm.put(used, standard);
    }
    
    /**
     * Gets the writer.
     * @return the writer
     */
    public PdfWriter getWriter() {
        return this.writer;
    }

    /**
     * Gets the reference this object will be written to.
     * @return the reference this object will be written to
     * @since    2.1.6 method removed in 2.1.5, but restored in 2.1.6
     */    
    public PdfIndirectReference getReference() {
        return this.reference;
    }
    
    void setPageMark(int page, PdfIndirectReference struc) {
        Integer i = page;
        PdfArray ar = parentTree.get(i);
        if (ar == null) {
            ar = new PdfArray();
            parentTree.put(i, ar);
        }
        ar.add(struc);
    }
    
    private void nodeProcess(PdfDictionary struc, PdfIndirectReference reference) throws IOException {
        PdfObject obj = struc.get(PdfName.K);
        if (obj != null && obj.isArray() && !((PdfArray)obj).getElements().get(0).isNumber()) {
            PdfArray ar = (PdfArray)obj;
            List<PdfObject> a = ar.getElements();
            for (int k = 0; k < a.size(); ++k) {
                PdfStructureElement e = (PdfStructureElement)a.get(k);
                a.set(k, e.getReference());
                nodeProcess(e, e.getReference());
            }
        }
        if (reference != null)
            writer.addToBody(struc, reference);
    }
    
    void buildTree() throws IOException {
        Map<Integer, PdfIndirectReference> numTree = new HashMap<>();
        for (Integer i : parentTree.keySet()) {
            PdfArray ar = parentTree.get(i);
            numTree.put(i, writer.addToBody(ar).getIndirectReference());
        }
        PdfDictionary dicTree = PdfNumberTree.writeTree(numTree, writer);
        if (dicTree != null)
            put(PdfName.PARENTTREE, writer.addToBody(dicTree).getIndirectReference());
        
        nodeProcess(this, reference);
    }
}













Active mutators

INCREMENTS_MUTATOR
VOID_METHOD_CALL_MUTATOR
RETURN_VALS_MUTATOR
MATH_MUTATOR
NEGATE_CONDITIONALS_MUTATOR
INVERT_NEGS_MUTATOR
CONDITIONALS_BOUNDARY_MUTATOR

Tests examined

Report generated by PIT 1.4.2

1		/*
2		* $Id: PdfStructureTreeRoot.java 3914 2009-04-26 09:16:47Z blowagie $
3		*
4		* Copyright 2005 by Paulo Soares.
5		*
6		* The contents of this file are subject to the Mozilla Public License Version 1.1
7		* (the "License"); you may not use this file except in compliance with the License.
8		* You may obtain a copy of the License at http://www.mozilla.org/MPL/
9		*
10		* Software distributed under the License is distributed on an "AS IS" basis,
11		* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12		* for the specific language governing rights and limitations under the License.
13		*
14		* The Original Code is 'iText, a free JAVA-PDF library'.
15		*
16		* The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
17		* the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
18		* All Rights Reserved.
19		* Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
20		* are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
21		*
22		* Contributor(s): all the names of the contributors are added in the source code
23		* where applicable.
24		*
25		* Alternatively, the contents of this file may be used under the terms of the
26		* LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
27		* provisions of LGPL are applicable instead of those above. If you wish to
28		* allow use of your version of this file only under the terms of the LGPL
29		* License and not to allow others to use your version of this file under
30		* the MPL, indicate your decision by deleting the provisions above and
31		* replace them with the notice and other provisions required by the LGPL.
32		* If you do not delete the provisions above, a recipient may use your version
33		* of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
34		*
35		* This library is free software; you can redistribute it and/or modify it
36		* under the terms of the MPL as stated above or under the terms of the GNU
37		* Library General Public License as published by the Free Software Foundation;
38		* either version 2 of the License, or any later version.
39		*
40		* This library is distributed in the hope that it will be useful, but WITHOUT
41		* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
42		* FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
43		* details.
44		*
45		* If you didn't download this code from the following link, you should check if
46		* you aren't using an obsolete version:
47		* http://www.lowagie.com/iText/
48		*/
49		package com.lowagie.text.pdf;
50
51		import java.io.IOException;
52		import java.util.HashMap;
53		import java.util.List;
54		import java.util.Map;
55
56		/**
57		* The structure tree root corresponds to the highest hierarchy level in a tagged PDF.
58		* @author Paulo Soares (psoares@consiste.pt)
59		*/
60		public class PdfStructureTreeRoot extends PdfDictionary {
61
62		private Map<Integer,PdfArray> parentTree = new HashMap<>();
63		private PdfIndirectReference reference;
64
65		/**
66		* Holds value of property writer.
67		*/
68		private PdfWriter writer;
69
70		/** Creates a new instance of PdfStructureTreeRoot */
71		PdfStructureTreeRoot(PdfWriter writer) {
72		super(PdfName.STRUCTTREEROOT);
73		this.writer = writer;
74		reference = writer.getPdfIndirectReference();
75		}
76
77		/**
78		* Maps the user tags to the standard tags. The mapping will allow a standard application to make some sense of the tagged
79		* document whatever the user tags may be.
80		* @param used the user tag
81		* @param standard the standard tag
82		*/
83		public void mapRole(PdfName used, PdfName standard) {
84		PdfDictionary rm = (PdfDictionary)get(PdfName.ROLEMAP);
85	1 1. mapRole : negated conditional → NO_COVERAGE	if (rm == null) {
86		rm = new PdfDictionary();
87	1 1. mapRole : removed call to com/lowagie/text/pdf/PdfStructureTreeRoot::put → NO_COVERAGE	put(PdfName.ROLEMAP, rm);
88		}
89	1 1. mapRole : removed call to com/lowagie/text/pdf/PdfDictionary::put → NO_COVERAGE	rm.put(used, standard);
90		}
91
92		/**
93		* Gets the writer.
94		* @return the writer
95		*/
96		public PdfWriter getWriter() {
97		return this.writer;
98		}
99
100		/**
101		* Gets the reference this object will be written to.
102		* @return the reference this object will be written to
103		* @since 2.1.6 method removed in 2.1.5, but restored in 2.1.6
104		*/
105		public PdfIndirectReference getReference() {
106		return this.reference;
107		}
108
109		void setPageMark(int page, PdfIndirectReference struc) {
110		Integer i = page;
111		PdfArray ar = parentTree.get(i);
112	1 1. setPageMark : negated conditional → NO_COVERAGE	if (ar == null) {
113		ar = new PdfArray();
114		parentTree.put(i, ar);
115		}
116		ar.add(struc);
117		}
118
119		private void nodeProcess(PdfDictionary struc, PdfIndirectReference reference) throws IOException {
120		PdfObject obj = struc.get(PdfName.K);
121	3 1. nodeProcess : negated conditional → NO_COVERAGE 2. nodeProcess : negated conditional → NO_COVERAGE 3. nodeProcess : negated conditional → NO_COVERAGE	if (obj != null && obj.isArray() && !((PdfArray)obj).getElements().get(0).isNumber()) {
122		PdfArray ar = (PdfArray)obj;
123		List<PdfObject> a = ar.getElements();
124	2 1. nodeProcess : changed conditional boundary → NO_COVERAGE 2. nodeProcess : negated conditional → NO_COVERAGE	for (int k = 0; k < a.size(); ++k) {
125		PdfStructureElement e = (PdfStructureElement)a.get(k);
126		a.set(k, e.getReference());
127	1 1. nodeProcess : removed call to com/lowagie/text/pdf/PdfStructureTreeRoot::nodeProcess → NO_COVERAGE	nodeProcess(e, e.getReference());
128		}
129		}
130	1 1. nodeProcess : negated conditional → NO_COVERAGE	if (reference != null)
131		writer.addToBody(struc, reference);
132		}
133
134		void buildTree() throws IOException {
135		Map<Integer, PdfIndirectReference> numTree = new HashMap<>();
136		for (Integer i : parentTree.keySet()) {
137		PdfArray ar = parentTree.get(i);
138		numTree.put(i, writer.addToBody(ar).getIndirectReference());
139		}
140		PdfDictionary dicTree = PdfNumberTree.writeTree(numTree, writer);
141	1 1. buildTree : negated conditional → NO_COVERAGE	if (dicTree != null)
142	1 1. buildTree : removed call to com/lowagie/text/pdf/PdfStructureTreeRoot::put → NO_COVERAGE	put(PdfName.PARENTTREE, writer.addToBody(dicTree).getIndirectReference());
143
144	1 1. buildTree : removed call to com/lowagie/text/pdf/PdfStructureTreeRoot::nodeProcess → NO_COVERAGE	nodeProcess(this, reference);
145		}
146		}
		Mutations
85		1.1 Location : mapRole Killed by : none negated conditional → NO_COVERAGE
87		1.1 Location : mapRole Killed by : none removed call to com/lowagie/text/pdf/PdfStructureTreeRoot::put → NO_COVERAGE
89		1.1 Location : mapRole Killed by : none removed call to com/lowagie/text/pdf/PdfDictionary::put → NO_COVERAGE
112		1.1 Location : setPageMark Killed by : none negated conditional → NO_COVERAGE
121		1.1 Location : nodeProcess Killed by : none negated conditional → NO_COVERAGE 2.2 Location : nodeProcess Killed by : none negated conditional → NO_COVERAGE 3.3 Location : nodeProcess Killed by : none negated conditional → NO_COVERAGE
124		1.1 Location : nodeProcess Killed by : none changed conditional boundary → NO_COVERAGE 2.2 Location : nodeProcess Killed by : none negated conditional → NO_COVERAGE
127		1.1 Location : nodeProcess Killed by : none removed call to com/lowagie/text/pdf/PdfStructureTreeRoot::nodeProcess → NO_COVERAGE
130		1.1 Location : nodeProcess Killed by : none negated conditional → NO_COVERAGE
141		1.1 Location : buildTree Killed by : none negated conditional → NO_COVERAGE
142		1.1 Location : buildTree Killed by : none removed call to com/lowagie/text/pdf/PdfStructureTreeRoot::put → NO_COVERAGE
144		1.1 Location : buildTree Killed by : none removed call to com/lowagie/text/pdf/PdfStructureTreeRoot::nodeProcess → NO_COVERAGE

PdfStructureTreeRoot.java

Mutations

Active mutators

Tests examined