<changes>
<release version="3.8-beta4" date="2011-??-??">
+ <action dev="poi-developers" type="add">51265 - Enhanced Handling of Picture Parts in XWPF</action>
<action dev="poi-developers" type="add">51292 - Additional HWPF Table Cell Descriptor values</action>
</release>
- <release version="3.8-beta3" date="2011-??-??">
- <action dev="poi-developers" type="fix">51098 - Correct calculate image width/height, if image fits into one cell</action>
+ <release version="3.8-beta3" date="2011-06-06">
+ <action dev="poi-developers" type="fix">51098 - Correctly calculate image width/height, if image fits into one cell</action>
<action dev="poi-developers" type="fix">47147 - Correct extra paragraphs from XWPF Table Cells</action>
<action dev="poi-developers" type="add">51188 - Support for getting and setting XPWF zoom settings</action>
<action dev="poi-developers" type="add">51134 - Support for adding Numbering and Styles to a XWPF document that doesn't already have them</action>
import java.io.OutputStream;
import java.nio.ByteBuffer;
import java.nio.channels.ReadableByteChannel;
+import java.util.zip.CRC32;
+import java.util.zip.Checksum;
public final class IOUtils {
private IOUtils() {
}
}
}
+
+ public static long calculateChecksum(byte[] data) {
+ Checksum sum = new CRC32();
+ sum.update(data, 0, data.length);
+ return sum.getValue();
+ }
}
import org.apache.poi.openxml4j.exceptions.OpenXML4JException;
import org.apache.poi.openxml4j.opc.OPCPackage;
import org.apache.poi.openxml4j.opc.PackagePart;
-import org.apache.poi.openxml4j.opc.PackagePartName;
import org.apache.poi.openxml4j.opc.PackageRelationship;
import org.apache.poi.openxml4j.opc.PackageRelationshipCollection;
-import org.apache.poi.openxml4j.opc.PackagingURIHelper;
import org.apache.poi.poifs.common.POIFSConstants;
import org.apache.poi.util.IOUtils;
return getPackagePart();
}
- /**
- * Get the PackagePart that is the target of a relationship.
- *
- * @param rel The relationship
- * @return The target part
- * @throws InvalidFormatException
- */
- protected PackagePart getTargetPart(PackageRelationship rel) throws InvalidFormatException {
- return getTargetPart(getPackage(), rel);
- }
- /**
- * Get the PackagePart that is the target of a relationship.
- *
- * @param rel The relationship
- * @param pkg The package to fetch from
- * @return The target part
- * @throws InvalidFormatException
- */
- protected static PackagePart getTargetPart(OPCPackage pkg, PackageRelationship rel) throws InvalidFormatException {
- PackagePartName relName = PackagingURIHelper.createPartName(rel.getTargetURI());
- PackagePart part = pkg.getPart(relName);
- if (part == null) {
- throw new IllegalArgumentException("No part found for relationship " + rel);
- }
- return part;
- }
-
/**
* Retrieves all the PackageParts which are defined as
* relationships of the base document with the
return parts;
}
-
-
/**
* Checks that the supplied InputStream (which MUST
* support mark and reset, or be a PushbackInputStream)
// Did it match the ooxml zip signature?
return (
- header[0] == POIFSConstants.OOXML_FILE_HEADER[0] &&
- header[1] == POIFSConstants.OOXML_FILE_HEADER[1] &&
- header[2] == POIFSConstants.OOXML_FILE_HEADER[2] &&
- header[3] == POIFSConstants.OOXML_FILE_HEADER[3]
+ header[0] == POIFSConstants.OOXML_FILE_HEADER[0] &&
+ header[1] == POIFSConstants.OOXML_FILE_HEADER[1] &&
+ header[2] == POIFSConstants.OOXML_FILE_HEADER[2] &&
+ header[3] == POIFSConstants.OOXML_FILE_HEADER[3]
);
}
public abstract List<PackagePart> getAllEmbedds() throws OpenXML4JException;
protected final void load(POIXMLFactory factory) throws IOException {
- Map<PackagePart, POIXMLDocumentPart> context = new HashMap<PackagePart, POIXMLDocumentPart>();
+
Map<PackagePart, POIXMLDocumentPart> context = new HashMap<PackagePart, POIXMLDocumentPart>();
try {
read(factory, context);
} catch (OpenXML4JException e){
throw new POIXMLException(e);
}
- onDocumentRead();
- context.clear();
+ onDocumentRead();
+ context.clear();
}
/**
package org.apache.poi;
import java.io.IOException;
-import java.util.*;
import java.net.URI;
+import java.util.*;
+import java.util.Map.Entry;
-import org.apache.xmlbeans.XmlOptions;
-import org.apache.poi.util.POILogger;
-import org.apache.poi.util.POILogFactory;
import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
import org.apache.poi.openxml4j.exceptions.OpenXML4JException;
-import org.apache.poi.openxml4j.opc.*;
+import org.apache.poi.openxml4j.opc.OPCPackage;
+import org.apache.poi.openxml4j.opc.PackagePart;
+import org.apache.poi.openxml4j.opc.PackagePartName;
+import org.apache.poi.openxml4j.opc.PackageRelationship;
+import org.apache.poi.openxml4j.opc.PackageRelationshipCollection;
+import org.apache.poi.openxml4j.opc.PackageRelationshipTypes;
+import org.apache.poi.openxml4j.opc.PackagingURIHelper;
+import org.apache.poi.openxml4j.opc.TargetMode;
+import org.apache.poi.util.POILogFactory;
+import org.apache.poi.util.POILogger;
+import org.apache.xmlbeans.XmlOptions;
/**
* Represents an entry of a OOXML package.
DEFAULT_XML_OPTIONS.setSaveAggressiveNamespaces();
}
+
private PackagePart packagePart;
private PackageRelationship packageRel;
private POIXMLDocumentPart parent;
- private List<POIXMLDocumentPart> relations;
+ private Map<String,POIXMLDocumentPart> relations = new LinkedHashMap<String,POIXMLDocumentPart>();
+
+ /**
+ * Get the PackagePart that is the target of a relationship.
+ *
+ * @param rel The relationship
+ * @param pkg The package to fetch from
+ * @return The target part
+ * @throws InvalidFormatException
+ */
+ protected static PackagePart getTargetPart(OPCPackage pkg, PackageRelationship rel)
+ throws InvalidFormatException {
+ PackagePartName relName = PackagingURIHelper.createPartName(rel.getTargetURI());
+ PackagePart part = pkg.getPart(relName);
+ if (part == null) {
+ throw new IllegalArgumentException("No part found for relationship " + rel);
+ }
+ return part;
+ }
+ /**
+ * Counter that provides the amount of incoming relations from other parts
+ * to this part.
+ */
+ private int relationCounter = 0;
+
+ int incrementRelationCounter() {
+ relationCounter++;
+ return relationCounter;
+ }
+
+ int decrementRelationCounter() {
+ relationCounter--;
+ return relationCounter;
+ }
+
+ int getRelationCounter() {
+ return relationCounter;
+ }
/**
* Construct POIXMLDocumentPart representing a "core document" package part.
*/
public POIXMLDocumentPart(OPCPackage pkg) {
- PackageRelationship coreRel = pkg.getRelationshipsByType(
- PackageRelationshipTypes.CORE_DOCUMENT).getRelationship(0);
+ PackageRelationship coreRel = pkg.getRelationshipsByType(PackageRelationshipTypes.CORE_DOCUMENT).getRelationship(0);
- this.relations = new LinkedList<POIXMLDocumentPart>();
this.packagePart = pkg.getPart(coreRel);
this.packageRel = coreRel;
}
* @see #createRelationship(POIXMLRelation, POIXMLFactory, int, boolean)
*/
public POIXMLDocumentPart(){
- this.relations = new LinkedList<POIXMLDocumentPart>();
}
/**
* @see #read(POIXMLFactory, java.util.Map)
*/
public POIXMLDocumentPart(PackagePart part, PackageRelationship rel){
- this.relations = new LinkedList<POIXMLDocumentPart>();
this.packagePart = part;
this.packageRel = rel;
}
* @see #read(POIXMLFactory, java.util.Map)
*/
public POIXMLDocumentPart(POIXMLDocumentPart parent, PackagePart part, PackageRelationship rel){
- this.relations = new LinkedList<POIXMLDocumentPart>();
this.packagePart = part;
this.packageRel = rel;
this.parent = parent;
* current core document
*/
protected final void rebase(OPCPackage pkg) throws InvalidFormatException {
- PackageRelationshipCollection cores =
- packagePart.getRelationshipsByType(PackageRelationshipTypes.CORE_DOCUMENT);
- if(cores.size() != 1) {
- throw new IllegalStateException(
+ PackageRelationshipCollection cores =
+ packagePart.getRelationshipsByType(PackageRelationshipTypes.CORE_DOCUMENT);
+ if(cores.size() != 1) {
+ throw new IllegalStateException(
"Tried to rebase using " + PackageRelationshipTypes.CORE_DOCUMENT +
" but found " + cores.size() + " parts of the right type"
- );
- }
- packageRel = cores.getRelationship(0);
- packagePart = POIXMLDocument.getTargetPart(pkg, packageRel);
+ );
+ }
+ packageRel = cores.getRelationship(0);
+ packagePart = POIXMLDocument.getTargetPart(pkg, packageRel);
}
/**
* @return child relations
*/
public final List<POIXMLDocumentPart> getRelations(){
- return relations;
+ return Collections.unmodifiableList(new ArrayList<POIXMLDocumentPart>(relations.values()));
+ }
+
+ /**
+ * Returns the target {@link POIXMLDocumentPart}, where a
+ * {@link PackageRelationship} is set from the {@link PackagePart} of this
+ * {@link POIXMLDocumentPart} to the {@link PackagePart} of the target
+ * {@link POIXMLDocumentPart} with a {@link PackageRelationship#getId()}
+ * matching the given parameter value.
+ *
+ * @param id
+ * The relation id to look for
+ * @return the target part of the relation, or null, if none exists
+ */
+ public final POIXMLDocumentPart getRelationById(String id) {
+ return relations.get(id);
+ }
+
+ /**
+ * Returns the {@link PackageRelationship#getId()} of the
+ * {@link PackageRelationship}, that sources from the {@link PackagePart} of
+ * this {@link POIXMLDocumentPart} to the {@link PackagePart} of the given
+ * parameter value.
+ *
+ * @param part
+ * The {@link POIXMLDocumentPart} for which the according
+ * relation-id shall be found.
+ * @return The value of the {@link PackageRelationship#getId()} or null, if
+ * parts are not related.
+ */
+ public final String getRelationId(POIXMLDocumentPart part) {
+ Iterator<Entry<String, POIXMLDocumentPart>> iter = relations.entrySet().iterator();
+ while (iter.hasNext())
+ {
+ Entry<String, POIXMLDocumentPart> entry = iter.next();
+ if (entry.getValue() == part) {
+ return entry.getKey();
+ }
+ }
+ return null;
}
/**
*
* @param part the child to add
*/
- protected final void addRelation(POIXMLDocumentPart part){
- relations.add(part);
+ protected final void addRelation(String id,POIXMLDocumentPart part){
+ relations.put(id,part);
+ part.incrementRelationCounter();
}
/**
- * Remove the specified part in this package.
+ * Remove the relation to the specified part in this package and remove the
+ * part, if it is no longer needed.
*/
- public final void removeRelation(POIXMLDocumentPart part){
- getPackagePart().removeRelationship(part.getPackageRelationship().getId());
- getPackagePart().getPackage().removePart(part.getPackagePart());
- relations.remove(part);
+ protected final void removeRelation(POIXMLDocumentPart part){
+ removeRelation(part,true);
+ }
+
+ /**
+ * Remove the relation to the specified part in this package and remove the
+ * part, if it is no longer needed and flag is set to true.
+ *
+ * @param part
+ * The related part, to which the relation shall be removed.
+ * @param removeUnusedParts
+ * true, if the part shall be removed from the package if not
+ * needed any longer.
+ */
+ protected final boolean removeRelation(POIXMLDocumentPart part, boolean removeUnusedParts){
+ String id = getRelationId(part);
+ if (id == null) {
+ // part is not related with this POIXMLDocumentPart
+ return false;
+ }
+ /* decrement usage counter */
+ part.decrementRelationCounter();
+ /* remove packagepart relationship */
+ getPackagePart().removeRelationship(id);
+ /* remove POIXMLDocument from relations */
+ relations.remove(id);
+
+ if (removeUnusedParts) {
+ /* if last relation to target part was removed, delete according target part */
+ if (part.getRelationCounter() == 0) {
+ try {
+ part.onDocumentRemove();
+ } catch (IOException e) {
+ throw new POIXMLException(e);
+ }
+ getPackagePart().getPackage().removePart(part.getPackagePart());
+ }
+ }
+ return true;
}
/**
* @param alreadySaved context set containing already visited nodes
*/
protected final void onSave(Set<PackagePart> alreadySaved) throws IOException{
- commit();
- alreadySaved.add(this.getPackagePart());
- for(POIXMLDocumentPart p : relations){
+ commit();
+ alreadySaved.add(this.getPackagePart());
+ for(POIXMLDocumentPart p : relations.values()){
if (!alreadySaved.contains(p.getPackagePart())) {
- p.onSave(alreadySaved);
- }
- }
+ p.onSave(alreadySaved);
+ }
+ }
}
/**
try {
PackagePartName ppName = PackagingURIHelper.createPartName(descriptor.getFileName(idx));
PackageRelationship rel = null;
+ PackagePart part = packagePart.getPackage().createPart(ppName, descriptor.getContentType());
if(!noRelation) {
- rel = packagePart.addRelationship(ppName, TargetMode.INTERNAL, descriptor.getRelation());
+ /* only add to relations, if according relationship is being created. */
+ rel = packagePart.addRelationship(ppName, TargetMode.INTERNAL, descriptor.getRelation());
}
- PackagePart part = packagePart.getPackage().createPart(ppName, descriptor.getContentType());
POIXMLDocumentPart doc = factory.newDocumentPart(descriptor);
doc.packageRel = rel;
doc.packagePart = part;
doc.parent = this;
- addRelation(doc);
+ if(!noRelation) {
+ /* only add to relations, if according relationship is being created. */
+ addRelation(rel.getId(),doc);
+ }
return doc;
} catch (Exception e){
throw new POIXMLException(e);
* @param context context map containing already visited noted keyed by targetURI
*/
protected void read(POIXMLFactory factory, Map<PackagePart, POIXMLDocumentPart> context) throws OpenXML4JException {
- PackageRelationshipCollection rels = packagePart.getRelationships();
- for (PackageRelationship rel : rels) {
- if(rel.getTargetMode() == TargetMode.INTERNAL){
- URI uri = rel.getTargetURI();
-
- PackagePart p;
- if(uri.getRawFragment() != null) {
- /*
- * For internal references (e.g. '#Sheet1!A1') the package part is null
- */
- p = null;
- } else {
- PackagePartName relName = PackagingURIHelper.createPartName(uri);
- p = packagePart.getPackage().getPart(relName);
- if(p == null) {
- logger.log(POILogger.ERROR, "Skipped invalid entry " + rel.getTargetURI());
- continue;
- }
- }
-
- if (!context.containsKey(p)) {
- POIXMLDocumentPart childPart = factory.createDocumentPart(this, rel, p);
- childPart.parent = this;
- addRelation(childPart);
- if(p != null){
- context.put(p, childPart);
- if(p.hasRelationships()) childPart.read(factory, context);
- }
- }
- else {
- addRelation(context.get(p));
- }
- }
- }
+ PackageRelationshipCollection rels = packagePart.getRelationships();
+ for (PackageRelationship rel : rels) {
+ if(rel.getTargetMode() == TargetMode.INTERNAL){
+ URI uri = rel.getTargetURI();
+
+ PackagePart p;
+ if(uri.getRawFragment() != null) {
+ /*
+ * For internal references (e.g. '#Sheet1!A1') the package part is null
+ */
+ p = null;
+ } else {
+ PackagePartName relName = PackagingURIHelper.createPartName(uri);
+ p = packagePart.getPackage().getPart(relName);
+ if(p == null) {
+ logger.log(POILogger.ERROR, "Skipped invalid entry " + rel.getTargetURI());
+ continue;
+ }
+ }
+
+ if (!context.containsKey(p)) {
+ POIXMLDocumentPart childPart = factory.createDocumentPart(this, rel, p);
+ childPart.parent = this;
+ addRelation(rel.getId(),childPart);
+ if(p != null){
+ context.put(p, childPart);
+ if(p.hasRelationships()) childPart.read(factory, context);
+ }
+ }
+ else {
+ addRelation(rel.getId(),context.get(p));
+ }
+ }
+ }
}
/**
/**
* Fired when a package part is read
*/
- protected void onDocumentRead() throws IOException{
+ protected void onDocumentRead() throws IOException {
+
+ }
+
+ /**
+ * Get the PackagePart that is the target of a relationship.
+ *
+ * @param rel The relationship
+ * @return The target part
+ * @throws InvalidFormatException
+ */
+ protected PackagePart getTargetPart(PackageRelationship rel) throws InvalidFormatException {
+ return getTargetPart(getPackagePart().getPackage(), rel);
+ }
+
+ /**
+ * Fired when a package part is about to be removed from the package
+ */
+ protected void onDocumentRemove() throws IOException {
}
}
import java.util.ArrayList;
import java.util.Date;
import java.util.Hashtable;
+import java.util.List;
import java.util.concurrent.locks.ReentrantReadWriteLock;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
import org.apache.poi.openxml4j.exceptions.InvalidOperationException;
return retArr;
}
+ /**
+ * @return
+ */
+ public List<PackagePart> getPartsByName(final Pattern namePattern) {
+ if (namePattern == null) {
+ throw new IllegalArgumentException("name pattern must not be null");
+ }
+ ArrayList<PackagePart> result = new ArrayList<PackagePart>();
+ for (PackagePart part : partList.values()) {
+ PackagePartName partName = part.getPartName();
+ String name = partName.getName();
+ Matcher matcher = namePattern.matcher(name);
+ if (matcher.matches()) {
+ result.add(part);
+ }
+ }
+ return result;
+ }
+
/**
* Get the target part from the specified relationship.
*
import java.text.ParsePosition;
import java.text.SimpleDateFormat;
import java.util.Date;
-import java.util.Locale;
+
import java.util.TimeZone;
import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
--- /dev/null
+/* ====================================================================\r
+ Licensed to the Apache Software Foundation (ASF) under one or more\r
+ contributor license agreements. See the NOTICE file distributed with\r
+ this work for additional information regarding copyright ownership.\r
+ The ASF licenses this file to You under the Apache License, Version 2.0\r
+ (the "License"); you may not use this file except in compliance with\r
+ the License. You may obtain a copy of the License at\r
+\r
+ http://www.apache.org/licenses/LICENSE-2.0\r
+\r
+ Unless required by applicable law or agreed to in writing, software\r
+ distributed under the License is distributed on an "AS IS" BASIS,\r
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ See the License for the specific language governing permissions and\r
+ limitations under the License.\r
+==================================================================== */\r
+package org.apache.poi.util;\r
+\r
+import java.util.LinkedList;\r
+import java.util.ListIterator;\r
+\r
+/**\r
+ * <p>\r
+ * 24.08.2009<br>\r
+ * </p>\r
+ * \r
+ * @author Stefan Stern<br>\r
+ */\r
+\r
+public class IdentifierManager {\r
+\r
+ public static final long MAX_ID = Long.MAX_VALUE - 1;\r
+\r
+ public static final long MIN_ID = 0L;\r
+\r
+ /**\r
+ * \r
+ */\r
+ private final long upperbound;\r
+\r
+ /**\r
+ * \r
+ */\r
+ private final long lowerbound;\r
+\r
+ /**\r
+ * List of segments of available identifiers\r
+ */\r
+ private LinkedList<Segment> segments;\r
+\r
+ /**\r
+ * @param lowerbound the lower limit of the id-range to manage. Must be greater than or equal to {@link #MIN_ID}.\r
+ * @param upperbound the upper limit of the id-range to manage. Must be less then or equal {@link #MAX_ID}.\r
+ */\r
+ public IdentifierManager(long lowerbound, long upperbound) {\r
+ if (lowerbound > upperbound) {\r
+ String message = "lowerbound must not be greater than upperbound";\r
+ throw new IllegalArgumentException(message);\r
+ }\r
+ else if (lowerbound < MIN_ID) { \r
+ String message = "lowerbound must be greater than or equal to " + Long.toString(MIN_ID);\r
+ throw new IllegalArgumentException(message);\r
+ }\r
+ else if (upperbound > MAX_ID) {\r
+ /*\r
+ * while MAX_ID is Long.MAX_VALUE, this check is pointless. But if\r
+ * someone subclasses / tweaks the limits, this check if fine.\r
+ */\r
+ String message = "upperbound must be less thean or equal " + Long.toString(MAX_ID);\r
+ throw new IllegalArgumentException(message);\r
+ }\r
+ this.lowerbound = lowerbound;\r
+ this.upperbound = upperbound;\r
+ this.segments = new LinkedList<Segment>();\r
+ segments.add(new Segment(lowerbound, upperbound));\r
+ }\r
+\r
+ public long reserve(long id) {\r
+ if (id < lowerbound || id > upperbound) {\r
+ throw new IllegalArgumentException("Value for parameter 'id' was out of bounds");\r
+ }\r
+ verifyIdentifiersLeft();\r
+ \r
+ if (id == upperbound) {\r
+ Segment lastSegment = segments.getLast();\r
+ if (lastSegment.end == upperbound) {\r
+ lastSegment.end = upperbound - 1;\r
+ if (lastSegment.start > lastSegment.end) {\r
+ segments.removeLast();\r
+ }\r
+ return id;\r
+ }\r
+ return reserveNew();\r
+ }\r
+\r
+ if (id == lowerbound) {\r
+ Segment firstSegment = segments.getFirst();\r
+ if (firstSegment.start == lowerbound) {\r
+ firstSegment.start = lowerbound + 1;\r
+ if (firstSegment.end < firstSegment.start) {\r
+ segments.removeFirst();\r
+ }\r
+ return id;\r
+ }\r
+ return reserveNew();\r
+ }\r
+\r
+ ListIterator<Segment> iter = segments.listIterator();\r
+ while (iter.hasNext()) {\r
+ Segment segment = iter.next();\r
+ if (segment.end < id) {\r
+ continue;\r
+ }\r
+ else if (segment.start > id) {\r
+ break;\r
+ }\r
+ else if (segment.start == id) {\r
+ segment.start = id + 1;\r
+ if (segment.end < segment.start) {\r
+ iter.remove();\r
+ }\r
+ return id;\r
+ }\r
+ else if (segment.end == id) {\r
+ segment.end = id - 1;\r
+ if (segment.start > segment.end) {\r
+ iter.remove();\r
+ }\r
+ return id;\r
+ }\r
+ else {\r
+ iter.add(new Segment(id + 1, segment.end));\r
+ segment.end = id - 1;\r
+ return id;\r
+ }\r
+ }\r
+ return reserveNew();\r
+ }\r
+\r
+ /**\r
+ * @return a new identifier. \r
+ * @throws IllegalStateException if no more identifiers are available, then an Exception is raised.\r
+ */\r
+ public long reserveNew() {\r
+ verifyIdentifiersLeft();\r
+ Segment segment = segments.getFirst();\r
+ long result = segment.start;\r
+ segment.start += 1;\r
+ if (segment.start > segment.end) {\r
+ segments.removeFirst();\r
+ }\r
+ return result;\r
+ }\r
+\r
+ /**\r
+ * @param id\r
+ * the identifier to release. Must be greater than or equal to\r
+ * {@link #lowerbound} and must be less than or equal to {@link #upperbound}\r
+ * @return true, if the identifier was reserved and has been successfully\r
+ * released, false, if the identifier was not reserved.\r
+ */\r
+ public boolean release(long id) {\r
+ if (id < lowerbound || id > upperbound) {\r
+ throw new IllegalArgumentException("Value for parameter 'id' was out of bounds");\r
+ }\r
+\r
+ if (id == upperbound) {\r
+ Segment lastSegment = segments.getLast();\r
+ if (lastSegment.end == upperbound - 1) {\r
+ lastSegment.end = upperbound;\r
+ return true;\r
+ } else if (lastSegment.end == upperbound) {\r
+ return false;\r
+ } else {\r
+ segments.add(new Segment(upperbound, upperbound));\r
+ return true;\r
+ }\r
+ }\r
+\r
+ if (id == lowerbound) {\r
+ Segment firstSegment = segments.getFirst();\r
+ if (firstSegment.start == lowerbound + 1) {\r
+ firstSegment.start = lowerbound;\r
+ return true;\r
+ } else if (firstSegment.start == lowerbound) {\r
+ return false;\r
+ } else {\r
+ segments.addFirst(new Segment(lowerbound, lowerbound));\r
+ return true;\r
+ }\r
+ }\r
+\r
+ long higher = id + 1;\r
+ long lower = id - 1;\r
+ ListIterator<Segment> iter = segments.listIterator();\r
+\r
+ while (iter.hasNext()) {\r
+ Segment segment = iter.next();\r
+ if (segment.end < lower) {\r
+ continue;\r
+ }\r
+ if (segment.start > higher) {\r
+ iter.previous();\r
+ iter.add(new Segment(id, id));\r
+ return true;\r
+ }\r
+ if (segment.start == higher) {\r
+ segment.start = id;\r
+ return true;\r
+ }\r
+ else if (segment.end == lower) {\r
+ segment.end = id;\r
+ /* check if releasing this elements glues two segments into one */\r
+ if (iter.hasNext()) {\r
+ Segment next = iter.next();\r
+ if (next.start == segment.end + 1) {\r
+ segment.end = next.end;\r
+ iter.remove();\r
+ }\r
+ }\r
+ return true;\r
+ }\r
+ else {\r
+ /* id was not reserved, return false */\r
+ break;\r
+ }\r
+ }\r
+ return false;\r
+ }\r
+\r
+ public long getRemainingIdentifiers() {\r
+ long result = 0;\r
+ for (Segment segment : segments) {\r
+ result = result - segment.start;\r
+ result = result + segment.end + 1;\r
+ }\r
+ return result;\r
+ }\r
+\r
+ /**\r
+ * \r
+ */\r
+ private void verifyIdentifiersLeft() {\r
+ if (segments.isEmpty()) {\r
+ throw new IllegalStateException("No identifiers left");\r
+ }\r
+ }\r
+\r
+ private static class Segment {\r
+\r
+ public Segment(long start, long end) {\r
+ this.start = start;\r
+ this.end = end;\r
+ }\r
+\r
+ public long start;\r
+ public long end;\r
+\r
+ /*\r
+ * (non-Javadoc)\r
+ * \r
+ * @see java.lang.Object#toString()\r
+ */\r
+ public String toString() {\r
+ return "[" + start + "; " + end + "]";\r
+ }\r
+ }\r
+}\r
XSSFPictureData data = wb.getAllPictures().get(pictureIndex);
PackagePartName ppName = data.getPackagePart().getPartName();
PackageRelationship rel = getPackagePart().addRelationship(ppName, TargetMode.INTERNAL, XSSFRelation.IMAGES.getRelation());
- addRelation(new XSSFPictureData(data.getPackagePart(), rel));
+ addRelation(rel.getId(),new XSSFPictureData(data.getPackagePart(), rel));
return rel;
}
import java.util.Map;
import org.apache.poi.POIXMLDocumentPart;
-import org.apache.poi.openxml4j.opc.PackagePart;
import org.apache.poi.xwpf.usermodel.XWPFDocument;
import org.apache.poi.xwpf.usermodel.XWPFFactory;
import org.apache.poi.xwpf.usermodel.XWPFFooter;
* the right headers and footers for the document.
*/
public class XWPFHeaderFooterPolicy {
- public static final Enum DEFAULT = STHdrFtr.DEFAULT;
- public static final Enum EVEN = STHdrFtr.EVEN;
- public static final Enum FIRST = STHdrFtr.FIRST;
-
- private XWPFDocument doc;
-
- private XWPFHeader firstPageHeader;
- private XWPFFooter firstPageFooter;
-
- private XWPFHeader evenPageHeader;
- private XWPFFooter evenPageFooter;
-
- private XWPFHeader defaultHeader;
- private XWPFFooter defaultFooter;
-
- /**
- * Figures out the policy for the given document,
- * and creates any header and footer objects
- * as required.
- */
- public XWPFHeaderFooterPolicy(XWPFDocument doc) throws IOException, XmlException {
- this(doc, doc.getDocument().getBody().getSectPr());
- }
+ public static final Enum DEFAULT = STHdrFtr.DEFAULT;
+ public static final Enum EVEN = STHdrFtr.EVEN;
+ public static final Enum FIRST = STHdrFtr.FIRST;
- /**
- * Figures out the policy for the given document,
- * and creates any header and footer objects
- * as required.
- */
- public XWPFHeaderFooterPolicy(XWPFDocument doc, CTSectPr sectPr) throws IOException, XmlException {
- // Grab what headers and footers have been defined
- // For now, we don't care about different ranges, as it
- // doesn't seem that .docx properly supports that
- // feature of the file format yet
- this.doc = doc;
- for(int i=0; i<sectPr.sizeOfHeaderReferenceArray(); i++) {
- // Get the header
- CTHdrFtrRef ref = sectPr.getHeaderReferenceArray(i);
- PackagePart hdrPart = doc.getPartById(ref.getId());
+ private XWPFDocument doc;
- XWPFHeader hdr = null;
+ private XWPFHeader firstPageHeader;
+ private XWPFFooter firstPageFooter;
+
+ private XWPFHeader evenPageHeader;
+ private XWPFFooter evenPageFooter;
- for (POIXMLDocumentPart part : doc.getRelations()) {
- if (part.getPackagePart().getPartName().equals(hdrPart.getPartName())) {
- hdr = (XWPFHeader) part;
- }
+ private XWPFHeader defaultHeader;
+ private XWPFFooter defaultFooter;
+
+ /**
+ * Figures out the policy for the given document,
+ * and creates any header and footer objects
+ * as required.
+ */
+ public XWPFHeaderFooterPolicy(XWPFDocument doc) throws IOException, XmlException {
+ this(doc, doc.getDocument().getBody().getSectPr());
+ }
+
+ /**
+ * Figures out the policy for the given document,
+ * and creates any header and footer objects
+ * as required.
+ */
+ public XWPFHeaderFooterPolicy(XWPFDocument doc, CTSectPr sectPr) throws IOException, XmlException {
+ // Grab what headers and footers have been defined
+ // For now, we don't care about different ranges, as it
+ // doesn't seem that .docx properly supports that
+ // feature of the file format yet
+ this.doc = doc;
+ for(int i=0; i<sectPr.sizeOfHeaderReferenceArray(); i++) {
+ // Get the header
+ CTHdrFtrRef ref = sectPr.getHeaderReferenceArray(i);
+ POIXMLDocumentPart relatedPart = doc.getRelationById(ref.getId());
+ XWPFHeader hdr = null;
+ if (relatedPart != null && relatedPart instanceof XWPFHeader) {
+ hdr = (XWPFHeader) relatedPart;
+ }
+ // Assign it
+ Enum type = ref.getType();
+ assignHeader(hdr, type);
+ }
+ for(int i=0; i<sectPr.sizeOfFooterReferenceArray(); i++) {
+ // Get the footer
+ CTHdrFtrRef ref = sectPr.getFooterReferenceArray(i);
+ POIXMLDocumentPart relatedPart = doc.getRelationById(ref.getId());
+ XWPFFooter ftr = null;
+ if (relatedPart != null && relatedPart instanceof XWPFFooter)
+ {
+ ftr = (XWPFFooter) relatedPart;
}
+ // Assign it
+ Enum type = ref.getType();
+ assignFooter(ftr, type);
+ }
+ }
- // Assign it
- Enum type = ref.getType();
- assignHeader(hdr, type);
- }
- for(int i=0; i<sectPr.sizeOfFooterReferenceArray(); i++) {
- // Get the footer
- CTHdrFtrRef ref = sectPr.getFooterReferenceArray(i);
- PackagePart ftrPart = doc.getPartById(ref.getId());
- XWPFFooter ftr = new XWPFFooter(doc,
- FtrDocument.Factory.parse(ftrPart.getInputStream()).getFtr());
-
- // Assign it
- Enum type = ref.getType();
- assignFooter(ftr, type);
- }
- }
-
-
- private void assignFooter(XWPFFooter ftr, Enum type) {
- if(type == STHdrFtr.FIRST) {
- firstPageFooter = ftr;
- } else if(type == STHdrFtr.EVEN) {
- evenPageFooter = ftr;
- } else {
- defaultFooter = ftr;
- }
- }
-
-
- private void assignHeader(XWPFHeader hdr, Enum type) {
- if(type == STHdrFtr.FIRST) {
- firstPageHeader = hdr;
- } else if(type == STHdrFtr.EVEN) {
- evenPageHeader = hdr;
- } else {
- defaultHeader = hdr;
- }
- }
+ private void assignFooter(XWPFFooter ftr, Enum type) {
+ if(type == STHdrFtr.FIRST) {
+ firstPageFooter = ftr;
+ } else if(type == STHdrFtr.EVEN) {
+ evenPageFooter = ftr;
+ } else {
+ defaultFooter = ftr;
+ }
+ }
+
+ private void assignHeader(XWPFHeader hdr, Enum type) {
+ if(type == STHdrFtr.FIRST) {
+ firstPageHeader = hdr;
+ } else if(type == STHdrFtr.EVEN) {
+ evenPageHeader = hdr;
+ } else {
+ defaultHeader = hdr;
+ }
+ }
public XWPFHeader createHeader(Enum type) throws IOException {
- return createHeader(type, null);
+ return createHeader(type, null);
}
-
+
public XWPFHeader createHeader(Enum type, XWPFParagraph[] pars) throws IOException {
- XWPFRelation relation = XWPFRelation.HEADER;
- String pStyle = "Header";
- int i = getRelationIndex(relation);
- HdrDocument hdrDoc = HdrDocument.Factory.newInstance();
- XWPFHeader wrapper = (XWPFHeader)doc.createRelationship(relation, XWPFFactory.getInstance(), i);
-
- CTHdrFtr hdr = buildHdr(type, pStyle, wrapper, pars);
- wrapper.setHeaderFooter(hdr);
-
- OutputStream outputStream = wrapper.getPackagePart().getOutputStream();
- hdrDoc.setHdr(hdr);
-
+ XWPFRelation relation = XWPFRelation.HEADER;
+ String pStyle = "Header";
+ int i = getRelationIndex(relation);
+ HdrDocument hdrDoc = HdrDocument.Factory.newInstance();
+ XWPFHeader wrapper = (XWPFHeader)doc.createRelationship(relation, XWPFFactory.getInstance(), i);
+
+ CTHdrFtr hdr = buildHdr(type, pStyle, wrapper, pars);
+ wrapper.setHeaderFooter(hdr);
+
+ OutputStream outputStream = wrapper.getPackagePart().getOutputStream();
+ hdrDoc.setHdr(hdr);
+
XmlOptions xmlOptions = commit(wrapper);
- assignHeader(wrapper, type);
- hdrDoc.save(outputStream, xmlOptions);
- outputStream.close();
- return wrapper;
+ assignHeader(wrapper, type);
+ hdrDoc.save(outputStream, xmlOptions);
+ outputStream.close();
+ return wrapper;
}
-
-
public XWPFFooter createFooter(Enum type) throws IOException {
- return createFooter(type, null);
+ return createFooter(type, null);
}
-
+
public XWPFFooter createFooter(Enum type, XWPFParagraph[] pars) throws IOException {
- XWPFRelation relation = XWPFRelation.FOOTER;
- String pStyle = "Footer";
- int i = getRelationIndex(relation);
- FtrDocument ftrDoc = FtrDocument.Factory.newInstance();
- XWPFFooter wrapper = (XWPFFooter)doc.createRelationship(relation, XWPFFactory.getInstance(), i);
-
- CTHdrFtr ftr = buildFtr(type, pStyle, wrapper, pars);
- wrapper.setHeaderFooter(ftr);
-
- OutputStream outputStream = wrapper.getPackagePart().getOutputStream();
- ftrDoc.setFtr(ftr);
-
+ XWPFRelation relation = XWPFRelation.FOOTER;
+ String pStyle = "Footer";
+ int i = getRelationIndex(relation);
+ FtrDocument ftrDoc = FtrDocument.Factory.newInstance();
+ XWPFFooter wrapper = (XWPFFooter)doc.createRelationship(relation, XWPFFactory.getInstance(), i);
+
+ CTHdrFtr ftr = buildFtr(type, pStyle, wrapper, pars);
+ wrapper.setHeaderFooter(ftr);
+
+ OutputStream outputStream = wrapper.getPackagePart().getOutputStream();
+ ftrDoc.setFtr(ftr);
+
XmlOptions xmlOptions = commit(wrapper);
- assignFooter(wrapper, type);
- ftrDoc.save(outputStream, xmlOptions);
- outputStream.close();
- return wrapper;
+ assignFooter(wrapper, type);
+ ftrDoc.save(outputStream, xmlOptions);
+ outputStream.close();
+ return wrapper;
+ }
+
+ private int getRelationIndex(XWPFRelation relation) {
+ List<POIXMLDocumentPart> relations = doc.getRelations();
+ int i = 1;
+ for (Iterator<POIXMLDocumentPart> it = relations.iterator(); it.hasNext() ; ) {
+ POIXMLDocumentPart item = it.next();
+ if (item.getPackageRelationship().getRelationshipType().equals(relation.getRelation())) {
+ i++;
+ }
+ }
+ return i;
+ }
+
+ private CTHdrFtr buildFtr(Enum type, String pStyle, XWPFHeaderFooter wrapper, XWPFParagraph[] pars) {
+ //CTHdrFtr ftr = buildHdrFtr(pStyle, pars); // MB 24 May 2010
+ CTHdrFtr ftr = buildHdrFtr(pStyle, pars, wrapper); // MB 24 May 2010
+ setFooterReference(type, wrapper);
+ return ftr;
+ }
+
+ private CTHdrFtr buildHdr(Enum type, String pStyle, XWPFHeaderFooter wrapper, XWPFParagraph[] pars) {
+ //CTHdrFtr hdr = buildHdrFtr(pStyle, pars); // MB 24 May 2010
+ CTHdrFtr hdr = buildHdrFtr(pStyle, pars, wrapper); // MB 24 May 2010
+ setHeaderReference(type, wrapper);
+ return hdr;
+ }
+
+ private CTHdrFtr buildHdrFtr(String pStyle, XWPFParagraph[] paragraphs) {
+ CTHdrFtr ftr = CTHdrFtr.Factory.newInstance();
+ if (paragraphs != null) {
+ for (int i = 0 ; i < paragraphs.length ; i++) {
+ CTP p = ftr.addNewP();
+ //ftr.setPArray(0, paragraphs[i].getCTP()); // MB 23 May 2010
+ ftr.setPArray(i, paragraphs[i].getCTP()); // MB 23 May 2010
+ }
+ }
+ else {
+ CTP p = ftr.addNewP();
+ byte[] rsidr = doc.getDocument().getBody().getPArray(0).getRsidR();
+ byte[] rsidrdefault = doc.getDocument().getBody().getPArray(0).getRsidRDefault();
+ p.setRsidP(rsidr);
+ p.setRsidRDefault(rsidrdefault);
+ CTPPr pPr = p.addNewPPr();
+ pPr.addNewPStyle().setVal(pStyle);
+ }
+ return ftr;
+ }
+
+ /**
+ * MB 24 May 2010. Created this overloaded buildHdrFtr() method because testing demonstrated
+ * that the XWPFFooter or XWPFHeader object returned by calls to the createHeader(int, XWPFParagraph[])
+ * and createFooter(int, XWPFParagraph[]) methods or the getXXXXXHeader/Footer methods where
+ * headers or footers had been added to a document since it had been created/opened, returned
+ * an object that contained no XWPFParagraph objects even if the header/footer itself did contain
+ * text. The reason was that this line of code; CTHdrFtr ftr = CTHdrFtr.Factory.newInstance();
+ * created a brand new instance of the CTHDRFtr class which was then populated with data when
+ * it should have recovered the CTHdrFtr object encapsulated within the XWPFHeaderFooter object
+ * that had previoulsy been instantiated in the createHeader(int, XWPFParagraph[]) or
+ * createFooter(int, XWPFParagraph[]) methods.
+ */
+ private CTHdrFtr buildHdrFtr(String pStyle, XWPFParagraph[] paragraphs, XWPFHeaderFooter wrapper) {
+ CTHdrFtr ftr = wrapper._getHdrFtr();
+ if (paragraphs != null) {
+ for (int i = 0 ; i < paragraphs.length ; i++) {
+ CTP p = ftr.addNewP();
+ ftr.setPArray(i, paragraphs[i].getCTP());
+ }
+ }
+ else {
+ CTP p = ftr.addNewP();
+ byte[] rsidr = doc.getDocument().getBody().getPArray(0).getRsidR();
+ byte[] rsidrdefault = doc.getDocument().getBody().getPArray(0).getRsidRDefault();
+ p.setRsidP(rsidr);
+ p.setRsidRDefault(rsidrdefault);
+ CTPPr pPr = p.addNewPPr();
+ pPr.addNewPStyle().setVal(pStyle);
+ }
+ return ftr;
+ }
+
+
+ private void setFooterReference(Enum type, XWPFHeaderFooter wrapper) {
+ CTHdrFtrRef ref = doc.getDocument().getBody().getSectPr().addNewFooterReference();
+ ref.setType(type);
+ ref.setId(wrapper.getPackageRelationship().getId());
}
- private int getRelationIndex(XWPFRelation relation) {
- List<POIXMLDocumentPart> relations = doc.getRelations();
- int i = 1;
- for (Iterator<POIXMLDocumentPart> it = relations.iterator(); it.hasNext() ; ) {
- POIXMLDocumentPart item = it.next();
- if (item.getPackageRelationship().getRelationshipType().equals(relation.getRelation())) {
- i++;
- }
- }
- return i;
- }
-
-
- private CTHdrFtr buildFtr(Enum type, String pStyle, XWPFHeaderFooter wrapper, XWPFParagraph[] pars) {
- //CTHdrFtr ftr = buildHdrFtr(pStyle, pars); // MB 24 May 2010
- CTHdrFtr ftr = buildHdrFtr(pStyle, pars, wrapper); // MB 24 May 2010
- setFooterReference(type, wrapper);
- return ftr;
- }
-
-
- private CTHdrFtr buildHdr(Enum type, String pStyle, XWPFHeaderFooter wrapper, XWPFParagraph[] pars) {
- //CTHdrFtr hdr = buildHdrFtr(pStyle, pars); // MB 24 May 2010
- CTHdrFtr hdr = buildHdrFtr(pStyle, pars, wrapper); // MB 24 May 2010
- setHeaderReference(type, wrapper);
- return hdr;
- }
-
- private CTHdrFtr buildHdrFtr(String pStyle, XWPFParagraph[] paragraphs) {
- CTHdrFtr ftr = CTHdrFtr.Factory.newInstance();
- if (paragraphs != null) {
- for (int i = 0 ; i < paragraphs.length ; i++) {
- CTP p = ftr.addNewP();
- //ftr.setPArray(0, paragraphs[i].getCTP()); // MB 23 May 2010
- ftr.setPArray(i, paragraphs[i].getCTP()); // MB 23 May 2010
- }
- }
- else {
- CTP p = ftr.addNewP();
- byte[] rsidr = doc.getDocument().getBody().getPArray(0).getRsidR();
- byte[] rsidrdefault = doc.getDocument().getBody().getPArray(0).getRsidRDefault();
- p.setRsidP(rsidr);
- p.setRsidRDefault(rsidrdefault);
- CTPPr pPr = p.addNewPPr();
- pPr.addNewPStyle().setVal(pStyle);
- }
- return ftr;
- }
-
- /**
- * MB 24 May 2010. Created this overloaded buildHdrFtr() method because testing demonstrated
- * that the XWPFFooter or XWPFHeader object returned by calls to the createHeader(int, XWPFParagraph[])
- * and createFooter(int, XWPFParagraph[]) methods or the getXXXXXHeader/Footer methods where
- * headers or footers had been added to a document since it had been created/opened, returned
- * an object that contained no XWPFParagraph objects even if the header/footer itself did contain
- * text. The reason was that this line of code; CTHdrFtr ftr = CTHdrFtr.Factory.newInstance();
- * created a brand new instance of the CTHDRFtr class which was then populated with data when
- * it should have recovered the CTHdrFtr object encapsulated within the XWPFHeaderFooter object
- * that had previoulsy been instantiated in the createHeader(int, XWPFParagraph[]) or
- * createFooter(int, XWPFParagraph[]) methods.
- */
- private CTHdrFtr buildHdrFtr(String pStyle, XWPFParagraph[] paragraphs, XWPFHeaderFooter wrapper) {
- CTHdrFtr ftr = wrapper._getHdrFtr();
- if (paragraphs != null) {
- for (int i = 0 ; i < paragraphs.length ; i++) {
- CTP p = ftr.addNewP();
- ftr.setPArray(i, paragraphs[i].getCTP());
- }
- }
- else {
- CTP p = ftr.addNewP();
- byte[] rsidr = doc.getDocument().getBody().getPArray(0).getRsidR();
- byte[] rsidrdefault = doc.getDocument().getBody().getPArray(0).getRsidRDefault();
- p.setRsidP(rsidr);
- p.setRsidRDefault(rsidrdefault);
- CTPPr pPr = p.addNewPPr();
- pPr.addNewPStyle().setVal(pStyle);
- }
- return ftr;
- }
-
-
- private void setFooterReference(Enum type, XWPFHeaderFooter wrapper) {
- CTHdrFtrRef ref = doc.getDocument().getBody().getSectPr().addNewFooterReference();
- ref.setType(type);
- ref.setId(wrapper.getPackageRelationship().getId());
- }
-
-
- private void setHeaderReference(Enum type, XWPFHeaderFooter wrapper) {
- CTHdrFtrRef ref = doc.getDocument().getBody().getSectPr().addNewHeaderReference();
- ref.setType(type);
- ref.setId(wrapper.getPackageRelationship().getId());
- }
-
-
- private XmlOptions commit(XWPFHeaderFooter wrapper) {
- XmlOptions xmlOptions = new XmlOptions(wrapper.DEFAULT_XML_OPTIONS);
+ private void setHeaderReference(Enum type, XWPFHeaderFooter wrapper) {
+ CTHdrFtrRef ref = doc.getDocument().getBody().getSectPr().addNewHeaderReference();
+ ref.setType(type);
+ ref.setId(wrapper.getPackageRelationship().getId());
+ }
+
+
+ private XmlOptions commit(XWPFHeaderFooter wrapper) {
+ XmlOptions xmlOptions = new XmlOptions(wrapper.DEFAULT_XML_OPTIONS);
Map<String, String> map = new HashMap<String, String>();
map.put("http://schemas.openxmlformats.org/officeDocument/2006/math", "m");
map.put("urn:schemas-microsoft-com:office:office", "o");
map.put("http://schemas.microsoft.com/office/word/2006/wordml", "wne");
map.put("http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing", "wp");
xmlOptions.setSaveSuggestedPrefixes(map);
- return xmlOptions;
- }
-
- public XWPFHeader getFirstPageHeader() {
- return firstPageHeader;
- }
- public XWPFFooter getFirstPageFooter() {
- return firstPageFooter;
- }
- /**
- * Returns the odd page header. This is
- * also the same as the default one...
- */
- public XWPFHeader getOddPageHeader() {
- return defaultHeader;
- }
- /**
- * Returns the odd page footer. This is
- * also the same as the default one...
- */
- public XWPFFooter getOddPageFooter() {
- return defaultFooter;
- }
- public XWPFHeader getEvenPageHeader() {
- return evenPageHeader;
- }
- public XWPFFooter getEvenPageFooter() {
- return evenPageFooter;
- }
- public XWPFHeader getDefaultHeader() {
- return defaultHeader;
- }
- public XWPFFooter getDefaultFooter() {
- return defaultFooter;
- }
-
- /**
- * Get the header that applies to the given
- * (1 based) page.
- * @param pageNumber The one based page number
- */
- public XWPFHeader getHeader(int pageNumber) {
- if(pageNumber == 1 && firstPageHeader != null) {
- return firstPageHeader;
- }
- if(pageNumber % 2 == 0 && evenPageHeader != null) {
- return evenPageHeader;
- }
- return defaultHeader;
- }
- /**
- * Get the footer that applies to the given
- * (1 based) page.
- * @param pageNumber The one based page number
- */
- public XWPFFooter getFooter(int pageNumber) {
- if(pageNumber == 1 && firstPageFooter != null) {
- return firstPageFooter;
- }
- if(pageNumber % 2 == 0 && evenPageFooter != null) {
- return evenPageFooter;
- }
- return defaultFooter;
- }
-
-
- public void createWatermark(String text) {
- XWPFParagraph[] pars = new XWPFParagraph[1];
- try {
- pars[0] = getWatermarkParagraph(text, 1);
- createHeader(DEFAULT, pars);
- pars[0] = getWatermarkParagraph(text, 2);
- createHeader(FIRST, pars);
- pars[0] = getWatermarkParagraph(text, 3);
- createHeader(EVEN, pars);
- } catch (IOException e) {
- // TODO Auto-generated catch block
- e.printStackTrace();
- }
- }
-
-
- /*
- * This is the default Watermark paragraph; the only variable is the text message
- * TODO: manage all the other variables
- */
- private XWPFParagraph getWatermarkParagraph(String text, int idx) {
- CTP p = CTP.Factory.newInstance();
- byte[] rsidr = doc.getDocument().getBody().getPArray(0).getRsidR();
- byte[] rsidrdefault = doc.getDocument().getBody().getPArray(0).getRsidRDefault();
- p.setRsidP(rsidr);
- p.setRsidRDefault(rsidrdefault);
- CTPPr pPr = p.addNewPPr();
- pPr.addNewPStyle().setVal("Header");
- // start watermark paragraph
- CTR r = p.addNewR();
- CTRPr rPr = r.addNewRPr();
- rPr.addNewNoProof();
- CTPicture pict = r.addNewPict();
- CTGroup group = CTGroup.Factory.newInstance();
- CTShapetype shapetype = group.addNewShapetype();
- shapetype.setId("_x0000_t136");
- shapetype.setCoordsize("1600,21600");
- shapetype.setSpt(136);
- shapetype.setAdj("10800");
- shapetype.setPath2("m@7,0l@8,0m@5,21600l@6,21600e");
- CTFormulas formulas = shapetype.addNewFormulas();
- formulas.addNewF().setEqn("sum #0 0 10800");
- formulas.addNewF().setEqn("prod #0 2 1");
- formulas.addNewF().setEqn("sum 21600 0 @1");
- formulas.addNewF().setEqn("sum 0 0 @2");
- formulas.addNewF().setEqn("sum 21600 0 @3");
- formulas.addNewF().setEqn("if @0 @3 0");
- formulas.addNewF().setEqn("if @0 21600 @1");
- formulas.addNewF().setEqn("if @0 0 @2");
- formulas.addNewF().setEqn("if @0 @4 21600");
- formulas.addNewF().setEqn("mid @5 @6");
- formulas.addNewF().setEqn("mid @8 @5");
- formulas.addNewF().setEqn("mid @7 @8");
- formulas.addNewF().setEqn("mid @6 @7");
- formulas.addNewF().setEqn("sum @6 0 @5");
- CTPath path = shapetype.addNewPath();
- path.setTextpathok(STTrueFalse.T);
- path.setConnecttype(STConnectType.CUSTOM);
- path.setConnectlocs("@9,0;@10,10800;@11,21600;@12,10800");
- path.setConnectangles("270,180,90,0");
- CTTextPath shapeTypeTextPath = shapetype.addNewTextpath();
- shapeTypeTextPath.setOn(STTrueFalse.T);
- shapeTypeTextPath.setFitshape(STTrueFalse.T);
- CTHandles handles = shapetype.addNewHandles();
- CTH h = handles.addNewH();
- h.setPosition("#0,bottomRight");
- h.setXrange("6629,14971");
- CTLock lock = shapetype.addNewLock();
- lock.setExt(STExt.EDIT);
- CTShape shape = group.addNewShape();
- shape.setId("PowerPlusWaterMarkObject" + idx);
- shape.setSpid("_x0000_s102" + (4+idx));
- shape.setType("#_x0000_t136");
- shape.setStyle("position:absolute;margin-left:0;margin-top:0;width:415pt;height:207.5pt;z-index:-251654144;mso-wrap-edited:f;mso-position-horizontal:center;mso-position-horizontal-relative:margin;mso-position-vertical:center;mso-position-vertical-relative:margin");
- shape.setWrapcoords("616 5068 390 16297 39 16921 -39 17155 7265 17545 7186 17467 -39 17467 18904 17467 10507 17467 8710 17545 18904 17077 18787 16843 18358 16297 18279 12554 19178 12476 20701 11774 20779 11228 21131 10059 21248 8811 21248 7563 20975 6316 20935 5380 19490 5146 14022 5068 2616 5068");
- shape.setFillcolor("black");
- shape.setStroked(STTrueFalse.FALSE);
- CTTextPath shapeTextPath = shape.addNewTextpath();
- shapeTextPath.setStyle("font-family:"Cambria";font-size:1pt");
- shapeTextPath.setString(text);
- pict.set(group);
- // end watermark paragraph
- return new XWPFParagraph(p, doc);
- }
+ return xmlOptions;
+ }
+
+ public XWPFHeader getFirstPageHeader() {
+ return firstPageHeader;
+ }
+ public XWPFFooter getFirstPageFooter() {
+ return firstPageFooter;
+ }
+ /**
+ * Returns the odd page header. This is
+ * also the same as the default one...
+ */
+ public XWPFHeader getOddPageHeader() {
+ return defaultHeader;
+ }
+ /**
+ * Returns the odd page footer. This is
+ * also the same as the default one...
+ */
+ public XWPFFooter getOddPageFooter() {
+ return defaultFooter;
+ }
+ public XWPFHeader getEvenPageHeader() {
+ return evenPageHeader;
+ }
+ public XWPFFooter getEvenPageFooter() {
+ return evenPageFooter;
+ }
+ public XWPFHeader getDefaultHeader() {
+ return defaultHeader;
+ }
+ public XWPFFooter getDefaultFooter() {
+ return defaultFooter;
+ }
+
+ /**
+ * Get the header that applies to the given
+ * (1 based) page.
+ * @param pageNumber The one based page number
+ */
+ public XWPFHeader getHeader(int pageNumber) {
+ if(pageNumber == 1 && firstPageHeader != null) {
+ return firstPageHeader;
+ }
+ if(pageNumber % 2 == 0 && evenPageHeader != null) {
+ return evenPageHeader;
+ }
+ return defaultHeader;
+ }
+ /**
+ * Get the footer that applies to the given
+ * (1 based) page.
+ * @param pageNumber The one based page number
+ */
+ public XWPFFooter getFooter(int pageNumber) {
+ if(pageNumber == 1 && firstPageFooter != null) {
+ return firstPageFooter;
+ }
+ if(pageNumber % 2 == 0 && evenPageFooter != null) {
+ return evenPageFooter;
+ }
+ return defaultFooter;
+ }
+
+ public void createWatermark(String text) {
+ XWPFParagraph[] pars = new XWPFParagraph[1];
+ try {
+ pars[0] = getWatermarkParagraph(text, 1);
+ createHeader(DEFAULT, pars);
+ pars[0] = getWatermarkParagraph(text, 2);
+ createHeader(FIRST, pars);
+ pars[0] = getWatermarkParagraph(text, 3);
+ createHeader(EVEN, pars);
+ } catch (IOException e) {
+ // TODO Auto-generated catch block
+ e.printStackTrace();
+ }
+ }
+
+ /*
+ * This is the default Watermark paragraph; the only variable is the text message
+ * TODO: manage all the other variables
+ */
+ private XWPFParagraph getWatermarkParagraph(String text, int idx) {
+ CTP p = CTP.Factory.newInstance();
+ byte[] rsidr = doc.getDocument().getBody().getPArray(0).getRsidR();
+ byte[] rsidrdefault = doc.getDocument().getBody().getPArray(0).getRsidRDefault();
+ p.setRsidP(rsidr);
+ p.setRsidRDefault(rsidrdefault);
+ CTPPr pPr = p.addNewPPr();
+ pPr.addNewPStyle().setVal("Header");
+ // start watermark paragraph
+ CTR r = p.addNewR();
+ CTRPr rPr = r.addNewRPr();
+ rPr.addNewNoProof();
+ CTPicture pict = r.addNewPict();
+ CTGroup group = CTGroup.Factory.newInstance();
+ CTShapetype shapetype = group.addNewShapetype();
+ shapetype.setId("_x0000_t136");
+ shapetype.setCoordsize("1600,21600");
+ shapetype.setSpt(136);
+ shapetype.setAdj("10800");
+ shapetype.setPath2("m@7,0l@8,0m@5,21600l@6,21600e");
+ CTFormulas formulas = shapetype.addNewFormulas();
+ formulas.addNewF().setEqn("sum #0 0 10800");
+ formulas.addNewF().setEqn("prod #0 2 1");
+ formulas.addNewF().setEqn("sum 21600 0 @1");
+ formulas.addNewF().setEqn("sum 0 0 @2");
+ formulas.addNewF().setEqn("sum 21600 0 @3");
+ formulas.addNewF().setEqn("if @0 @3 0");
+ formulas.addNewF().setEqn("if @0 21600 @1");
+ formulas.addNewF().setEqn("if @0 0 @2");
+ formulas.addNewF().setEqn("if @0 @4 21600");
+ formulas.addNewF().setEqn("mid @5 @6");
+ formulas.addNewF().setEqn("mid @8 @5");
+ formulas.addNewF().setEqn("mid @7 @8");
+ formulas.addNewF().setEqn("mid @6 @7");
+ formulas.addNewF().setEqn("sum @6 0 @5");
+ CTPath path = shapetype.addNewPath();
+ path.setTextpathok(STTrueFalse.T);
+ path.setConnecttype(STConnectType.CUSTOM);
+ path.setConnectlocs("@9,0;@10,10800;@11,21600;@12,10800");
+ path.setConnectangles("270,180,90,0");
+ CTTextPath shapeTypeTextPath = shapetype.addNewTextpath();
+ shapeTypeTextPath.setOn(STTrueFalse.T);
+ shapeTypeTextPath.setFitshape(STTrueFalse.T);
+ CTHandles handles = shapetype.addNewHandles();
+ CTH h = handles.addNewH();
+ h.setPosition("#0,bottomRight");
+ h.setXrange("6629,14971");
+ CTLock lock = shapetype.addNewLock();
+ lock.setExt(STExt.EDIT);
+ CTShape shape = group.addNewShape();
+ shape.setId("PowerPlusWaterMarkObject" + idx);
+ shape.setSpid("_x0000_s102" + (4+idx));
+ shape.setType("#_x0000_t136");
+ shape.setStyle("position:absolute;margin-left:0;margin-top:0;width:415pt;height:207.5pt;z-index:-251654144;mso-wrap-edited:f;mso-position-horizontal:center;mso-position-horizontal-relative:margin;mso-position-vertical:center;mso-position-vertical-relative:margin");
+ shape.setWrapcoords("616 5068 390 16297 39 16921 -39 17155 7265 17545 7186 17467 -39 17467 18904 17467 10507 17467 8710 17545 18904 17077 18787 16843 18358 16297 18279 12554 19178 12476 20701 11774 20779 11228 21131 10059 21248 8811 21248 7563 20975 6316 20935 5380 19490 5146 14022 5068 2616 5068");
+ shape.setFillcolor("black");
+ shape.setStroked(STTrueFalse.FALSE);
+ CTTextPath shapeTextPath = shape.addNewTextpath();
+ shapeTextPath.setStyle("font-family:"Cambria";font-size:1pt");
+ shapeTextPath.setString(text);
+ pict.set(group);
+ // end watermark paragraph
+ return new XWPFParagraph(p, doc);
+ }
}
import java.util.List;
+import org.apache.poi.POIXMLDocumentPart;
import org.apache.xmlbeans.XmlCursor;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl;
* belongs.
* @return the Part, to which the body belongs
*/
- IBody getPart();
+ POIXMLDocumentPart getPart();
/**
* get the PartType of the body, for example
package org.apache.poi.xwpf.usermodel;
+import org.apache.poi.POIXMLDocumentPart;
/**
* 9 Jan 2010
*
*/
public interface IBodyElement{
- IBody getPart();
+ IBody getBody();
+ POIXMLDocumentPart getPart();
BodyType getPartType();
BodyElementType getElementType();
}
==================================================================== */
package org.apache.poi.xwpf.usermodel;
-import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.ArrayList;
+import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import org.apache.poi.POIXMLDocumentPart;
import org.apache.poi.POIXMLException;
import org.apache.poi.POIXMLProperties;
+import org.apache.poi.POIXMLRelation;
import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
import org.apache.poi.openxml4j.exceptions.OpenXML4JException;
import org.apache.poi.openxml4j.opc.OPCPackage;
import org.apache.poi.openxml4j.opc.PackagingURIHelper;
import org.apache.poi.openxml4j.opc.TargetMode;
import org.apache.poi.util.IOUtils;
+import org.apache.poi.util.IdentifierManager;
import org.apache.poi.util.Internal;
import org.apache.poi.util.PackageHelper;
import org.apache.poi.xwpf.model.XWPFHeaderFooterPolicy;
private CTDocument1 ctDocument;
private XWPFSettings settings;
- protected List<XWPFFooter> footers;
- protected List <XWPFHeader> headers;
- protected List<XWPFComment> comments;
- protected List<XWPFHyperlink> hyperlinks;
- protected List<XWPFParagraph> paragraphs;
- protected List<XWPFTable> tables;
- protected List<IBodyElement> bodyElements;
- protected List<XWPFPictureData> pictures;
- protected Map<Integer, XWPFFootnote> footnotes;
- protected Map<Integer, XWPFFootnote> endnotes;
+ /**
+ * Keeps track on all id-values used in this document and included parts, like headers, footers, etc.
+ */
+ private IdentifierManager drawingIdManager = new IdentifierManager(1L,4294967295L);
+ protected List<XWPFFooter> footers = new ArrayList<XWPFFooter>();
+ protected List<XWPFHeader> headers = new ArrayList<XWPFHeader>();
+ protected List<XWPFComment> comments = new ArrayList<XWPFComment>();
+ protected List<XWPFHyperlink> hyperlinks = new ArrayList<XWPFHyperlink>();
+ protected List<XWPFParagraph> paragraphs = new ArrayList<XWPFParagraph>();
+ protected List<XWPFTable> tables = new ArrayList<XWPFTable>();
+ protected List<IBodyElement> bodyElements = new ArrayList<IBodyElement>();
+ protected List<XWPFPictureData> pictures = new ArrayList<XWPFPictureData>();
+ protected Map<Long, List<XWPFPictureData>> packagePictures = new HashMap<Long, List<XWPFPictureData>>();
+ protected Map<Integer, XWPFFootnote> footnotes = new HashMap<Integer, XWPFFootnote>();
+ protected Map<Integer, XWPFFootnote> endnotes = new HashMap<Integer, XWPFFootnote>();
protected XWPFNumbering numbering;
protected XWPFStyles styles;
@Override
protected void onDocumentRead() throws IOException {
- hyperlinks = new ArrayList<XWPFHyperlink>();
- comments = new ArrayList<XWPFComment>();
- paragraphs = new ArrayList<XWPFParagraph>();
- tables= new ArrayList<XWPFTable>();
- bodyElements = new ArrayList<IBodyElement>();
- footers = new ArrayList<XWPFFooter>();
- headers = new ArrayList<XWPFHeader>();
- footnotes = new HashMap<Integer, XWPFFootnote>();
- endnotes = new HashMap<Integer, XWPFFootnote>();
-
try {
DocumentDocument doc = DocumentDocument.Factory.parse(getPackagePart().getInputStream());
ctDocument = doc.getDocument();
initFootnotes();
-
-
+
// parse the document with cursor and add
// the XmlObject to its lists
- XmlCursor cursor = ctDocument.getBody().newCursor();
+ XmlCursor cursor = ctDocument.getBody().newCursor();
cursor.selectPath("./*");
while (cursor.toNextSelection()) {
XmlObject o = cursor.getObject();
if (o instanceof CTP) {
- XWPFParagraph p = new XWPFParagraph((CTP)o, this);
- bodyElements.add(p);
- paragraphs.add(p);
- }
- if (o instanceof CTTbl) {
- XWPFTable t = new XWPFTable((CTTbl)o, this);
- bodyElements.add(t);
- tables.add(t);
+ XWPFParagraph p = new XWPFParagraph((CTP) o, this);
+ bodyElements.add(p);
+ paragraphs.add(p);
+ } else if (o instanceof CTTbl) {
+ XWPFTable t = new XWPFTable((CTTbl) o, this);
+ bodyElements.add(t);
+ tables.add(t);
}
}
cursor.dispose();
-
+
// Sort out headers and footers
- if (doc.getDocument().getBody().getSectPr() != null)
- headerFooterPolicy = new XWPFHeaderFooterPolicy(this);
-
- // Create for each XML-part in the Package a PartClass
- for(POIXMLDocumentPart p : getRelations()){
+ if (doc.getDocument().getBody().getSectPr() != null)
+ headerFooterPolicy = new XWPFHeaderFooterPolicy(this);
+
+ // Create for each XML-part in the Package a PartClass
+ for (POIXMLDocumentPart p : getRelations()) {
String relation = p.getPackageRelationship().getRelationshipType();
- if(relation.equals(XWPFRelation.STYLES.getRelation())){
- this.styles = (XWPFStyles) p;
- } else if (relation.equals(XWPFRelation.NUMBERING.getRelation())){
- this.numbering = (XWPFNumbering) p;
- } else if (relation.equals(XWPFRelation.FOOTER.getRelation())){
- footers.add((XWPFFooter)p);
- } else if (relation.equals(XWPFRelation.HEADER.getRelation())){
- headers.add((XWPFHeader)p);
- } else if (relation.equals(XWPFRelation.COMMENT.getRelation())){
+ if (relation.equals(XWPFRelation.STYLES.getRelation())) {
+ this.styles = (XWPFStyles) p;
+ this.styles.onDocumentRead();
+ } else if (relation.equals(XWPFRelation.NUMBERING.getRelation())) {
+ this.numbering = (XWPFNumbering) p;
+ this.numbering.onDocumentRead();
+ } else if (relation.equals(XWPFRelation.FOOTER.getRelation())) {
+ XWPFFooter footer = (XWPFFooter) p;
+ footers.add(footer);
+ footer.onDocumentRead();
+ } else if (relation.equals(XWPFRelation.HEADER.getRelation())) {
+ XWPFHeader header = (XWPFHeader) p;
+ headers.add(header);
+ header.onDocumentRead();
+ } else if (relation.equals(XWPFRelation.COMMENT.getRelation())) {
+ // TODO Create according XWPFComment class, extending POIXMLDocumentPart
CommentsDocument cmntdoc = CommentsDocument.Factory.parse(p.getPackagePart().getInputStream());
- for(CTComment ctcomment : cmntdoc.getComments().getCommentList()) {
+ for (CTComment ctcomment : cmntdoc.getComments().getCommentList()) {
comments.add(new XWPFComment(ctcomment, this));
}
- } else if (relation.equals(XWPFRelation.SETTINGS.getRelation())){
- settings = (XWPFSettings)p;
+ } else if (relation.equals(XWPFRelation.SETTINGS.getRelation())) {
+ settings = (XWPFSettings) p;
+ settings.onDocumentRead();
+ } else if (relation.equals(XWPFRelation.IMAGES.getRelation())) {
+ XWPFPictureData picData = (XWPFPictureData) p;
+ picData.onDocumentRead();
+ registerPackagePictureData(picData);
+ pictures.add(picData);
}
}
-
initHyperlinks();
} catch (XmlException e) {
throw new POIXMLException(e);
}
- // create for every Graphic-Part in Package a new XWPFGraphic
- getAllPictures();
}
private void initHyperlinks(){
// Get the hyperlinks
// TODO: make me optional/separated in private function
- try {
- Iterator
<PackageRelationship> relIter =
+ try {
+ Iterator<PackageRelationship> relIter =
getPackagePart().getRelationshipsByType(XWPFRelation.HYPERLINK.getRelation()).iterator();
while(relIter.hasNext()) {
PackageRelationship rel = relIter.next();
*/
@Override
protected void onDocumentCreate() {
- hyperlinks = new ArrayList<XWPFHyperlink>();
- comments = new ArrayList<XWPFComment>();
- paragraphs = new ArrayList<XWPFParagraph>();
- tables= new ArrayList<XWPFTable>();
- bodyElements = new ArrayList<IBodyElement>();
- footers = new ArrayList<XWPFFooter>();
- headers = new ArrayList<XWPFHeader>();
- footnotes = new HashMap<Integer, XWPFFootnote>();
- endnotes = new HashMap<Integer, XWPFFootnote>();
-
ctDocument = CTDocument1.Factory.newInstance();
ctDocument.addNewBody();
-
- settings = (XWPFSettings) createRelationship(XWPFRelation.SETTINGS, XWPFFactory.getInstance());
+
+ settings = (XWPFSettings) createRelationship(XWPFRelation.SETTINGS,XWPFFactory.getInstance());
POIXMLProperties.ExtendedProperties expProps = getProperties().getExtendedProperties();
expProps.getUnderlyingProperties().setApplication(DOCUMENT_CREATOR);
public CTDocument1 getDocument() {
return ctDocument;
}
+
+ IdentifierManager getDrawingIdManager() {
+ return drawingIdManager;
+ }
/**
* returns an Iterator with paragraphs and tables
public XWPFHyperlink getHyperlinkByID(String id) {
Iterator<XWPFHyperlink> iter = hyperlinks.iterator();
- while(iter.hasNext())
- {
+ while (iter.hasNext()) {
XWPFHyperlink link = iter.next();
if(link.getId().equals(id))
return link;
}
public XWPFHyperlink[] getHyperlinks() {
- return hyperlinks.toArray(
- new XWPFHyperlink[hyperlinks.size()]
- );
+ return hyperlinks.toArray(new XWPFHyperlink[hyperlinks.size()]);
}
public XWPFComment getCommentByID(String id) {
Iterator<XWPFComment> iter = comments.iterator();
- while(iter.hasNext())
- {
+ while (iter.hasNext()) {
XWPFComment comment = iter.next();
if(comment.getId().equals(id))
return comment;
return null;
}
+
public XWPFComment[] getComments() {
- return comments.toArray(
- new XWPFComment[comments.size()]
- );
+ return comments.toArray(new XWPFComment[comments.size()]);
}
/**
*/
public PackagePart getPartById(String id) {
try {
- return getTargetPart(
- getCorePart().getRelationship(id)
- );
- } catch(InvalidFormatException e) {
+ return getTargetPart(getCorePart().getRelationship(id));
+ } catch (InvalidFormatException e) {
throw new IllegalArgumentException(e);
}
}
throw new IllegalStateException("Expecting one Styles document part, but found " + parts.length);
}
- StylesDocument sd =
- StylesDocument.Factory.parse(parts[0].getInputStream());
+ StylesDocument sd = StylesDocument.Factory.parse(parts[0].getInputStream());
return sd.getStyles();
}
List<PackagePart> embedds = new LinkedList<PackagePart>();
// Get the embeddings for the workbook
- for(PackageRelationship rel : getPackagePart().getRelationshipsByType(OLE_OBJECT_REL_TYPE))
+ for (PackageRelationship rel : getPackagePart().getRelationshipsByType(OLE_OBJECT_REL_TYPE)) {
embedds.add(getTargetPart(rel));
+ }
- for(PackageRelationship rel : getPackagePart().getRelationshipsByType(PACK_OBJECT_REL_TYPE))
+ for (PackageRelationship rel : getPackagePart().getRelationshipsByType(PACK_OBJECT_REL_TYPE)) {
embedds.add(getTargetPart(rel));
+ }
return embedds;
}
-
+
/**
* Finds that for example the 2nd entry in the body list is the 1st paragraph
*/
if(list.size() == 0) {
return -1;
}
-
+
if(pos >= 0 && pos < bodyElements.size()) {
// Ensure the type is correct
IBodyElement needle = bodyElements.get(pos);
// Wrong type
return -1;
}
-
+
// Work back until we find it
int startPos = Math.min(pos, list.size()-1);
for(int i=startPos; i>=0; i--) {
}
/**
- * get with the position of a Paragraph in the bodyelement array list
- * the position of this paragraph in the paragraph array list
- * @param pos position of the paragraph in the bodyelement array list
- * @return if there is a paragraph at the position in the bodyelement array list,
- * else it will return -1
- *
+ * Look up the paragraph at the specified position in the body elemnts list
+ * and return this paragraphs position in the paragraphs list
+ *
+ * @param pos
+ * The position of the relevant paragraph in the body elements
+ * list
+ * @return the position of the paragraph in the paragraphs list, if there is
+ * a paragraph at the position in the bodyelements list. Else it
+ * will return -1
+ *
*/
- public int getParagraphPos(int pos){
+ public int getParagraphPos(int pos) {
return getBodyElementSpecificPos(pos, paragraphs);
}
-
+
/**
* get with the position of a table in the bodyelement array list
* the position of this table in the table array list
* @return if there is a table at the position in the bodyelement array list,
* else it will return null.
*/
- public int getTablePos(int pos){
+ public int getTablePos(int pos) {
return getBodyElementSpecificPos(pos, tables);
}
-
+
/**
- * add a new paragraph at position of the cursor
+ * add a new paragraph at position of the cursor. The cursor must be on the
+ * {@link TokenType#START} tag of an subelement of the documents body. When
+ * this method is done, the cursor passed as parameter points to the
+ * {@link TokenType#END} of the newly inserted paragraph.
+ *
* @param cursor
+ * @return the {@link XWPFParagraph} object representing the newly inserted
+ * CTP object
*/
- public XWPFParagraph insertNewParagraph(XmlCursor cursor){
- if(isCursorInBody(cursor)){
- String uri = CTP.type.getName().getNamespaceURI();
- String localPart = "p";
- cursor.beginElement(localPart,uri);
- cursor.toParent();
- CTP p = (CTP)cursor.getObject();
- XWPFParagraph newP = new XWPFParagraph(p, this);
- XmlObject o = null;
- while(!(o instanceof CTP)&&(cursor.toPrevSibling())){
- o = cursor.getObject();
- }
- if((!(o instanceof CTP)) || (CTP)o == p){
- paragraphs.add(0, newP);
- }
- else{
- int pos = paragraphs.indexOf(getParagraph((CTP)o))+1;
- paragraphs.add(pos,newP);
- }
- int i=0;
- cursor.toCursor(p.newCursor());
- while(cursor.toPrevSibling()){
- o =cursor.getObject();
- if(o instanceof CTP || o instanceof CTTbl)
- i++;
- }
- bodyElements.add(i, newP);
- cursor.toCursor(p.newCursor());
- cursor.toEndToken();
- return newP;
- }
- return null;
- }
-
- public XWPFTable insertNewTbl(XmlCursor cursor) {
- if(isCursorInBody(cursor)){
- String uri = CTTbl.type.getName().getNamespaceURI();
- String localPart ="tbl";
- cursor.beginElement(localPart,uri);
- cursor.toParent();
- CTTbl t = (CTTbl)cursor.getObject();
- XWPFTable newT = new XWPFTable(t, this);
- cursor.removeXmlContents();
- XmlObject o = null;
- while(!(o instanceof CTTbl)&&(cursor.toPrevSibling())){
- o = cursor.getObject();
- }
- if(!(o instanceof CTTbl)){
- tables.add(0, newT);
- }
- else{
- int pos = tables.indexOf(getTable((CTTbl)o))+1;
- tables.add(pos,newT);
- }
- int i=0;
- cursor = t.newCursor();
- while(cursor.toPrevSibling()){
- o =cursor.getObject();
- if(o instanceof CTP || o instanceof CTTbl)
- i++;
- }
- bodyElements.add(i, newT);
- cursor = t.newCursor();
- cursor.toEndToken();
- return newT;
- }
- return null;
- }
-
- /**
- * verifies that cursor is on the right position
- * @param cursor
- */
- private boolean isCursorInBody(XmlCursor cursor) {
- XmlCursor verify = cursor.newCursor();
- verify.toParent();
- if(verify.getObject() == this.ctDocument.getBody()){
- return true;
- }
- XmlObject o = verify.getObject();
- return false;
-
- }
-
+ public XWPFParagraph insertNewParagraph(XmlCursor cursor) {
+ if (isCursorInBody(cursor)) {
+ String uri = CTP.type.getName().getNamespaceURI();
+ /*
+ * TODO DO not use a coded constant, find the constant in the OOXML
+ * classes instead, as the child of type CT_Paragraph is defined in the
+ * OOXML schema as 'p'
+ */
+ String localPart = "p";
+ // creates a new Paragraph, cursor is positioned inside the new
+ // element
+ cursor.beginElement(localPart, uri);
+ // move the cursor to the START token to the paragraph just created
+ cursor.toParent();
+ CTP p = (CTP) cursor.getObject();
+ XWPFParagraph newP = new XWPFParagraph(p, this);
+ XmlObject o = null;
+ /*
+ * move the cursor to the previous element until a) the next
+ * paragraph is found or b) all elements have been passed
+ */
+ while (!(o instanceof CTP) && (cursor.toPrevSibling())) {
+ o = cursor.getObject();
+ }
+ /*
+ * if the object that has been found is a) not a paragraph or b) is
+ * the paragraph that has just been inserted, as the cursor in the
+ * while loop above was not moved as there were no other siblings,
+ * then the paragraph that was just inserted is the first paragraph
+ * in the body. Otherwise, take the previous paragraph and calculate
+ * the new index for the new paragraph.
+ */
+ if ((!(o instanceof CTP)) || (CTP) o == p) {
+ paragraphs.add(0, newP);
+ } else {
+ int pos = paragraphs.indexOf(getParagraph((CTP) o)) + 1;
+ paragraphs.add(pos, newP);
+ }
+
+ /*
+ * create a new cursor, that points to the START token of the just
+ * inserted paragraph
+ */
+ XmlCursor newParaPos = p.newCursor();
+ try {
+ /*
+ * Calculate the paragraphs index in the list of all body
+ * elements
+ */
+ int i = 0;
+ cursor.toCursor(newParaPos);
+ while (cursor.toPrevSibling()) {
+ o = cursor.getObject();
+ if (o instanceof CTP || o instanceof CTTbl)
+ i++;
+ }
+ bodyElements.add(i, newP);
+ cursor.toCursor(newParaPos);
+ cursor.toEndToken();
+ return newP;
+ } finally {
+ newParaPos.dispose();
+ }
+ }
+ return null;
+ }
+
+ public XWPFTable insertNewTbl(XmlCursor cursor) {
+ if (isCursorInBody(cursor)) {
+ String uri = CTTbl.type.getName().getNamespaceURI();
+ String localPart = "tbl";
+ cursor.beginElement(localPart, uri);
+ cursor.toParent();
+ CTTbl t = (CTTbl) cursor.getObject();
+ XWPFTable newT = new XWPFTable(t, this);
+ cursor.removeXmlContents();
+ XmlObject o = null;
+ while (!(o instanceof CTTbl) && (cursor.toPrevSibling())) {
+ o = cursor.getObject();
+ }
+ if (!(o instanceof CTTbl)) {
+ tables.add(0, newT);
+ } else {
+ int pos = tables.indexOf(getTable((CTTbl) o)) + 1;
+ tables.add(pos, newT);
+ }
+ int i = 0;
+ cursor = t.newCursor();
+ while (cursor.toPrevSibling()) {
+ o = cursor.getObject();
+ if (o instanceof CTP || o instanceof CTTbl)
+ i++;
+ }
+ bodyElements.add(i, newT);
+ cursor = t.newCursor();
+ cursor.toEndToken();
+ return newT;
+ }
+ return null;
+ }
+
+ /**
+ * verifies that cursor is on the right position
+ * @param cursor
+ */
+ private boolean isCursorInBody(XmlCursor cursor) {
+ XmlCursor verify = cursor.newCursor();
+ verify.toParent();
+ try {
+ return (verify.getObject() == this.ctDocument.getBody());
+ } finally {
+ verify.dispose();
+ }
+ }
+
private int getPosOfBodyElement(IBodyElement needle) {
BodyElementType type = needle.getElementType();
IBodyElement current;
public int getPosOfParagraph(XWPFParagraph p){
return getPosOfBodyElement(p);
}
-
+
/**
* Get the position of the table, within the list of
* all the body elements.
* Appends a new paragraph to this document
* @return a new paragraph
*/
- public XWPFParagraph createParagraph(){
+ public XWPFParagraph createParagraph() {
XWPFParagraph p = new XWPFParagraph(ctDocument.getBody().addNewP(), this);
bodyElements.add(p);
paragraphs.add(p);
* @param paragraph
* @param pos
*/
- public void setParagraph(XWPFParagraph paragraph, int pos){
- paragraphs.set(pos, paragraph);
- ctDocument.getBody().setPArray(pos, paragraph.getCTP());
+ public void setParagraph(XWPFParagraph paragraph, int pos) {
+ paragraphs.set(pos, paragraph);
+ ctDocument.getBody().setPArray(pos, paragraph.getCTP());
+ /* TODO update body element, update xwpf element, verify that
+ * incoming paragraph belongs to this document or if not, XML was
+ * copied properly (namespace-abbreviations, etc.)
+ */
}
-
+
/**
* @return the LastParagraph of the document
*/
- public XWPFParagraph getLastParagraph(){
- int lastPos = paragraphs.toArray().length - 1;
- return paragraphs.get(lastPos);
+ public XWPFParagraph getLastParagraph() {
+ int lastPos = paragraphs.toArray().length - 1;
+ return paragraphs.get(lastPos);
}
/**
* Create an empty table with one row and one column as default.
* @return a new table
*/
- public XWPFTable createTable(){
+ public XWPFTable createTable() {
XWPFTable table = new XWPFTable(ctDocument.getBody().addNewTbl(), this);
bodyElements.add(table);
tables.add(table);
tables.add(table);
return table;
}
-
-
+
/**
*
*/
public void createTOC() {
CTSdtBlock block = this.getDocument().getBody().addNewSdt();
TOC toc = new TOC(block);
- for (XWPFParagraph par: paragraphs ) {
+ for (XWPFParagraph par : paragraphs) {
String parStyle = par.getStyle();
if (parStyle != null && parStyle.substring(0, 7).equals("Heading")) {
try {
int level = Integer.valueOf(parStyle.substring("Heading".length())).intValue();
toc.addRow(level, par.getText(), 1, "112723803");
- }
- catch (NumberFormatException e) {
+ } catch (NumberFormatException e) {
e.printStackTrace();
}
}
}
}
-
+
/**Replace content of table in array tables at position pos with a
* @param pos
* @param table
*/
- public void setTable(int pos, XWPFTable table){
- tables.set(pos, table);
- ctDocument.getBody().setTblArray(pos, table.getCTTbl());
+ public void setTable(int pos, XWPFTable table) {
+ tables.set(pos, table);
+ ctDocument.getBody().setTblArray(pos, table.getCTTbl());
}
-
+
/**
* Verifies that the documentProtection tag in settings.xml file <br/>
* specifies that the protection is enforced (w:enforcement="1") <br/>
* <w:documentProtection w:edit="readOnly" w:enforcement="1"/>
* </pre>
*/
- public void enforceReadonlyProtection() {
+ public void enforceReadonlyProtection() {
settings.setEnforcementEditValue(STDocProtect.READ_ONLY);
}
*/
public void enforceFillingFormsProtection() {
settings.setEnforcementEditValue(STDocProtect.FORMS);
- }
+ }
/**
* Enforce the Comments protection.<br/>
* </pre>
*/
public void enforceTrackedChangesProtection() {
- settings.setEnforcementEditValue(STDocProtect.TRACKED_CHANGES);
+ settings.setEnforcementEditValue(STDocProtect.TRACKED_CHANGES);
}
/**
public void removeProtectionEnforcement() {
settings.removeEnforcement();
}
-
+
/**
- * Return the zoom level, as a percentage
+ * inserts an existing XWPFTable to the arrays bodyElements and tables
+ * @param pos
+ * @param table
*/
- public long getZoomPercent() {
- return settings.getZoomPercent();
+ public void insertTable(int pos, XWPFTable table) {
+ bodyElements.add(pos, table);
+ int i;
+ for (i = 0; i < ctDocument.getBody().getTblList().size(); i++) {
+ CTTbl tbl = ctDocument.getBody().getTblArray(i);
+ if (tbl == table.getCTTbl()) {
+ break;
+ }
+ }
+ tables.add(i, table);
}
-
+
/**
- * Sets the zoom level, as a percentage
+ * Returns all Pictures, which are referenced from the document itself.
+ * @return a {@link List} of {@link XWPFPictureData}. The returned {@link List} is unmodifiable. Use #a
*/
- public void setZoomPercent(long zoomPercent) {
- settings.setZoomPercent(zoomPercent);
- }
-
- /**
- * inserts an existing XWPFTable to the arrays bodyElements and tables
- * @param pos
- * @param table
- */
- public void insertTable(int pos, XWPFTable table) {
- bodyElements.add(pos, table);
- int i;
- for (i = 0; i < ctDocument.getBody().getTblList().size(); i++) {
- CTTbl tbl = ctDocument.getBody().getTblArray(i);
- if(tbl == table.getCTTbl()){
- break;
- }
- }
- tables.add(i, table);
- }
-
public List<XWPFPictureData> getAllPictures() {
- if(pictures == null){
- pictures = new ArrayList<XWPFPictureData>();
- for (POIXMLDocumentPart poixmlDocumentPart : getRelations()){
- if(poixmlDocumentPart instanceof XWPFPictureData){
- pictures.add((XWPFPictureData)poixmlDocumentPart);
- }
- }
- }
- return pictures;
+ return Collections.unmodifiableList(pictures);
}
-
+
/**
- * @return all Pictures in this package
+ * @return all Pictures in this package
*/
- public List<XWPFPictureData> getAllPackagePictures(){
- List<XWPFPictureData> pkgpictures = new ArrayList<XWPFPictureData>();
- pkgpictures.addAll(getAllPictures());
- for (POIXMLDocumentPart poixmlDocumentPart : getRelations()){
- if(poixmlDocumentPart instanceof XWPFHeaderFooter){
- pkgpictures.addAll(((XWPFHeaderFooter)poixmlDocumentPart).getAllPictures());
- }
- }
- return pkgpictures;
+ public List<XWPFPictureData> getAllPackagePictures() {
+ List<XWPFPictureData> result = new ArrayList<XWPFPictureData>();
+ Collection<List<XWPFPictureData>> values = packagePictures.values();
+ for (List<XWPFPictureData> list : values) {
+ result.addAll(list);
+ }
+ return Collections.unmodifiableList(result);
}
-
- /**
- * Adds a picture to the document. Users should normally call
- * {@link XWPFRun#addPicture(InputStream, int)}
- *
- *
- * @param is The stream to read image from
- * @param format The format of the picture, eg {@link Document#PICTURE_TYPE_JPEG}
- *
- * @return the index to this picture (0 based), the added picture can be obtained from {@link #getAllPictures()} .
- * @throws InvalidFormatException
- */
- public int addPicture(InputStream is, int format) throws IOException, InvalidFormatException {
- int imageNumber = getNextPicNameNumber(format);
- XWPFPictureData img = (XWPFPictureData)createRelationship(XWPFPictureData.RELATIONS[format], XWPFFactory.getInstance(), imageNumber, false);
- OutputStream out = img.getPackagePart().getOutputStream();
- IOUtils.copy(is, out);
- out.close();
- pictures.add(img);
- return getAllPictures().size()-1;
+ void registerPackagePictureData(XWPFPictureData picData) {
+ List<XWPFPictureData> list = packagePictures.get(picData.getChecksum());
+ if (list == null) {
+ list = new ArrayList<XWPFPictureData>(1);
+ packagePictures.put(picData.getChecksum(), list);
+ }
+ if (!list.contains(picData))
+ {
+ list.add(picData);
+ }
}
- /**
- * Adds a picture to the document. Users should normally call
- * {@link XWPFRun#addPicture(InputStream, int)}
- *
- * @param pictureData The bytes to read image from
- * @param format The format of the picture, eg {@link Document#PICTURE_TYPE_JPEG}
- *
- * @return the index to this picture (0 based), the added picture can be obtained from {@link #getAllPictures()} .
- * @throws InvalidFormatException
- */
- public int addPicture(byte[] pictureData, int format) throws InvalidFormatException {
+ XWPFPictureData findPackagePictureData(byte[] pictureData, int format)
+ {
+ long checksum = IOUtils.calculateChecksum(pictureData);
+ XWPFPictureData xwpfPicData = null;
+ /*
+ * Try to find PictureData with this checksum. Create new, if none
+ * exists.
+ */
+ List<XWPFPictureData> xwpfPicDataList = packagePictures.get(checksum);
+ if (xwpfPicDataList != null) {
+ Iterator<XWPFPictureData> iter = xwpfPicDataList.iterator();
+ while (iter.hasNext() && xwpfPicData == null) {
+ XWPFPictureData curElem = iter.next();
+ if (Arrays.equals(pictureData, curElem.getData())) {
+ xwpfPicData = curElem;
+ }
+ }
+ }
+ return xwpfPicData;
+ }
+
+ public String addPictureData(byte[] pictureData,int format) throws InvalidFormatException
+ {
+ XWPFPictureData xwpfPicData = findPackagePictureData(pictureData, format);
+ POIXMLRelation relDesc = XWPFPictureData.RELATIONS[format];
+
+ if (xwpfPicData == null)
+ {
+ /* Part doesn't exist, create a new one */
+ int idx = getNextPicNameNumber(format);
+ xwpfPicData = (XWPFPictureData) createRelationship(relDesc, XWPFFactory.getInstance(),idx);
+ /* write bytes to new part */
+ PackagePart picDataPart = xwpfPicData.getPackagePart();
+ OutputStream out = null;
+ try {
+ out = picDataPart.getOutputStream();
+ out.write(pictureData);
+ } catch (IOException e) {
+ throw new POIXMLException(e);
+ } finally {
+ try {
+ out.close();
+ } catch (IOException e) {
+ // ignore
+ }
+ }
+
+ registerPackagePictureData(xwpfPicData);
+ pictures.add(xwpfPicData);
+
+ return getRelationId(xwpfPicData);
+ }
+ else if (!getRelations().contains(xwpfPicData))
+ {
+ /*
+ * Part already existed, but was not related so far. Create
+ * relationship to the already existing part and update
+ * POIXMLDocumentPart data.
+ */
+ PackagePart picDataPart = xwpfPicData.getPackagePart();
+ // TODO add support for TargetMode.EXTERNAL relations.
+ TargetMode targetMode = TargetMode.INTERNAL;
+ PackagePartName partName = picDataPart.getPartName();
+ String relation = relDesc.getRelation();
+ PackageRelationship relShip = getPackagePart().addRelationship(partName,targetMode,relation);
+ String id = relShip.getId();
+ addRelation(id,xwpfPicData);
+ pictures.add(xwpfPicData);
+ return id;
+ }
+ else
+ {
+ /* Part already existed, get relation id and return it */
+ return getRelationId(xwpfPicData);
+ }
+ }
+
+ public String addPictureData(InputStream is,int format) throws InvalidFormatException
+ {
try {
- return addPicture(new ByteArrayInputStream(pictureData), format);
- } catch (IOException e){
+ byte[] data = IOUtils.toByteArray(is);
+ return addPictureData(data, format);
+ } catch (IOException e) {
throw new POIXMLException(e);
}
}
-
+
/**
* get the next free ImageNumber
* @param format
* @return the next free ImageNumber
* @throws InvalidFormatException
*/
- public int getNextPicNameNumber(int format) throws InvalidFormatException{
- int img = getAllPackagePictures().size()+1;
- String proposal = XWPFPictureData.RELATIONS[format].getFileName(img);
- PackagePartName createPartName = PackagingURIHelper.createPartName(proposal);
- while (this.getPackage().getPart(createPartName)!= null){
- img++;
- proposal = XWPFPictureData.RELATIONS[format].getFileName(img);
- createPartName = PackagingURIHelper.createPartName(proposal);
- }
- return img;
+ public int getNextPicNameNumber(int format) throws InvalidFormatException {
+ int img = getAllPackagePictures().size() + 1;
+ String proposal = XWPFPictureData.RELATIONS[format].getFileName(img);
+ PackagePartName createPartName = PackagingURIHelper.createPartName(proposal);
+ while (this.getPackage().getPart(createPartName) != null) {
+ img++;
+ proposal = XWPFPictureData.RELATIONS[format].getFileName(img);
+ createPartName = PackagingURIHelper.createPartName(proposal);
+ }
+ return img;
}
-
+
/**
* returns the PictureData by blipID
* @param blipID
* @return XWPFPictureData of a specificID
- * @throws Exception
*/
public XWPFPictureData getPictureDataByID(String blipID) {
- for(POIXMLDocumentPart part: getRelations()){
- if(part.getPackageRelationship() != null){
- if(part.getPackageRelationship().getId() != null){
- if(part.getPackageRelationship().getId().equals(blipID)){
- return (XWPFPictureData)part;
- }
- }
- }
- }
- return null;
+ POIXMLDocumentPart relatedPart = getRelationById(blipID);
+ if (relatedPart instanceof XWPFPictureData) {
+ XWPFPictureData xwpfPicData = (XWPFPictureData) relatedPart;
+ return xwpfPicData;
+ }
+ return null;
}
-
+
/**
- * getNumbering
+ * getNumbering
* @return numbering
*/
- public XWPFNumbering getNumbering(){
- return numbering;
+ public XWPFNumbering getNumbering() {
+ return numbering;
}
- /**
- * get Styles
- * @return styles for this document
- */
- public XWPFStyles getStyles(){
- return styles;
- }
-
- /**
- * get the paragraph with the CTP class p
- *
- * @param p
- * @return the paragraph with the CTP class p
- */
- public XWPFParagraph getParagraph(CTP p){
- for(int i=0; i<getParagraphs().size(); i++){
- if(getParagraphs().get(i).getCTP() == p) return getParagraphs().get(i);
- }
- return null;
- }
-
- /**
- * get a table by its CTTbl-Object
- * @param ctTbl
- * @see org.apache.poi.xwpf.usermodel.IBody#getTable(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl)
- * @return a table by its CTTbl-Object or null
- */
+ /**
+ * get Styles
+ * @return styles for this document
+ */
+ public XWPFStyles getStyles() {
+ return styles;
+ }
+
+ /**
+ * get the paragraph with the CTP class p
+ *
+ * @param p
+ * @return the paragraph with the CTP class p
+ */
+ public XWPFParagraph getParagraph(CTP p) {
+ for (int i = 0; i < getParagraphs().size(); i++) {
+ if (getParagraphs().get(i).getCTP() == p) {
+ return getParagraphs().get(i);
+ }
+ }
+ return null;
+ }
+
+ /**
+ * get a table by its CTTbl-Object
+ * @param ctTbl
+ * @see org.apache.poi.xwpf.usermodel.IBody#getTable(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl)
+ * @return a table by its CTTbl-Object or null
+ */
public XWPFTable getTable(CTTbl ctTbl) {
- for(int i=0; i<tables.size(); i++){
- if(getTables().get(i).getCTTbl() == ctTbl) return getTables().get(i);
- }
- return null;
- }
+ for (int i = 0; i < tables.size(); i++) {
+ if (getTables().get(i).getCTTbl() == ctTbl) {
+ return getTables().get(i);
+ }
+ }
+ return null;
+ }
public Iterator<XWPFTable> getTablesIterator() {
return null;
}
+ /**
+ * returns the Part, to which the body belongs, which you need for adding relationship to other parts
+ * Actually it is needed of the class XWPFTableCell. Because you have to know to which part the tableCell
+ * belongs.
+ * @see org.apache.poi.xwpf.usermodel.IBody#getPart()
+ */
+ public POIXMLDocumentPart getPart() {
+ return this;
+ }
- /**
- * returns the Part, to which the body belongs, which you need for adding relationship to other parts
- * Actually it is needed of the class XWPFTableCell. Because you have to know to which part the tableCell
- * belongs.
- * @see org.apache.poi.xwpf.usermodel.IBody#getPart()
- */
- public IBody getPart() {
- return this;
- }
-
/**
* get the PartType of the body, for example
* DOCUMENT, HEADER, FOOTER, FOOTNOTE,
public XWPFDocument getXWPFDocument() {
return this;
}
-}//end class
+} // end class
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
-import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;
import javax.xml.namespace.QName;
import org.apache.poi.POIXMLDocumentPart;
+import org.apache.poi.POIXMLException;
import org.apache.poi.openxml4j.opc.PackagePart;
import org.apache.poi.openxml4j.opc.PackageRelationship;
import org.apache.xmlbeans.XmlCursor;
-import org.apache.xmlbeans.XmlException;
import org.apache.xmlbeans.XmlObject;
import org.apache.xmlbeans.XmlOptions;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHdrFtr;
super();
}
- public XWPFFooter(XWPFDocument doc, CTHdrFtr hdrFtr) throws IOException {
- super(doc, hdrFtr);
- bodyElements = new ArrayList<IBodyElement>();
- paragraphs = new ArrayList<XWPFParagraph>();
- tables = new ArrayList<XWPFTable>();
- XmlCursor cursor = headerFooter.newCursor();
+ public XWPFFooter(XWPFDocument doc, CTHdrFtr hdrFtr) throws IOException {
+ super(doc, hdrFtr);
+ XmlCursor cursor = headerFooter.newCursor();
cursor.selectPath("./*");
while (cursor.toNextSelection()) {
XmlObject o = cursor.getObject();
if (o instanceof CTP) {
- XWPFParagraph p = new XWPFParagraph((CTP)o, this);
- paragraphs.add(p);
- bodyElements.add(p);
+ XWPFParagraph p = new XWPFParagraph((CTP)o, this);
+ paragraphs.add(p);
+ bodyElements.add(p);
}
if (o instanceof CTTbl) {
- XWPFTable t = new XWPFTable((CTTbl)o, this);
- tables.add(t);
- bodyElements.add(t);
+ XWPFTable t = new XWPFTable((CTTbl)o, this);
+ tables.add(t);
+ bodyElements.add(t);
}
}
cursor.dispose();
- getAllPictures();
- }
+ }
+
+ public XWPFFooter(POIXMLDocumentPart parent, PackagePart part, PackageRelationship rel) throws IOException {
+ super(parent, part, rel);
+ }
- public XWPFFooter(POIXMLDocumentPart parent, PackagePart part, PackageRelationship rel) throws IOException {
- super(parent, part, rel);
- }
-
- /**
- * save and commit footer
- */
- @Override
+ /**
+ * save and commit footer
+ */
+ @Override
protected void commit() throws IOException {
XmlOptions xmlOptions = new XmlOptions(DEFAULT_XML_OPTIONS);
xmlOptions.setSaveSyntheticDocumentElement(new QName(CTNumbering.type.getName().getNamespaceURI(), "ftr"));
super._getHdrFtr().save(out, xmlOptions);
out.close();
}
-
- @Override
- protected void onDocumentRead(){
- bodyElements = new ArrayList<IBodyElement>();
- paragraphs = new ArrayList<XWPFParagraph>();
- tables= new ArrayList<XWPFTable>();
- FtrDocument ftrDocument = null;
- InputStream is;
- try {
- is = getPackagePart().getInputStream();
- ftrDocument = FtrDocument.Factory.parse(is);
- headerFooter = ftrDocument.getFtr();
- // parse the document with cursor and add
- // the XmlObject to its lists
- XmlCursor cursor = headerFooter.newCursor();
- cursor.selectPath("./*");
- while (cursor.toNextSelection()) {
- XmlObject o = cursor.getObject();
- if (o instanceof CTP) {
- XWPFParagraph p = new XWPFParagraph((CTP)o, this);
- paragraphs.add(p);
- bodyElements.add(p);
- }
- if (o instanceof CTTbl) {
- XWPFTable t = new XWPFTable((CTTbl)o, this);
- tables.add(t);
- bodyElements.add(t);
- }
- }
- cursor.dispose();
- getAllPictures();
- } catch (IOException e) {
- // TODO Auto-generated catch block
- e.printStackTrace();
- } catch (XmlException e) {
- // TODO Auto-generated catch block
- e.printStackTrace();
- }
- }
- /**
- * returns the Part, to which the body belongs, which you need for adding relationship to other parts
- * @see org.apache.poi.xwpf.usermodel.IBody#getPart()
- */
- public IBody getPart() {
- return this;
- }
- /**
- * get the PartType of the body
- * @see org.apache.poi.xwpf.usermodel.IBody#getPartType()
- */
- public BodyType getPartType() {
- return BodyType.FOOTER;
- }
+ @Override
+ protected void onDocumentRead() throws IOException{
+ super.onDocumentRead();
+ FtrDocument ftrDocument = null;
+ InputStream is;
+ try {
+ is = getPackagePart().getInputStream();
+ ftrDocument = FtrDocument.Factory.parse(is);
+ headerFooter = ftrDocument.getFtr();
+ // parse the document with cursor and add
+ // the XmlObject to its lists
+ XmlCursor cursor = headerFooter.newCursor();
+ cursor.selectPath("./*");
+ while (cursor.toNextSelection()) {
+ XmlObject o = cursor.getObject();
+ if (o instanceof CTP) {
+ XWPFParagraph p = new XWPFParagraph((CTP)o, this);
+ paragraphs.add(p);
+ bodyElements.add(p);
+ }
+ if (o instanceof CTTbl) {
+ XWPFTable t = new XWPFTable((CTTbl)o, this);
+ tables.add(t);
+ bodyElements.add(t);
+ }
+ }
+ cursor.dispose();
+ } catch (Exception e) {
+ throw new POIXMLException(e);
+ }
+ }
+
+ /**
+ * get the PartType of the body
+ * @see org.apache.poi.xwpf.usermodel.IBody#getPartType()
+ */
+ public BodyType getPartType() {
+ return BodyType.FOOTER;
+ }
}
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
-import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;
import javax.xml.namespace.QName;
import org.apache.poi.POIXMLDocumentPart;
+import org.apache.poi.POIXMLException;
import org.apache.poi.openxml4j.opc.PackagePart;
import org.apache.poi.openxml4j.opc.PackageRelationship;
import org.apache.xmlbeans.XmlCursor;
}
public XWPFHeader(POIXMLDocumentPart parent, PackagePart part, PackageRelationship rel) throws IOException {
- super(parent, part, rel);
- }
-
- public XWPFHeader(XWPFDocument doc, CTHdrFtr hdrFtr) throws IOException {
- super(doc, hdrFtr);
- paragraphs = new ArrayList<XWPFParagraph>();
- tables = new ArrayList<XWPFTable>();
- XmlCursor cursor = headerFooter.newCursor();
- cursor.selectPath("./*");
- while (cursor.toNextSelection()) {
- XmlObject o = cursor.getObject();
- if (o instanceof CTP) {
- XWPFParagraph p = new XWPFParagraph((CTP) o, this);
- paragraphs.add(p);
- }
- if (o instanceof CTTbl) {
- XWPFTable t = new XWPFTable((CTTbl) o, this);
- tables.add(t);
- }
- }
+ super(parent, part, rel);
+ }
+
+ public XWPFHeader(XWPFDocument doc, CTHdrFtr hdrFtr) {
+ super(doc, hdrFtr);
+ XmlCursor cursor = headerFooter.newCursor();
+ cursor.selectPath("./*");
+ while (cursor.toNextSelection()) {
+ XmlObject o = cursor.getObject();
+ if (o instanceof CTP) {
+ XWPFParagraph p = new XWPFParagraph((CTP) o, this);
+ paragraphs.add(p);
+ }
+ if (o instanceof CTTbl) {
+ XWPFTable t = new XWPFTable((CTTbl) o, this);
+ tables.add(t);
+ }
+ }
cursor.dispose();
- getAllPictures();
- }
+ }
/**
- public XWPFHeader(PackagePart part, PackageRelationship rel)
- throws IOException {
- super(part, rel);
- }
-
- /**
- * save and commit footer
- */
- @Override
+ * save and commit footer
+ */
+ @Override
protected void commit() throws IOException {
XmlOptions xmlOptions = new XmlOptions(DEFAULT_XML_OPTIONS);
xmlOptions.setSaveSyntheticDocumentElement(new QName(CTNumbering.type.getName().getNamespaceURI(), "hdr"));
out.close();
}
- /**
- * reads the document
- */
- @Override
- protected void onDocumentRead(){
- bodyElements = new ArrayList<IBodyElement>();
- paragraphs = new ArrayList<XWPFParagraph>();
- tables= new ArrayList<XWPFTable>();
- HdrDocument hdrDocument = null;
- InputStream is;
- try {
- is = getPackagePart().getInputStream();
- hdrDocument = HdrDocument.Factory.parse(is);
- headerFooter = hdrDocument.getHdr();
- // parse the document with cursor and add
- // the XmlObject to its lists
- XmlCursor cursor = headerFooter.newCursor();
- cursor.selectPath("./*");
- while (cursor.toNextSelection()) {
- XmlObject o = cursor.getObject();
- if (o instanceof CTP) {
- XWPFParagraph p = new XWPFParagraph((CTP)o, this);
- paragraphs.add(p);
- bodyElements.add(p);
- }
- if (o instanceof CTTbl) {
- XWPFTable t = new XWPFTable((CTTbl)o, this);
- tables.add(t);
- bodyElements.add(t);
- }
- }
- cursor.dispose();
- } catch (IOException e) {
- // TODO Auto-generated catch block
- e.printStackTrace();
- } catch (XmlException e) {
- // TODO Auto-generated catch block
- e.printStackTrace();
- }
- }
-
- /**
- * returns the Part, to which the body belongs, which you need for adding relationship to other parts
- * @see org.apache.poi.xwpf.usermodel.IBody#getPart()
- */
- public IBody getPart() {
- return this;
- }
-
- /**
- * get the PartType of the body
- * @see org.apache.poi.xwpf.usermodel.IBody#getPartType()
- */
- public BodyType getPartType() {
- return BodyType.HEADER;
- }
-
+ /**
+ * reads the document
+ * @throws IOException
+ */
+ @Override
+ protected void onDocumentRead() throws IOException {
+ super.onDocumentRead();
+ HdrDocument hdrDocument = null;
+ InputStream is;
+ try {
+ is = getPackagePart().getInputStream();
+ hdrDocument = HdrDocument.Factory.parse(is);
+ headerFooter = hdrDocument.getHdr();
+ // parse the document with cursor and add
+ // the XmlObject to its lists
+ XmlCursor cursor = headerFooter.newCursor();
+ cursor.selectPath("./*");
+ while (cursor.toNextSelection()) {
+ XmlObject o = cursor.getObject();
+ if (o instanceof CTP) {
+ XWPFParagraph p = new XWPFParagraph((CTP)o, this);
+ paragraphs.add(p);
+ bodyElements.add(p);
+ }
+ if (o instanceof CTTbl) {
+ XWPFTable t = new XWPFTable((CTTbl)o, this);
+ tables.add(t);
+ bodyElements.add(t);
+ }
+ }
+ cursor.dispose();
+ } catch (XmlException e) {
+ throw new POIXMLException(e);
+ }
+ }
+ /**
+ * get the PartType of the body
+ * @see org.apache.poi.xwpf.usermodel.IBody#getPartType()
+ */
+ public BodyType getPartType() {
+ return BodyType.HEADER;
+ }
}//end class
import org.apache.poi.POIXMLDocumentPart;
import org.apache.poi.POIXMLException;
+import org.apache.poi.POIXMLRelation;
import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
import org.apache.poi.openxml4j.opc.PackagePart;
import org.apache.poi.openxml4j.opc.PackagePartName;
import org.apache.poi.openxml4j.opc.PackageRelationship;
-import org.apache.poi.openxml4j.opc.PackagingURIHelper;
+import org.apache.poi.openxml4j.opc.TargetMode;
import org.apache.poi.util.IOUtils;
import org.apache.poi.util.Internal;
import org.apache.xmlbeans.XmlCursor;
/**
* Parent of XWPF headers and footers
*/
-public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBody{
- protected CTHdrFtr headerFooter;
- protected List<XWPFParagraph> paragraphs;
- protected List<XWPFTable> tables;
- protected List<XWPFPictureData> pictures;
- protected XWPFDocument document;
- protected List<IBodyElement> bodyElements;
-
- protected XWPFHeaderFooter(XWPFDocument doc, CTHdrFtr hdrFtr){
+public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBody {
+ List<XWPFParagraph> paragraphs = new ArrayList<XWPFParagraph>(1);
+ List<XWPFTable> tables= new ArrayList<XWPFTable>(1);
+ List<XWPFPictureData> pictures = new ArrayList<XWPFPictureData>();
+ List<IBodyElement> bodyElements = new ArrayList<IBodyElement>(1);
+
+ CTHdrFtr headerFooter;
+ XWPFDocument document;
+
+ XWPFHeaderFooter(XWPFDocument doc, CTHdrFtr hdrFtr){
if (doc==null) {
throw new NullPointerException();
}
document = doc;
- headerFooter = hdrFtr;
- readHdrFtr();
- }
+ headerFooter = hdrFtr;
+ readHdrFtr();
+ }
protected XWPFHeaderFooter() {
headerFooter = CTHdrFtr.Factory.newInstance();
readHdrFtr();
}
-
public XWPFHeaderFooter(POIXMLDocumentPart parent, PackagePart part, PackageRelationship rel) throws IOException {
- super(parent, part, rel);
- this.document = (XWPFDocument)getParent();
+ super(parent, part, rel);
+ this.document = (XWPFDocument)getParent();
if (this.document==null) {
throw new NullPointerException();
}
+ }
+
+ @Override
+ protected void onDocumentRead() throws IOException {
+ for (POIXMLDocumentPart poixmlDocumentPart : getRelations()){
+ if(poixmlDocumentPart instanceof XWPFPictureData){
+ XWPFPictureData xwpfPicData = (XWPFPictureData) poixmlDocumentPart;
+ pictures.add(xwpfPicData);
+ document.registerPackagePictureData(xwpfPicData);
+ }
+ }
+ }
- onDocumentRead();
- }
-
@Internal
- public CTHdrFtr _getHdrFtr() {
- return headerFooter;
- }
+ public CTHdrFtr _getHdrFtr() {
+ return headerFooter;
+ }
- public List<IBodyElement> getBodyElements(){
+ public List<IBodyElement> getBodyElements(){
return Collections.unmodifiableList(bodyElements);
- }
-
- /**
- * Returns the paragraph(s) that holds
- * the text of the header or footer.
- * Normally there is only the one paragraph, but
- * there could be more in certain cases, or
- * a table.
- */
+ }
+
+ /**
+ * Returns the paragraph(s) that holds
+ * the text of the header or footer.
+ * Normally there is only the one paragraph, but
+ * there could be more in certain cases, or
+ * a table.
+ */
public List<XWPFParagraph> getParagraphs() {
return Collections.unmodifiableList(paragraphs);
}
-
-
- /**
- * Return the table(s) that holds the text
- * of the header or footer, for complex cases
- * where a paragraph isn't used.
- * Normally there's just one paragraph, but some
- * complex headers/footers have a table or two
- * in addition.
- */
- public List<XWPFTable> getTables()throws ArrayIndexOutOfBoundsException {
- return Collections.unmodifiableList(tables);
+
+
+ /**
+ * Return the table(s) that holds the text
+ * of the header or footer, for complex cases
+ * where a paragraph isn't used.
+ * Normally there's just one paragraph, but some
+ * complex headers/footers have a table or two
+ * in addition.
+ */
+ public List<XWPFTable> getTables()throws ArrayIndexOutOfBoundsException {
+ return Collections.unmodifiableList(tables);
+ }
+
+
+
+ /**
+ * Returns the textual content of the header/footer,
+ * by flattening out the text of its paragraph(s)
+ */
+ public String getText() {
+ StringBuffer t = new StringBuffer();
+
+ for(int i=0; i<paragraphs.size(); i++) {
+ if(! paragraphs.get(i).isEmpty()) {
+ String text = paragraphs.get(i).getText();
+ if(text != null && text.length() > 0) {
+ t.append(text);
+ t.append('\n');
+ }
+ }
+ }
+
+ List<XWPFTable> tables = getTables();
+ for(int i=0; i<tables.size(); i++) {
+ String text = tables.get(i).getText();
+ if(text != null && text.length() > 0) {
+ t.append(text);
+ t.append('\n');
+ }
+ }
+
+ return t.toString();
+ }
+
+ /**
+ * set a new headerFooter
+ */
+ public void setHeaderFooter(CTHdrFtr headerFooter){
+ this.headerFooter = headerFooter;
+ readHdrFtr();
+ }
+
+ /**
+ * if there is a corresponding {@link XWPFTable} of the parameter ctTable in the tableList of this header
+ * the method will return this table
+ * if there is no corresponding {@link XWPFTable} the method will return null
+ * @param ctTable
+ */
+ public XWPFTable getTable(CTTbl ctTable){
+ for (XWPFTable table : tables) {
+ if(table==null)
+ return null;
+ if(table.getCTTbl().equals(ctTable))
+ return table;
+ }
+ return null;
+ }
+
+ /**
+ * if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this header or footer
+ * the method will return this paragraph
+ * if there is no corresponding {@link XWPFParagraph} the method will return null
+ * @param p is instance of CTP and is searching for an XWPFParagraph
+ * @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer
+ * XWPFParagraph with the correspondig CTP p
+ */
+ public XWPFParagraph getParagraph(CTP p){
+ for (XWPFParagraph paragraph : paragraphs) {
+ if(paragraph.getCTP().equals(p))
+ return paragraph;
+ }
+ return null;
+
+ }
+
+ /**
+ * Returns the paragraph that holds
+ * the text of the header or footer.
+ */
+ public XWPFParagraph getParagraphArray(int pos) {
+
+ return paragraphs.get(pos);
+ }
+
+ /**
+ * get a List of all Paragraphs
+ * @return a list of {@link XWPFParagraph}
+ */
+ public List<XWPFParagraph> getListParagraph(){
+ return paragraphs;
}
-
-
-
- /**
- * Returns the textual content of the header/footer,
- * by flattening out the text of its paragraph(s)
- */
- public String getText() {
- StringBuffer t = new StringBuffer();
-
- for(int i=0; i<paragraphs.size(); i++) {
- if(! paragraphs.get(i).isEmpty()) {
- String text = paragraphs.get(i).getText();
- if(text != null && text.length() > 0) {
- t.append(text);
- t.append('\n');
- }
- }
- }
-
- List<XWPFTable> tables = getTables();
- for(int i=0; i<tables.size(); i++) {
- String text = tables.get(i).getText();
- if(text != null && text.length() > 0) {
- t.append(text);
- t.append('\n');
- }
- }
-
- return t.toString();
- }
-
- /**
- * set a new headerFooter
- */
- public void setHeaderFooter(CTHdrFtr headerFooter){
- this.headerFooter = headerFooter;
- readHdrFtr();
- }
-
- /**
- * if there is a corresponding {@link XWPFTable} of the parameter ctTable in the tableList of this header
- * the method will return this table
- * if there is no corresponding {@link XWPFTable} the method will return null
- * @param ctTable
- */
- public XWPFTable getTable(CTTbl ctTable){
- for (XWPFTable table : tables) {
- if(table==null)
- return null;
- if(table.getCTTbl().equals(ctTable))
- return table;
- }
- return null;
- }
-
- /**
- * if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this header or footer
- * the method will return this paragraph
- * if there is no corresponding {@link XWPFParagraph} the method will return null
- * @param p is instance of CTP and is searching for an XWPFParagraph
- * @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer
- * XWPFParagraph with the correspondig CTP p
- */
- public XWPFParagraph getParagraph(CTP p){
- for (XWPFParagraph paragraph : paragraphs) {
- if(paragraph.getCTP().equals(p))
- return paragraph;
- }
- return null;
-
- }
-
- /**
- * Returns the paragraph that holds
- * the text of the header or footer.
- */
- public XWPFParagraph getParagraphArray(int pos) {
-
- return paragraphs.get(pos);
- }
-
- /**
- * get a List of all Paragraphs
- * @return a list of {@link XWPFParagraph}
- */
- public List<XWPFParagraph> getListParagraph(){
- return paragraphs;
- }
-
+
public List<XWPFPictureData> getAllPictures() {
- if(pictures == null){
- pictures = new ArrayList<XWPFPictureData>();
- for (POIXMLDocumentPart poixmlDocumentPart : getRelations()){
- if(poixmlDocumentPart instanceof XWPFPictureData){
- pictures.add((XWPFPictureData)poixmlDocumentPart);
- }
- }
- }
- return pictures;
+ return Collections.unmodifiableList(pictures);
}
-
+
/**
* get all Pictures in this package
* @return all Pictures in this package
*/
public List<XWPFPictureData> getAllPackagePictures(){
- List<XWPFPictureData> pkgpictures = new ArrayList<XWPFPictureData>();
- pkgpictures.addAll(getAllPictures());
- for (POIXMLDocumentPart poixmlDocumentPart : getRelations()){
- if(poixmlDocumentPart instanceof XWPFHeaderFooter){
- pkgpictures.addAll(((XWPFHeaderFooter)poixmlDocumentPart).getAllPictures());
- }
- }
- return pkgpictures;
+ return document.getAllPackagePictures();
+
}
-
- /**
+
+ /**
* Adds a picture to the document.
*
* @param is The stream to read image from
* @param format The format of the picture.
*
* @return the index to this picture (0 based), the added picture can be obtained from {@link #getAllPictures()} .
+ * @throws InvalidFormatException
*/
- public int addPicture(InputStream is, int format) throws IOException {
- int imageNumber = getNextPicNameNumber(format);
- XWPFPictureData img = (XWPFPictureData)createRelationship(XWPFPictureData.RELATIONS[format], XWPFFactory.getInstance(), imageNumber, true);
- OutputStream out = img.getPackagePart().getOutputStream();
- IOUtils.copy(is, out);
- out.close();
- pictures.add(img);
- return getAllPictures().size()-1;
-
+ public String addPictureData(byte[] pictureData,int format) throws InvalidFormatException
+ {
+ XWPFPictureData xwpfPicData = document.findPackagePictureData(pictureData, format);
+ POIXMLRelation relDesc = XWPFPictureData.RELATIONS[format];
+
+ if (xwpfPicData == null)
+ {
+ /* Part doesn't exist, create a new one */
+ int idx = document.getNextPicNameNumber(format);
+ xwpfPicData = (XWPFPictureData) createRelationship(relDesc, XWPFFactory.getInstance(),idx);
+ /* write bytes to new part */
+ PackagePart picDataPart = xwpfPicData.getPackagePart();
+ OutputStream out = null;
+ try {
+ out = picDataPart.getOutputStream();
+ out.write(pictureData);
+ } catch (IOException e) {
+ throw new POIXMLException(e);
+ } finally {
+ try {
+ out.close();
+ } catch (IOException e) {
+ // ignore
+ }
+ }
+
+ document.registerPackagePictureData(xwpfPicData);
+ pictures.add(xwpfPicData);
+ return getRelationId(xwpfPicData);
+ }
+ else if (!getRelations().contains(xwpfPicData))
+ {
+ /*
+ * Part already existed, but was not related so far. Create
+ * relationship to the already existing part and update
+ * POIXMLDocumentPart data.
+ */
+ PackagePart picDataPart = xwpfPicData.getPackagePart();
+ // TODO add support for TargetMode.EXTERNAL relations.
+ TargetMode targetMode = TargetMode.INTERNAL;
+ PackagePartName partName = picDataPart.getPartName();
+ String relation = relDesc.getRelation();
+ PackageRelationship relShip = getPackagePart().addRelationship(partName,targetMode,relation);
+ String id = relShip.getId();
+ addRelation(id,xwpfPicData);
+ pictures.add(xwpfPicData);
+ return id;
+ }
+ else
+ {
+ /* Part already existed, get relation id and return it */
+ return getRelationId(xwpfPicData);
+ }
}
-
+
/**
* Adds a picture to the document.
*
- * @param pictureData The picture bytes
+ * @param is The stream to read image from
* @param format The format of the picture.
*
* @return the index to this picture (0 based), the added picture can be obtained from {@link #getAllPictures()} .
+ * @throws InvalidFormatException
+ * @throws IOException
*/
- public int addPicture(byte[] pictureData, int format) {
- int imageNumber = getNextPicNameNumber(format);
- XWPFPictureData img = (XWPFPictureData)createRelationship(XWPFPictureData.RELATIONS[format], XWPFFactory.getInstance(), imageNumber, false);
- try {
- OutputStream out = img.getPackagePart().getOutputStream();
- out.write(pictureData);
- out.close();
- } catch (IOException e){
- throw new POIXMLException(e);
- }
-
- pictures.add(img);
- return getAllPictures().size()-1;
- }
-
- /**
- * get the next free ImageNumber
- * @param format
- * @return the next free ImageNumber
- */
- public int getNextPicNameNumber(int format){
- int img = getAllPackagePictures().size()+1;
- String proposal = XWPFPictureData.RELATIONS[format].getFileName(img);
- try {
- PackagePartName createPartName = PackagingURIHelper.createPartName(proposal);
- while (this.getPackagePart().getPackage().getPart(createPartName)!= null){
- img++;
- proposal = XWPFPictureData.RELATIONS[format].getFileName(img);
- createPartName = PackagingURIHelper.createPartName(proposal);
- }
- } catch (InvalidFormatException e) {
- // TODO Auto-generated catch block
- e.printStackTrace();
- }
- return img;
+ public String addPictureData(InputStream is, int format) throws InvalidFormatException,IOException {
+ byte[] data = IOUtils.toByteArray(is);
+ return addPictureData(data,format);
}
-
+
/**
* returns the PictureData by blipID
* @param blipID
* @throws Exception
*/
public XWPFPictureData getPictureDataByID(String blipID) {
- for(POIXMLDocumentPart part: getRelations()){
- if(part.getPackageRelationship() != null){
- if(part.getPackageRelationship().getId() != null){
- if(part.getPackageRelationship().getId().equals(blipID)){
- return (XWPFPictureData)part;
- }
- }
- }
- }
- return null;
+ POIXMLDocumentPart relatedPart = getRelationById(blipID);
+ if (relatedPart != null && relatedPart instanceof XWPFPictureData) {
+ return (XWPFPictureData) relatedPart;
+ }
+ return null;
}
-
+
/**
- * Add the picture to drawing relations
- *
- * @param pictureData the picture bytes
- * @param format the picture format
+ * add a new paragraph at position of the cursor
+ * @param cursor
+ * @return the inserted paragraph
+ */
+ public XWPFParagraph insertNewParagraph(XmlCursor cursor){
+ if(isCursorInHdrF(cursor)){
+ String uri = CTP.type.getName().getNamespaceURI();
+ String localPart = "p";
+ cursor.beginElement(localPart,uri);
+ cursor.toParent();
+ CTP p = (CTP)cursor.getObject();
+ XWPFParagraph newP = new XWPFParagraph(p, this);
+ XmlObject o = null;
+ while(!(o instanceof CTP)&&(cursor.toPrevSibling())){
+ o = cursor.getObject();
+ }
+ if((!(o instanceof CTP)) || (CTP)o == p){
+ paragraphs.add(0, newP);
+ }
+ else{
+ int pos = paragraphs.indexOf(getParagraph((CTP)o))+1;
+ paragraphs.add(pos,newP);
+ }
+ int i=0;
+ cursor.toCursor(p.newCursor());
+ while(cursor.toPrevSibling()){
+ o =cursor.getObject();
+ if(o instanceof CTP || o instanceof CTTbl)
+ i++;
+ }
+ bodyElements.add(i, newP);
+ cursor.toCursor(p.newCursor());
+ cursor.toEndToken();
+ return newP;
+ }
+ return null;
+ }
+
+
+ /**
+ *
+ * @param cursor
+ * @return the inserted table
+ */
+ public XWPFTable insertNewTbl(XmlCursor cursor) {
+ if(isCursorInHdrF(cursor)){
+ String uri = CTTbl.type.getName().getNamespaceURI();
+ String localPart = "tbl";
+ cursor.beginElement(localPart,uri);
+ cursor.toParent();
+ CTTbl t = (CTTbl)cursor.getObject();
+ XWPFTable newT = new XWPFTable(t, this);
+ cursor.removeXmlContents();
+ XmlObject o = null;
+ while(!(o instanceof CTTbl)&&(cursor.toPrevSibling())){
+ o = cursor.getObject();
+ }
+ if(!(o instanceof CTTbl)){
+ tables.add(0, newT);
+ }
+ else{
+ int pos = tables.indexOf(getTable((CTTbl)o))+1;
+ tables.add(pos,newT);
+ }
+ int i=0;
+ cursor = t.newCursor();
+ while(cursor.toPrevSibling()){
+ o =cursor.getObject();
+ if(o instanceof CTP || o instanceof CTTbl)
+ i++;
+ }
+ bodyElements.add(i, newT);
+ cursor = t.newCursor();
+ cursor.toEndToken();
+ return newT;
+ }
+ return null;
+ }
+
+ /**
+ * verifies that cursor is on the right position
+ * @param cursor
*/
- public PackageRelationship addPictureReference(byte[] pictureData, int format){
- int imageNumber = getNextPicNameNumber(format);
- XWPFPictureData img = (XWPFPictureData)createRelationship(XWPFPictureData.RELATIONS[format], XWPFFactory.getInstance(), imageNumber, false);
- PackageRelationship rel = null;
- try {
- OutputStream out = img.getPackagePart().getOutputStream();
- out.write(pictureData);
- out.close();
- rel = img.getPackageRelationship();
- pictures.add(img);
- } catch (IOException e){
- throw new POIXMLException(e);
- }
- return rel;
+ private boolean isCursorInHdrF(XmlCursor cursor) {
+ XmlCursor verify = cursor.newCursor();
+ verify.toParent();
+ if(verify.getObject() == this.headerFooter){
+ return true;
+ }
+ return false;
+ }
+
+
+ public POIXMLDocumentPart getOwner(){
+ return this;
+ }
+
+ /**
+ * Returns the table at position pos
+ * @see org.apache.poi.xwpf.usermodel.IBody#getTableArray(int)
+ */
+ public XWPFTable getTableArray(int pos) {
+
+ if(pos > 0 && pos < tables.size()){
+ return tables.get(pos);
+ }
+ return null;
+ }
+
+ /**
+ * inserts an existing XWPFTable to the arrays bodyElements and tables
+ * @param pos
+ * @param table
+ */
+ public void insertTable(int pos, XWPFTable table) {
+ bodyElements.add(pos, table);
+ int i;
+ for (i = 0; i < headerFooter.getTblList().size(); i++) {
+ CTTbl tbl = headerFooter.getTblArray(i);
+ if(tbl == table.getCTTbl()){
+ break;
+ }
+ }
+ tables.add(i, table);
+
}
-
- /**
- * Add the picture to drawing relations
- *
- * @param is the stream to read picture data from
- */
- public PackageRelationship addPictureReference(InputStream is, int format){
-
- PackageRelationship rel = null;
- try {
- int imageNumber = getNextPicNameNumber(format);
- XWPFPictureData img = (XWPFPictureData)createRelationship(XWPFPictureData.RELATIONS[format], XWPFFactory.getInstance(), imageNumber, false);
- OutputStream out = img.getPackagePart().getOutputStream();
- IOUtils.copy(is, out);
- out.close();
- rel = img.getPackageRelationship();
- pictures.add(img);
- } catch (IOException e) {
- // TODO Auto-generated catch block
- e.printStackTrace();
- }
- return rel;
- }
-
- /**
- * add a new paragraph at position of the cursor
- * @param cursor
- * @return the inserted paragraph
- */
- public XWPFParagraph insertNewParagraph(XmlCursor cursor){
- if(isCursorInHdrF(cursor)){
- String uri = CTP.type.getName().getNamespaceURI();
- String localPart = "p";
- cursor.beginElement(localPart,uri);
- cursor.toParent();
- CTP p = (CTP)cursor.getObject();
- XWPFParagraph newP = new XWPFParagraph(p, this);
- XmlObject o = null;
- while(!(o instanceof CTP)&&(cursor.toPrevSibling())){
- o = cursor.getObject();
- }
- if((!(o instanceof CTP)) || (CTP)o == p){
- paragraphs.add(0, newP);
- }
- else{
- int pos = paragraphs.indexOf(getParagraph((CTP)o))+1;
- paragraphs.add(pos,newP);
- }
- int i=0;
- cursor.toCursor(p.newCursor());
- while(cursor.toPrevSibling()){
- o =cursor.getObject();
- if(o instanceof CTP || o instanceof CTTbl)
- i++;
- }
- bodyElements.add(i, newP);
- cursor.toCursor(p.newCursor());
- cursor.toEndToken();
- return newP;
- }
- return null;
- }
-
-
- /**
- *
- * @param cursor
- * @return the inserted table
- */
- public XWPFTable insertNewTbl(XmlCursor cursor) {
- if(isCursorInHdrF(cursor)){
- String uri = CTTbl.type.getName().getNamespaceURI();
- String localPart = "tbl";
- cursor.beginElement(localPart,uri);
- cursor.toParent();
- CTTbl t = (CTTbl)cursor.getObject();
- XWPFTable newT = new XWPFTable(t, this);
- cursor.removeXmlContents();
- XmlObject o = null;
- while(!(o instanceof CTTbl)&&(cursor.toPrevSibling())){
- o = cursor.getObject();
- }
- if(!(o instanceof CTTbl)){
- tables.add(0, newT);
- }
- else{
- int pos = tables.indexOf(getTable((CTTbl)o))+1;
- tables.add(pos,newT);
- }
- int i=0;
- cursor = t.newCursor();
- while(cursor.toPrevSibling()){
- o =cursor.getObject();
- if(o instanceof CTP || o instanceof CTTbl)
- i++;
- }
- bodyElements.add(i, newT);
- cursor = t.newCursor();
- cursor.toEndToken();
- return newT;
- }
- return null;
- }
-
- /**
- * verifies that cursor is on the right position
- * @param cursor
- */
- private boolean isCursorInHdrF(XmlCursor cursor) {
- XmlCursor verify = cursor.newCursor();
- verify.toParent();
- if(verify.getObject() == this.headerFooter){
- return true;
- }
- return false;
- }
-
-
- public POIXMLDocumentPart getOwner(){
- return this;
- }
-
- /**
- * Returns the table at position pos
- * @see org.apache.poi.xwpf.usermodel.IBody#getTableArray(int)
- */
- public XWPFTable getTableArray(int pos) {
-
- if(pos > 0 && pos < tables.size()){
- return tables.get(pos);
- }
- return null;
- }
-
- /**
- * inserts an existing XWPFTable to the arrays bodyElements and tables
- * @param pos
- * @param table
- */
- public void insertTable(int pos, XWPFTable table) {
- bodyElements.add(pos, table);
- int i;
- for (i = 0; i < headerFooter.getTblList().size(); i++) {
- CTTbl tbl = headerFooter.getTblArray(i);
- if(tbl == table.getCTTbl()){
- break;
- }
- }
- tables.add(i, table);
-
- }
-
- public void readHdrFtr(){
- bodyElements = new ArrayList<IBodyElement>();
+
+ public void readHdrFtr(){
+ bodyElements = new ArrayList<IBodyElement>();
paragraphs = new ArrayList<XWPFParagraph>();
tables= new ArrayList<XWPFTable>();
// parse the document with cursor and add
// the XmlObject to its lists
- XmlCursor cursor = headerFooter.newCursor();
+ XmlCursor cursor = headerFooter.newCursor();
cursor.selectPath("./*");
while (cursor.toNextSelection()) {
XmlObject o = cursor.getObject();
if (o instanceof CTP) {
- XWPFParagraph p = new XWPFParagraph((CTP)o, this);
- paragraphs.add(p);
- bodyElements.add(p);
+ XWPFParagraph p = new XWPFParagraph((CTP)o, this);
+ paragraphs.add(p);
+ bodyElements.add(p);
}
if (o instanceof CTTbl) {
- XWPFTable t = new XWPFTable((CTTbl)o, this);
- tables.add(t);
- bodyElements.add(t);
+ XWPFTable t = new XWPFTable((CTTbl)o, this);
+ tables.add(t);
+ bodyElements.add(t);
}
}
cursor.dispose();
- getAllPictures();
- }
-
- /**
- * get the TableCell which belongs to the TableCell
- * @param cell
- */
- public XWPFTableCell getTableCell(CTTc cell) {
- XmlCursor cursor = cell.newCursor();
- cursor.toParent();
- XmlObject o = cursor.getObject();
- if(!(o instanceof CTRow)){
- return null;
- }
- CTRow row = (CTRow)o;
- cursor.toParent();
- o = cursor.getObject();
+ }
+
+ /**
+ * get the TableCell which belongs to the TableCell
+ * @param cell
+ */
+ public XWPFTableCell getTableCell(CTTc cell) {
+ XmlCursor cursor = cell.newCursor();
+ cursor.toParent();
+ XmlObject o = cursor.getObject();
+ if(!(o instanceof CTRow)){
+ return null;
+ }
+ CTRow row = (CTRow)o;
+ cursor.toParent();
+ o = cursor.getObject();
cursor.dispose();
- if(! (o instanceof CTTbl)){
- return null;
- }
- CTTbl tbl = (CTTbl) o;
- XWPFTable table = getTable(tbl);
- if(table == null){
- return null;
- }
- XWPFTableRow tableRow = table.getRow(row);
- if(row == null){
- return null;
- }
- return tableRow.getTableCell(cell);
- }
-
+ if(! (o instanceof CTTbl)){
+ return null;
+ }
+ CTTbl tbl = (CTTbl) o;
+ XWPFTable table = getTable(tbl);
+ if(table == null){
+ return null;
+ }
+ XWPFTableRow tableRow = table.getRow(row);
+ if(row == null){
+ return null;
+ }
+ return tableRow.getTableCell(cell);
+ }
+
public XWPFDocument getXWPFDocument() {
if (document!=null) {
return document;
return (XWPFDocument)getParent();
}
}
+
+ /**
+ * returns the Part, to which the body belongs, which you need for adding relationship to other parts
+ * @see org.apache.poi.xwpf.usermodel.IBody#getPart()
+ */
+ public POIXMLDocumentPart getPart() {
+ return this;
+ }
}//end class
*
*/
public class XWPFNumbering extends POIXMLDocumentPart {
- private CTNumbering ctNumbering;
- protected List<XWPFAbstractNum> abstractNums;
- protected List<XWPFNum> nums;
- protected boolean isNew;
+ protected List<XWPFAbstractNum> abstractNums = new ArrayList<XWPFAbstractNum>();
+ protected List<XWPFNum> nums = new ArrayList<XWPFNum>();
+
+ private CTNumbering ctNumbering;
+ boolean isNew;
/**
*create a new styles object with an existing document
public XWPFNumbering(PackagePart part, PackageRelationship rel) throws IOException, OpenXML4JException{
super(part, rel);
isNew = true;
- onDocumentRead();
}
/**
*/
@Override
protected void onDocumentRead() throws IOException{
- abstractNums = new ArrayList<XWPFAbstractNum>();
- nums = new ArrayList<XWPFNum>();
NumberingDocument numberingDoc = null;
InputStream is;
is = getPackagePart().getInputStream();
protected void commit() throws IOException {
XmlOptions xmlOptions = new XmlOptions(DEFAULT_XML_OPTIONS);
xmlOptions.setSaveSyntheticDocumentElement(new QName(CTNumbering.type.getName().getNamespaceURI(), "numbering"));
- Map map = new HashMap();
+ Map<String,String> map = new HashMap<String,String>();
map.put("http://schemas.openxmlformats.org/markup-compatibility/2006", "ve");
map.put("urn:schemas-microsoft-com:office:office", "o");
map.put("http://schemas.openxmlformats.org/officeDocument/2006/relationships", "r");
import java.util.Collections;
import java.util.List;
+import org.apache.poi.POIXMLDocumentPart;
import org.apache.poi.util.Internal;
import org.apache.xmlbeans.XmlCursor;
import org.apache.xmlbeans.XmlObject;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STOnOff;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STTextAlignment;
-
/**
* Sketch of XWPF paragraph class
*/
-public class XWPFParagraph implements IBodyElement{
+public class XWPFParagraph implements IBodyElement {
private final CTP paragraph;
protected IBody part;
/** For access to the document's hyperlink, comments, tables etc */
protected XWPFDocument document;
protected List<XWPFRun> runs;
-
+
private StringBuffer footnoteText = new StringBuffer();
public XWPFParagraph(CTP prgrph, IBody part) {
* @return a new text run
*/
public XWPFRun createRun() {
- XWPFRun run = new XWPFRun(paragraph.addNewR(), this);
- runs.add(run);
- return run;
+ XWPFRun xwpfRun = new XWPFRun(paragraph.addNewR(), this);
+ runs.add(xwpfRun);
+ return xwpfRun;
}
/**
return false;
}
- /**
- * returns the type of the BodyElement Paragraph
- * @see org.apache.poi.xwpf.usermodel.IBodyElement#getElementType()
- */
- public BodyElementType getElementType() {
- return BodyElementType.PARAGRAPH;
- }
-
- /**
- * returns the part of the bodyElement
- * @see org.apache.poi.xwpf.usermodel.IBody#getPart()
- */
- public IBody getPart() {
- if(part != null){
- return part.getPart();
- }
- return null;
- }
+ /**
+ * returns the type of the BodyElement Paragraph
+ * @see org.apache.poi.xwpf.usermodel.IBodyElement#getElementType()
+ */
+ public BodyElementType getElementType() {
+ return BodyElementType.PARAGRAPH;
+ }
- /**
- * returns the partType of the bodyPart which owns the bodyElement
- * @see org.apache.poi.xwpf.usermodel.IBody#getPartType()
- */
- public BodyType getPartType() {
- return part.getPartType();
- }
-
- /**
- * adds a new Run to the Paragraph
- */
- public void addRun(XWPFRun r){
- runs.add(r);
- }
-
- /**
- * return the XWPFRun-Element which owns the CTR run-Element
- */
- public XWPFRun getRun(CTR r){
- for(int i=0; i < getRuns().size(); i++){
- if(getRuns().get(i).getCTR() == r) return getRuns().get(i);
- }
- return null;
- }
-
+ @Override
+ public IBody getBody()
+ {
+ return part;
+ }
+ /**
+ * returns the part of the bodyElement
+ * @see org.apache.poi.xwpf.usermodel.IBody#getPart()
+ */
+ public POIXMLDocumentPart getPart() {
+ if(part != null){
+ return part.getPart();
+ }
+ return null;
+ }
-}//end class
+ /**
+ * returns the partType of the bodyPart which owns the bodyElement
+ *
+ * @see org.apache.poi.xwpf.usermodel.IBody#getPartType()
+ */
+ public BodyType getPartType() {
+ return part.getPartType();
+ }
+ /**
+ * adds a new Run to the Paragraph
+ *
+ * @param r
+ * @return
+ */
+ public void addRun(XWPFRun r) {
+ if (!runs.contains(r)) {
+ runs.add(r);
+ }
+ }
+ /**
+ * return the XWPFRun-Element which owns the CTR run-Element
+ *
+ * @param r
+ * @return
+ */
+ public XWPFRun getRun(CTR r) {
+ for (int i = 0; i < getRuns().size(); i++) {
+ if (getRuns().get(i).getCTR() == r) {
+ return getRuns().get(i);
+ }
+ }
+ return null;
+ }
+}//end class
\ No newline at end of file
* @author Philipp Epp
*/
public class XWPFPicture {
- protected XWPFParagraph paragraph;
- private CTPicture ctPic;
+
+ private CTPicture ctPic;
private String description;
+ private XWPFRun run;
+
+ public XWPFPicture(CTPicture ctPic, XWPFRun run){
+ this.run = run;
+ this.ctPic = ctPic;
+ description = ctPic.getNvPicPr().getCNvPr().getDescr();
+ }
+
+ /**
+ * Link Picture with PictureData
+ * @param rel
+ */
+ public void setPictureReference(PackageRelationship rel){
+ ctPic.getBlipFill().getBlip().setEmbed(rel.getId());
+ }
- public XWPFParagraph getParagraph(){
- return paragraph;
- }
-
- public XWPFPicture(CTPicture ctPic, XWPFParagraph paragraph){
- this.paragraph = paragraph;
- this.ctPic = ctPic;
- description = ctPic.getNvPicPr().getCNvPr().getDescr();
- }
-
- /**
- * Link Picture with PictureData
- * @param rel
- */
- public void setPictureReference(PackageRelationship rel){
- ctPic.getBlipFill().getBlip().setEmbed(rel.getId());
- }
-
/**
* Return the underlying CTPicture bean that holds all properties for this picture
*
public CTPicture getCTPicture(){
return ctPic;
}
-
+
/**
* Get the PictureData of the Picture, if present.
* Note - not all kinds of picture have data
*/
public XWPFPictureData getPictureData(){
- String blipId = ctPic.getBlipFill().getBlip().getEmbed();
- for(POIXMLDocumentPart part: ((POIXMLDocumentPart) paragraph.getPart()).getRelations()){
- if(part.getPackageRelationship().getId().equals(blipId)){
- return (XWPFPictureData)part;
- }
- }
- return null;
+ String blipId = ctPic.getBlipFill().getBlip().getEmbed();
+ POIXMLDocumentPart part = run.getParagraph().getPart();
+ if (part != null)
+ {
+ POIXMLDocumentPart relatedPart = part.getRelationById(blipId);
+ if (relatedPart instanceof XWPFPictureData) {
+ return (XWPFPictureData) relatedPart;
+ }
+ }
+ return null;
}
public String getDescription() {
package org.apache.poi.xwpf.usermodel;
import java.io.IOException;
+import java.io.InputStream;
+import java.util.Arrays;
import org.apache.poi.POIXMLDocumentPart;
+import org.apache.poi.POIXMLException;
import org.apache.poi.POIXMLRelation;
+import org.apache.poi.openxml4j.opc.OPCPackage;
import org.apache.poi.openxml4j.opc.PackagePart;
import org.apache.poi.openxml4j.opc.PackageRelationship;
import org.apache.poi.util.IOUtils;
/**
* @author Philipp Epp
- *
*/
public class XWPFPictureData extends POIXMLDocumentPart {
-
+
/**
* Relationships for each known picture type
*/
protected static final POIXMLRelation[] RELATIONS;
static {
RELATIONS = new POIXMLRelation[9];
- RELATIONS[Document.PICTURE_TYPE_EMF] = XWPFRelation.IMAGE_EMF;
- RELATIONS[Document.PICTURE_TYPE_WMF] = XWPFRelation.IMAGE_WMF;
+ RELATIONS[Document.PICTURE_TYPE_EMF] = XWPFRelation.IMAGE_EMF;
+ RELATIONS[Document.PICTURE_TYPE_WMF] = XWPFRelation.IMAGE_WMF;
RELATIONS[Document.PICTURE_TYPE_PICT] = XWPFRelation.IMAGE_PICT;
RELATIONS[Document.PICTURE_TYPE_JPEG] = XWPFRelation.IMAGE_JPEG;
- RELATIONS[Document.PICTURE_TYPE_PNG] = XWPFRelation.IMAGE_PNG;
- RELATIONS[Document.PICTURE_TYPE_DIB] = XWPFRelation.IMAGE_DIB;
- RELATIONS[Document.PICTURE_TYPE_GIF] = XWPFRelation.IMAGE_GIF;
+ RELATIONS[Document.PICTURE_TYPE_PNG] = XWPFRelation.IMAGE_PNG;
+ RELATIONS[Document.PICTURE_TYPE_DIB] = XWPFRelation.IMAGE_DIB;
+ RELATIONS[Document.PICTURE_TYPE_GIF] = XWPFRelation.IMAGE_GIF;
}
+
+ private Long checksum = null;
+
/**
* Create a new XWPFGraphicData node
*
*/
- protected XWPFPictureData() {
+ protected XWPFPictureData() {
super();
}
* @param rel the package relationship holding this drawing,
* the relationship type must be http://schemas.openxmlformats.org/officeDocument/2006/relationships/image
*/
-
- public XWPFPictureData(PackagePart part, PackageRelationship rel) {
+ public XWPFPictureData(PackagePart part, PackageRelationship rel) {
super(part, rel);
}
-
+
+ @Override
+ protected void onDocumentRead() throws IOException {
+ super.onDocumentRead();
+ }
+
/**
* Gets the picture data as a byte array.
* <p>
* InputStream is = getPackagePart().getInputStream();
* </code>
* </p>
- *
* @return the Picture data.
*/
public byte[] getData() {
- try {
- return IOUtils.toByteArray(getPackagePart().getInputStream());
- } catch (IOException e) {
- // TODO Auto-generated catch block
- e.printStackTrace();
- }
- return null;
+ try {
+ return IOUtils.toByteArray(getPackagePart().getInputStream());
+ } catch (IOException e) {
+ throw new POIXMLException(e);
+ }
}
-
+
/**
- * Returns the file name of the image, eg image7.jpg .
- * The original filename isn't always available, but if it
- * can be found it's likely to be in the CTDrawing
+ * Returns the file name of the image, eg image7.jpg . The original filename
+ * isn't always available, but if it can be found it's likely to be in the
+ * CTDrawing
*/
public String getFileName() {
- String name = getPackagePart().getPartName().getName();
- if(name == null)
- return null;
- return name.substring(name.lastIndexOf('/') + 1);
+ String name = getPackagePart().getPartName().getName();
+ if (name == null)
+ return null;
+ return name.substring(name.lastIndexOf('/') + 1);
}
-
+
/**
* Suggests a file extension for this image.
- *
* @return the file extension.
*/
public String suggestFileExtension() {
return getPackagePart().getPartName().getExtension();
}
-
+
/**
* Return an integer constant that specifies type of this picture
- *
- * @return an integer constant that specifies type of this picture
+ *
+ * @return an integer constant that specifies type of this picture
* @see org.apache.poi.xwpf.usermodel.Document#PICTURE_TYPE_EMF
* @see org.apache.poi.xwpf.usermodel.Document#PICTURE_TYPE_WMF
* @see org.apache.poi.xwpf.usermodel.Document#PICTURE_TYPE_PICT
* @see org.apache.poi.xwpf.usermodel.Document#PICTURE_TYPE_PNG
* @see org.apache.poi.xwpf.usermodel.Document#PICTURE_TYPE_DIB
*/
- public int getPictureType(){
+ public int getPictureType() {
String contentType = getPackagePart().getContentType();
for (int i = 0; i < RELATIONS.length; i++) {
- if(RELATIONS[i] == null) continue;
+ if (RELATIONS[i] == null) {
+ continue;
+ }
- if(RELATIONS[i].getContentType().equals(contentType)){
+ if (RELATIONS[i].getContentType().equals(contentType)) {
return i;
}
}
return 0;
}
+
+ public Long getChecksum() {
+ if (this.checksum == null) {
+ InputStream is = null;
+ byte[] data;
+ try {
+ is = getPackagePart().getInputStream();
+ data = IOUtils.toByteArray(is);
+ } catch (IOException e) {
+ throw new POIXMLException(e);
+ } finally {
+ try {
+ is.close();
+ } catch (IOException e) {
+ throw new POIXMLException(e);
+ }
+ }
+ this.checksum = IOUtils.calculateChecksum(data);
+ }
+ return this.checksum;
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ /**
+ * In case two objects ARE equal, but its not the same instance, this
+ * implementation will always run through the whole
+ * byte-array-comparison before returning true. If this will turn into a
+ * performance issue, two possible approaches are available:<br>
+ * a) Use the checksum only and take the risk that two images might have
+ * the same CRC32 sum, although they are not the same.<br>
+ * b) Use a second (or third) checksum algorithm to minimise the chance
+ * that two images have the same checksums but are not equal (e.g.
+ * CRC32, MD5 and SHA-1 checksums, additionally compare the
+ * data-byte-array lengths).
+ */
+ if (obj == this) {
+ return true;
+ }
+
+ if (obj == null) {
+ return false;
+ }
+
+ if (!(obj instanceof XWPFPictureData)) {
+ return false;
+ }
+
+ XWPFPictureData picData = (XWPFPictureData) obj;
+ PackagePart foreignPackagePart = picData.getPackagePart();
+ PackagePart ownPackagePart = this.getPackagePart();
+
+ if ((foreignPackagePart != null && ownPackagePart == null)
+ || (foreignPackagePart == null && ownPackagePart != null)) {
+ return false;
+ }
+
+ if (ownPackagePart != null) {
+ OPCPackage foreignPackage = foreignPackagePart.getPackage();
+ OPCPackage ownPackage = ownPackagePart.getPackage();
+
+ if ((foreignPackage != null && ownPackage == null)
+ || (foreignPackage == null && ownPackage != null)) {
+ return false;
+ }
+ if (ownPackage != null) {
+
+ if (!ownPackage.equals(foreignPackage)) {
+ return false;
+ }
+ }
+ }
+
+ Long foreignChecksum = picData.getChecksum();
+ Long localChecksum = getChecksum();
+
+ if (!(localChecksum.equals(foreignChecksum))) {
+ return false;
+ }
+ return Arrays.equals(this.getData(), picData.getData());
+ }
+
+ @Override
+ public int hashCode() {
+ return getChecksum().hashCode();
+ }
}
import org.openxmlformats.schemas.drawingml.x2006.main.CTShapeProperties;
import org.openxmlformats.schemas.drawingml.x2006.main.CTTransform2D;
import org.openxmlformats.schemas.drawingml.x2006.main.STShapeType;
+import org.openxmlformats.schemas.drawingml.x2006.wordprocessingDrawing.CTAnchor;
import org.openxmlformats.schemas.drawingml.x2006.wordprocessingDrawing.CTInline;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTBr;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTDrawing;
public XWPFRun(CTR r, XWPFParagraph p) {
this.run = r;
this.paragraph = p;
-
+
+ /**
+ * reserve already occupied drawing ids, so reserving new ids later will
+ * not corrupt the document
+ */
+ List<CTDrawing> drawingList = r.getDrawingList();
+ for (CTDrawing ctDrawing : drawingList) {
+ List<CTAnchor> anchorList = ctDrawing.getAnchorList();
+ for (CTAnchor anchor : anchorList) {
+ if (anchor.getDocPr() != null) {
+ getDocument().getDrawingIdManager().reserve(anchor.getDocPr().getId());
+ }
+ }
+ List<CTInline> inlineList = ctDrawing.getInlineList();
+ for (CTInline inline : inlineList) {
+ if (inline.getDocPr() != null) {
+ getDocument().getDrawingIdManager().reserve(inline.getDocPr().getId());
+ }
+ }
+ }
+
// Look for any text in any of our pictures or drawings
StringBuffer text = new StringBuffer();
List<XmlObject> pictTextObjs = new ArrayList<XmlObject>();
pictTextObjs.addAll(r.getPictList());
- pictTextObjs.addAll(r.getDrawingList());
+ pictTextObjs.addAll(drawingList);
for(XmlObject o : pictTextObjs) {
- XmlObject[] t = o
- .selectPath("declare namespace w='http://schemas.openxmlformats.org/wordprocessingml/2006/main' .//w:t");
- for (int m = 0; m < t.length; m++) {
- NodeList kids = t[m].getDomNode().getChildNodes();
- for (int n = 0; n < kids.getLength(); n++) {
- if (kids.item(n) instanceof Text) {
- if(text.length() > 0)
- text.append("\n");
- text.append(kids.item(n).getNodeValue());
- }
- }
- }
+ XmlObject[] t = o.selectPath("declare namespace w='http://schemas.openxmlformats.org/wordprocessingml/2006/main' .//w:t");
+ for (int m = 0; m < t.length; m++) {
+ NodeList kids = t[m].getDomNode().getChildNodes();
+ for (int n = 0; n < kids.getLength(); n++) {
+ if (kids.item(n) instanceof Text) {
+ if(text.length() > 0)
+ text.append("\n");
+ text.append(kids.item(n).getNodeValue());
+ }
+ }
+ }
}
pictureText = text.toString();
-
+
// Do we have any embedded pictures?
// (They're a different CTPicture, under the drawingml namespace)
pictures = new ArrayList<XWPFPicture>();
for(XmlObject o : pictTextObjs) {
- for(CTPicture pict : getCTPictures(o)) {
- XWPFPicture picture = new XWPFPicture( pict, p );
- pictures.add(picture);
- }
+ for(CTPicture pict : getCTPictures(o)) {
+ XWPFPicture picture = new XWPFPicture(pict, this);
+ pictures.add(picture);
+ }
}
}
-
+
private List<CTPicture> getCTPictures(XmlObject o) {
- List<CTPicture> pictures = new ArrayList<CTPicture>();
- XmlObject[] picts = o.selectPath("declare namespace pic='"+CTPicture.type.getName().getNamespaceURI()+"' .//pic:pic");
- for(XmlObject pict : picts) {
- if(pict instanceof XmlAnyTypeImpl) {
- // Pesky XmlBeans bug - see Bugzilla #49934
- try {
- pict = CTPicture.Factory.parse( pict.toString() );
- } catch(XmlException e) {
- throw new POIXMLException(e);
- }
- }
- if(pict instanceof CTPicture) {
- pictures.add((CTPicture)pict);
- }
- }
- return pictures;
+ List<CTPicture> pictures = new ArrayList<CTPicture>();
+ XmlObject[] picts = o.selectPath("declare namespace pic='"+CTPicture.type.getName().getNamespaceURI()+"' .//pic:pic");
+ for(XmlObject pict : picts) {
+ if(pict instanceof XmlAnyTypeImpl) {
+ // Pesky XmlBeans bug - see Bugzilla #49934
+ try {
+ pict = CTPicture.Factory.parse( pict.toString() );
+ } catch(XmlException e) {
+ throw new POIXMLException(e);
+ }
+ }
+ if(pict instanceof CTPicture) {
+ pictures.add((CTPicture)pict);
+ }
+ }
+ return pictures;
}
/**
public XWPFParagraph getParagraph() {
return paragraph;
}
-
+
+ /**
+ * @return The {@link XWPFDocument} instance, this run belongs to, or
+ * <code>null</code> if parent structure (paragraph > document) is not properly set.
+ */
+ public XWPFDocument getDocument() {
+ if (paragraph != null) {
+ return paragraph.getDocument();
+ }
+ return null;
+ }
+
/**
* For isBold, isItalic etc
*/
private boolean isCTOnOff(CTOnOff onoff) {
- if(! onoff.isSetVal())
- return true;
- if(onoff.getVal() == STOnOff.ON)
- return true;
- if(onoff.getVal() == STOnOff.TRUE)
- return true;
- return false;
+ if(! onoff.isSetVal())
+ return true;
+ if(onoff.getVal() == STOnOff.ON)
+ return true;
+ if(onoff.getVal() == STOnOff.TRUE)
+ return true;
+ return false;
}
/**
*/
public boolean isBold() {
CTRPr pr = run.getRPr();
- if(pr == null || !pr.isSetB())
- return false;
+ if(pr == null || !pr.isSetB()) {
+ return false;
+ }
return isCTOnOff(pr.getB());
}
return run.sizeOfTArray() == 0 ? null : run.getTArray(pos)
.getStringValue();
}
-
+
/**
* Returns text embedded in pictures
*/
* @param value the literal text which shall be displayed in the document
*/
public void setText(String value) {
- setText(value,run.getTList().size());
+ setText(value,run.getTList().size());
}
/**
* @param pos - position in the text array (NB: 0 based)
*/
public void setText(String value, int pos) {
- if(pos > run.sizeOfTArray()) throw new ArrayIndexOutOfBoundsException("Value too large for the parameter position in XWPFRun.setText(String value,int pos)");
+ if(pos > run.sizeOfTArray()) throw new ArrayIndexOutOfBoundsException("Value too large for the parameter position in XWPFRun.setText(String value,int pos)");
CTText t = (pos < run.sizeOfTArray() && pos >= 0) ? run.getTArray(pos) : run.addNewT();
t.setStringValue(value);
preserveSpaces(t);
}
-
/**
* Whether the italic property should be applied to all non-complex script
* characters in the contents of this run when displayed in a document.
public boolean isItalic() {
CTRPr pr = run.getRPr();
if(pr == null || !pr.isSetI())
- return false;
+ return false;
return isCTOnOff(pr.getI());
}
public UnderlinePatterns getUnderline() {
CTRPr pr = run.getRPr();
return (pr != null && pr.isSetU()) ? UnderlinePatterns.valueOf(pr
- .getU().getVal().intValue()) : UnderlinePatterns.NONE;
+ .getU().getVal().intValue()) : UnderlinePatterns.NONE;
}
/**
public boolean isStrike() {
CTRPr pr = run.getRPr();
if(pr == null || !pr.isSetStrike())
- return false;
+ return false;
return isCTOnOff(pr.getStrike());
}
*/
public VerticalAlign getSubscript() {
CTRPr pr = run.getRPr();
- return (pr != null && pr.isSetVertAlign()) ? VerticalAlign.valueOf(pr
- .getVertAlign().getVal().intValue()) : VerticalAlign.BASELINE;
+ return (pr != null && pr.isSetVertAlign()) ? VerticalAlign.valueOf(pr.getVertAlign().getVal().intValue()) : VerticalAlign.BASELINE;
}
/**
* @param size
*/
public void setFontSize(int size) {
- BigInteger bint=new BigInteger(""+size);
+ BigInteger bint=new BigInteger(""+size);
CTRPr pr = run.isSetRPr() ? run.getRPr() : run.addNewRPr();
CTHpsMeasure ctSize = pr.isSetSz() ? pr.getSz() : pr.addNewSz();
ctSize.setVal(bint.multiply(new BigInteger("2")));
* @param val
*/
public void setTextPosition(int val) {
- BigInteger bint=new BigInteger(""+val);
+ BigInteger bint=new BigInteger(""+val);
CTRPr pr = run.isSetRPr() ? run.getRPr() : run.addNewRPr();
CTSignedHpsMeasure position = pr.isSetPosition() ? pr.getPosition() : pr.addNewPosition();
position.setVal(bint);
*
*/
public void removeBreak() {
- // TODO
+ // TODO
}
/**
* @see #addCarriageReturn()
*/
public void addBreak() {
- run.addNewBr();
+ run.addNewBr();
}
/**
* @see BreakType
*/
public void addBreak(BreakType type){
- CTBr br=run.addNewBr();
- br.setType(STBrType.Enum.forInt(type.getValue()));
+ CTBr br=run.addNewBr();
+ br.setType(STBrType.Enum.forInt(type.getValue()));
}
-
/**
* Specifies that a break shall be placed at the current location in the run
* content. A break is a special character which is used to override the
* @see BreakClear
*/
public void addBreak(BreakClear clear){
- CTBr br=run.addNewBr();
- br.setType(STBrType.Enum.forInt(BreakType.TEXT_WRAPPING.getValue()));
- br.setClear(STBrClear.Enum.forInt(clear.getValue()));
+ CTBr br=run.addNewBr();
+ br.setType(STBrType.Enum.forInt(BreakType.TEXT_WRAPPING.getValue()));
+ br.setClear(STBrClear.Enum.forInt(clear.getValue()));
}
/**
* restarted on the next available line in the document.
*/
public void addCarriageReturn() {
- run.addNewCr();
+ run.addNewCr();
}
public void removeCarriageReturn() {
- //TODO
- }
-
+ //TODO
+ }
+
/**
* Adds a picture to the run. This method handles
* attaching the picture data to the overall file.
*
* @param pictureData The raw picture data
* @param pictureType The type of the picture, eg {@link Document#PICTURE_TYPE_JPEG}
- * @throws IOException
- * @throws org.apache.poi.openxml4j.exceptions.InvalidFormatException
- * @throws IOException
+ * @throws IOException
+ * @throws org.apache.poi.openxml4j.exceptions.InvalidFormatException
+ * @throws IOException
*/
public XWPFPicture addPicture(InputStream pictureData, int pictureType, String filename, int width, int height)
throws InvalidFormatException, IOException {
- XWPFDocument doc = paragraph.document;
-
- // Add the picture + relationship
- int picNumber = doc.addPicture(pictureData, pictureType);
- XWPFPictureData picData = doc.getAllPackagePictures().get(picNumber);
-
- // Create the drawing entry for it
- try {
- CTDrawing drawing = run.addNewDrawing();
- CTInline inline = drawing.addNewInline();
-
- // Do the fiddly namespace bits on the inline
- // (We need full control of what goes where and as what)
- String xml =
- "<a:graphic xmlns:a=\"" + CTGraphicalObject.type.getName().getNamespaceURI() + "\">" +
- "<a:graphicData uri=\"" + CTGraphicalObject.type.getName().getNamespaceURI() + "\">" +
- "<pic:pic xmlns:pic=\"" + CTPicture.type.getName().getNamespaceURI() + "\" />" +
- "</a:graphicData>" +
- "</a:graphic>";
- inline.set(XmlToken.Factory.parse(xml));
-
- // Setup the inline
- inline.setDistT(0);
- inline.setDistR(0);
- inline.setDistB(0);
- inline.setDistL(0);
-
- CTNonVisualDrawingProps docPr = inline.addNewDocPr();
- docPr.setId(picNumber);
- docPr.setName("Picture " + picNumber);
- docPr.setDescr(filename);
-
- CTPositiveSize2D extent = inline.addNewExtent();
- extent.setCx(width);
- extent.setCy(height);
-
- // Grab the picture object
- CTGraphicalObject graphic = inline.getGraphic();
- CTGraphicalObjectData graphicData = graphic.getGraphicData();
- CTPicture pic = getCTPictures(graphicData).get(0);
-
- // Set it up
- CTPictureNonVisual nvPicPr = pic.addNewNvPicPr();
-
- CTNonVisualDrawingProps cNvPr = nvPicPr.addNewCNvPr();
- cNvPr.setId(picNumber);
- cNvPr.setName("Picture " + picNumber);
- cNvPr.setDescr(filename);
-
- CTNonVisualPictureProperties cNvPicPr = nvPicPr.addNewCNvPicPr();
- cNvPicPr.addNewPicLocks().setNoChangeAspect(true);
-
- CTBlipFillProperties blipFill = pic.addNewBlipFill();
- CTBlip blip = blipFill.addNewBlip();
- blip.setEmbed( picData.getPackageRelationship().getId() );
- blipFill.addNewStretch().addNewFillRect();
-
- CTShapeProperties spPr = pic.addNewSpPr();
- CTTransform2D xfrm = spPr.addNewXfrm();
-
- CTPoint2D off = xfrm.addNewOff();
- off.setX(0);
- off.setY(0);
-
- CTPositiveSize2D ext = xfrm.addNewExt();
- ext.setCx(width);
- ext.setCy(height);
-
- CTPresetGeometry2D prstGeom = spPr.addNewPrstGeom();
- prstGeom.setPrst(STShapeType.RECT);
- prstGeom.addNewAvLst();
-
- // Finish up
- XWPFPicture xwpfPicture = new XWPFPicture(pic, paragraph);
- pictures.add(xwpfPicture);
- return xwpfPicture;
- } catch(XmlException e) {
- throw new IllegalStateException(e);
- }
- }
-
+ XWPFDocument doc = paragraph.document;
+
+ // Add the picture + relationship
+ String relationId = doc.addPictureData(pictureData, pictureType);
+ XWPFPictureData picData = (XWPFPictureData) doc.getRelationById(relationId);
+
+ // Create the drawing entry for it
+ try {
+ CTDrawing drawing = run.addNewDrawing();
+ CTInline inline = drawing.addNewInline();
+
+ // Do the fiddly namespace bits on the inline
+ // (We need full control of what goes where and as what)
+ String xml =
+ "<a:graphic xmlns:a=\"" + CTGraphicalObject.type.getName().getNamespaceURI() + "\">" +
+ "<a:graphicData uri=\"" + CTGraphicalObject.type.getName().getNamespaceURI() + "\">" +
+ "<pic:pic xmlns:pic=\"" + CTPicture.type.getName().getNamespaceURI() + "\" />" +
+ "</a:graphicData>" +
+ "</a:graphic>";
+ inline.set(XmlToken.Factory.parse(xml));
+
+ // Setup the inline
+ inline.setDistT(0);
+ inline.setDistR(0);
+ inline.setDistB(0);
+ inline.setDistL(0);
+
+ CTNonVisualDrawingProps docPr = inline.addNewDocPr();
+ long id = getParagraph().document.getDrawingIdManager().reserveNew();
+ docPr.setId(id);
+ /* This name is not visible in Word 2010 anywhere. */
+ docPr.setName("Drawing " + id);
+ docPr.setDescr(filename);
+
+ CTPositiveSize2D extent = inline.addNewExtent();
+ extent.setCx(width);
+ extent.setCy(height);
+
+ // Grab the picture object
+ CTGraphicalObject graphic = inline.getGraphic();
+ CTGraphicalObjectData graphicData = graphic.getGraphicData();
+ CTPicture pic = getCTPictures(graphicData).get(0);
+
+ // Set it up
+ CTPictureNonVisual nvPicPr = pic.addNewNvPicPr();
+
+ CTNonVisualDrawingProps cNvPr = nvPicPr.addNewCNvPr();
+ /* use "0" for the id. See ECM-576, 20.2.2.3 */
+ cNvPr.setId(0L);
+ /* This name is not visible in Word 2010 anywhere */
+ cNvPr.setName("Picture " + id);
+ cNvPr.setDescr(filename);
+
+ CTNonVisualPictureProperties cNvPicPr = nvPicPr.addNewCNvPicPr();
+ cNvPicPr.addNewPicLocks().setNoChangeAspect(true);
+
+ CTBlipFillProperties blipFill = pic.addNewBlipFill();
+ CTBlip blip = blipFill.addNewBlip();
+ blip.setEmbed( picData.getPackageRelationship().getId() );
+ blipFill.addNewStretch().addNewFillRect();
+
+ CTShapeProperties spPr = pic.addNewSpPr();
+ CTTransform2D xfrm = spPr.addNewXfrm();
+
+ CTPoint2D off = xfrm.addNewOff();
+ off.setX(0);
+ off.setY(0);
+
+ CTPositiveSize2D ext = xfrm.addNewExt();
+ ext.setCx(width);
+ ext.setCy(height);
+
+ CTPresetGeometry2D prstGeom = spPr.addNewPrstGeom();
+ prstGeom.setPrst(STShapeType.RECT);
+ prstGeom.addNewAvLst();
+
+ // Finish up
+ XWPFPicture xwpfPicture = new XWPFPicture(pic, this);
+ pictures.add(xwpfPicture);
+ return xwpfPicture;
+ } catch(XmlException e) {
+ throw new IllegalStateException(e);
+ }
+ }
+
/**
* Returns the embedded pictures of the run. These
* are pictures which reference an external,
* embedded picture image such as a .png or .jpg
*/
public List<XWPFPicture> getEmbeddedPictures() {
- return pictures;
+ return pictures;
}
/**
* carriage returns in place of their xml equivalents.
*/
public String toString() {
- StringBuffer text = new StringBuffer();
-
- // Grab the text and tabs of the text run
- // Do so in a way that preserves the ordering
- XmlCursor c = run.newCursor();
- c.selectPath("./*");
- while (c.toNextSelection()) {
- XmlObject o = c.getObject();
- if (o instanceof CTText) {
- String tagName = o.getDomNode().getNodeName();
- // Field Codes (w:instrText, defined in spec sec. 17.16.23)
- // come up as instances of CTText, but we don't want them
- // in the normal text output
- if (!"w:instrText".equals(tagName)) {
- text.append(((CTText) o).getStringValue());
- }
- }
-
- if (o instanceof CTPTab) {
- text.append("\t");
- }
- if (o instanceof CTBr) {
- text.append("\n");
- }
- if (o instanceof CTEmpty) {
- // Some inline text elements get returned not as
- // themselves, but as CTEmpty, owing to some odd
- // definitions around line 5642 of the XSDs
- // This bit works around it, and replicates the above
- // rules for that case
- String tagName = o.getDomNode().getNodeName();
- if ("w:tab".equals(tagName)) {
- text.append("\t");
- }
- if ("w:br".equals(tagName)) {
- text.append("\n");
- }
- if ("w:cr".equals(tagName)) {
- text.append("\n");
- }
- }
- }
-
- c.dispose();
-
- // Any picture text?
- if(pictureText != null && pictureText.length() > 0) {
- text.append("\n").append(pictureText);
- }
-
- return text.toString();
+ StringBuffer text = new StringBuffer();
+
+ // Grab the text and tabs of the text run
+ // Do so in a way that preserves the ordering
+ XmlCursor c = run.newCursor();
+ c.selectPath("./*");
+ while (c.toNextSelection()) {
+ XmlObject o = c.getObject();
+ if (o instanceof CTText) {
+ String tagName = o.getDomNode().getNodeName();
+ // Field Codes (w:instrText, defined in spec sec. 17.16.23)
+ // come up as instances of CTText, but we don't want them
+ // in the normal text output
+ if (!"w:instrText".equals(tagName)) {
+ text.append(((CTText) o).getStringValue());
+ }
+ }
+
+ if (o instanceof CTPTab) {
+ text.append("\t");
+ }
+ if (o instanceof CTBr) {
+ text.append("\n");
+ }
+ if (o instanceof CTEmpty) {
+ // Some inline text elements get returned not as
+ // themselves, but as CTEmpty, owing to some odd
+ // definitions around line 5642 of the XSDs
+ // This bit works around it, and replicates the above
+ // rules for that case
+ String tagName = o.getDomNode().getNodeName();
+ if ("w:tab".equals(tagName)) {
+ text.append("\t");
+ }
+ if ("w:br".equals(tagName)) {
+ text.append("\n");
+ }
+ if ("w:cr".equals(tagName)) {
+ text.append("\n");
+ }
+ }
+ }
+
+ c.dispose();
+
+ // Any picture text?
+ if(pictureText != null && pictureText.length() > 0) {
+ text.append("\n").append(pictureText);
+ }
+
+ return text.toString();
}
}
public XWPFSettings(PackagePart part, PackageRelationship rel) throws IOException {
super(part, rel);
- readFrom(part.getInputStream());
}
public XWPFSettings() {
ctSettings = CTSettings.Factory.newInstance();
}
+ @Override
+ protected void onDocumentRead() throws IOException
+ {
+ super.onDocumentRead();
+ readFrom(getPackagePart().getInputStream());
+ }
+
/**
* Set zoom.<br/>
* In the zoom tag inside settings.xml file <br/>
* it sets the value of zoom
* <br/>
- * sample snippet from settings.xml
+ * sample snippet from settings.xml
* <pre>
- * <w:zoom w:percent="50" />
+ * <w:zoom w:percent="50" />
* <pre>
* @return percentage as an integer of zoom level
*/
public long getZoomPercent() {
- CTZoom zoom;
+ CTZoom zoom;
if (!ctSettings.isSetZoom()) {
zoom = ctSettings.addNewZoom();
} else {
import java.util.HashMap;
import java.util.List;
import java.util.Map;
-import java.lang.String;
import javax.xml.namespace.QName;
*
*/
public class XWPFStyles extends POIXMLDocumentPart{
- private CTStyles ctStyles;
- protected XWPFLatentStyles latentStyles;
- protected List<XWPFStyle> listStyle;
-
- /**
+
+ private List<XWPFStyle> listStyle = new ArrayList<XWPFStyle>();
+ private CTStyles ctStyles;
+ XWPFLatentStyles latentStyles;
+
+ /**
* Construct XWPFStyles from a package part
*
* @param part the package part holding the data of the styles,
public XWPFStyles(PackagePart part, PackageRelationship rel) throws IOException, OpenXML4JException{
super(part, rel);
- onDocumentRead();
}
/**
* Construct XWPFStyles from scratch for a new document.
*/
public XWPFStyles() {
- listStyle = new ArrayList<XWPFStyle>();
}
/**
*/
@Override
protected void onDocumentRead ()throws IOException{
- listStyle = new ArrayList<XWPFStyle>();
StylesDocument stylesDoc;
try {
InputStream is = getPackagePart().getInputStream();
protected void commit() throws IOException {
XmlOptions xmlOptions = new XmlOptions(DEFAULT_XML_OPTIONS);
xmlOptions.setSaveSyntheticDocumentElement(new QName(CTStyles.type.getName().getNamespaceURI(), "styles"));
- Map map = new HashMap();
+ Map<String,String> map = new HashMap<String,String>();
map.put("http://schemas.openxmlformats.org/officeDocument/2006/relationships", "r");
map.put("http://schemas.openxmlformats.org/wordprocessingml/2006/main", "w");
xmlOptions.setSaveSuggestedPrefixes(map);
import java.util.ArrayList;
import java.util.List;
+import org.apache.poi.POIXMLDocumentPart;
import org.apache.poi.util.Internal;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTRow;
}
}
-
public XWPFTable(CTTbl table, IBody part){
this.part = part;
this.ctTbl = table;
return text.toString();
}
-
public void addNewRowBetween(int start, int end) {
// TODO
}
-
/**
* add a new column for each row in this table
*/
public void addNewCol() {
- if (ctTbl.sizeOfTrArray() == 0) createRow();
+ if (ctTbl.sizeOfTrArray() == 0) {
+ createRow();
+ }
for (int i = 0; i < ctTbl.sizeOfTrArray(); i++) {
XWPFTableRow tabRow = new XWPFTableRow(ctTbl.getTrArray(i), this);
tabRow.createCell();
* @param pos position the Row in the Table
*/
public boolean removeRow(int pos) throws IndexOutOfBoundsException {
- if(pos > 0 && pos < tableRows.size()){
- ctTbl.removeTr(pos);
- tableRows.remove(pos);
- return true;
- }
- return false;
+ if (pos >= 0 && pos < tableRows.size()) {
+ ctTbl.removeTr(pos);
+ tableRows.remove(pos);
+ return true;
+ }
+ return false;
}
public List<XWPFTableRow> getRows() {
return BodyElementType.TABLE;
}
+ @Override
+ public IBody getBody()
+ {
+ return part;
+ }
- /**
- * returns the part of the bodyElement
- * @see org.apache.poi.xwpf.usermodel.IBody#getPart()
- */
- public IBody getPart() {
- if(part != null){
- return part.getPart();
- }
- return null;
- }
-
+ /**
+ * returns the part of the bodyElement
+ * @see org.apache.poi.xwpf.usermodel.IBody#getPart()
+ */
+ public POIXMLDocumentPart getPart() {
+ if(part != null){
+ return part.getPart();
+ }
+ return null;
+ }
- /**
- * returns the partType of the bodyPart which owns the bodyElement
- * @see org.apache.poi.xwpf.usermodel.IBody#getPartType()
- */
- public BodyType getPartType() {
- return ((IBody)part).getPartType();
- }
+ /**
+ * returns the partType of the bodyPart which owns the bodyElement
+ * @see org.apache.poi.xwpf.usermodel.IBody#getPartType()
+ */
+ public BodyType getPartType() {
+ return part.getPartType();
+ }
/**
* returns the XWPFRow which belongs to the CTRow row
import java.util.Collections;
import java.util.List;
+import org.apache.poi.POIXMLDocumentPart;
import org.apache.poi.util.Internal;
import org.apache.xmlbeans.XmlCursor;
import org.apache.xmlbeans.XmlObject;
return null;
}
-
-
-
- /**
- * get the to which the TableCell belongs
- * @see org.apache.poi.xwpf.usermodel.IBody#getPart()
- */
- public IBody getPart() {
- return tableRow.getTable().getPart();
- }
+ /**
+ * get the to which the TableCell belongs
+ *
+ * @see org.apache.poi.xwpf.usermodel.IBody#getPart()
+ */
+ public POIXMLDocumentPart getPart() {
+ return tableRow.getTable().getPart();
+ }
/**
* @return the newly created XWPFTableCell
*/
public XWPFTableCell createCell() {
- XWPFTableCell tableCell = new XWPFTableCell(ctRow.addNewTc(), this, table.getPart());
+ XWPFTableCell tableCell = new XWPFTableCell(ctRow.addNewTc(), this, table.getBody());
tableCells.add(tableCell);
return tableCell;
}
*/
public XWPFTableCell addNewTableCell(){
CTTc cell = ctRow.addNewTc();
- XWPFTableCell tableCell = new XWPFTableCell(cell, this, table.getPart());
+ XWPFTableCell tableCell = new XWPFTableCell(cell, this, table.getBody());
tableCells.add(tableCell);
return tableCell;
}
if(tableCells == null){
List<XWPFTableCell> cells = new ArrayList<XWPFTableCell>();
for (CTTc tableCell : ctRow.getTcList()) {
- cells.add(new XWPFTableCell(tableCell, this, table.getPart()));
+ cells.add(new XWPFTableCell(tableCell, this, table.getBody()));
}
this.tableCells = cells;
}
PackageHelper.open(POIDataSamples.getDocumentInstance().openResourceAsStream("WordWithAttachments.docx"))
);
}
+
+ public void testRelationOrder() throws Exception {
+ OPCPackage pkg = PackageHelper.open(POIDataSamples.getDocumentInstance().openResourceAsStream("WordWithAttachments.docx"));
+ OPCParser doc = new OPCParser(pkg);
+ doc.parse(new TestFactory());
+
+ for(POIXMLDocumentPart rel : doc.getRelations()){
+ System.out.println(rel);
+ }
+
+ }
}
--- /dev/null
+/* ====================================================================
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (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.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+==================================================================== */
+
+package org.apache.poi;
+
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+
+import junit.framework.TestCase;
+
+import org.apache.poi.openxml4j.opc.OPCPackage;
+import org.apache.poi.openxml4j.opc.PackagePart;
+import org.apache.poi.openxml4j.opc.PackageRelationship;
+import org.apache.poi.util.TempFile;
+import org.apache.poi.util.PackageHelper;
+
+/**
+ * Test recursive read and write of OPC packages
+ */
+public final class TestPOIXMLDocumentPart extends TestCase {
+
+ private static class OPCParser extends POIXMLDocument {
+
+ public OPCParser(OPCPackage pkg) {
+ super(pkg);
+ }
+
+ public List<PackagePart> getAllEmbedds() {
+ throw new RuntimeException("not supported");
+ }
+
+ public void parse(POIXMLFactory factory) throws IOException{
+ load(factory);
+ }
+ }
+
+ private static final class TestFactory extends POIXMLFactory {
+
+ public TestFactory() {
+ //
+ }
+ public POIXMLDocumentPart createDocumentPart(POIXMLDocumentPart parent, PackageRelationship rel, PackagePart part){
+ return new POIXMLDocumentPart(part, rel);
+ }
+
+ public POIXMLDocumentPart newDocumentPart(POIXMLRelation descriptor){
+ throw new RuntimeException("not supported");
+ }
+
+ }
+
+ /**
+ * Recursively traverse a OOXML document and assert that same logical parts have the same physical instances
+ */
+ private static void traverse(POIXMLDocumentPart part, HashMap<String,POIXMLDocumentPart> context) throws IOException{
+ context.put(part.getPackageRelationship().getTargetURI().toString(), part);
+ for(POIXMLDocumentPart p : part.getRelations()){
+ String uri = p.getPackageRelationship().getTargetURI().toString();
+ if (!context.containsKey(uri)) {
+ traverse(p, context);
+ } else {
+ POIXMLDocumentPart prev = context.get(uri);
+ assertSame("Duplicate POIXMLDocumentPart instance for targetURI=" + uri, prev, p);
+ }
+ }
+ }
+
+ public void assertReadWrite(OPCPackage pkg1) throws Exception {
+
+ OPCParser doc = new OPCParser(pkg1);
+ doc.parse(new TestFactory());
+
+ HashMap<String,POIXMLDocumentPart> context = new HashMap<String,POIXMLDocumentPart>();
+ traverse(doc, context);
+ context.clear();
+
+ File tmp = TempFile.createTempFile("poi-ooxml", ".tmp");
+ FileOutputStream out = new FileOutputStream(tmp);
+ doc.write(out);
+ out.close();
+
+ OPCPackage pkg2 = OPCPackage.open(tmp.getAbsolutePath());
+
+ doc = new OPCParser(pkg1);
+ doc.parse(new TestFactory());
+ context = new HashMap<String,POIXMLDocumentPart>();
+ traverse(doc, context);
+ context.clear();
+
+ assertEquals(pkg1.getRelationships().size(), pkg2.getRelationships().size());
+
+ ArrayList<PackagePart> l1 = pkg1.getParts();
+ ArrayList<PackagePart> l2 = pkg2.getParts();
+
+ assertEquals(l1.size(), l2.size());
+ for (int i=0; i < l1.size(); i++){
+ PackagePart p1 = l1.get(i);
+ PackagePart p2 = l2.get(i);
+
+ assertEquals(p1.getContentType(), p2.getContentType());
+ assertEquals(p1.hasRelationships(), p2.hasRelationships());
+ if(p1.hasRelationships()){
+ assertEquals(p1.getRelationships().size(), p2.getRelationships().size());
+ }
+ assertEquals(p1.getPartName(), p2.getPartName());
+ }
+ }
+
+ public void testPPTX() throws Exception {
+ assertReadWrite(
+ PackageHelper.open(POIDataSamples.getSlideShowInstance().openResourceAsStream("PPTWithAttachments.pptm"))
+ );
+ }
+
+ public void testXLSX() throws Exception {
+ assertReadWrite(
+ PackageHelper.open(POIDataSamples.getSpreadSheetInstance().openResourceAsStream("ExcelWithAttachments.xlsm"))
+ );
+ }
+
+ public void testDOCX() throws Exception {
+ assertReadWrite(
+ PackageHelper.open(POIDataSamples.getDocumentInstance().openResourceAsStream("WordWithAttachments.docx"))
+ );
+ }
+}
package org.apache.poi;
-import java.util.*;
+import java.io.IOException;
+import java.util.Calendar;
+import java.util.Date;
+import java.util.GregorianCalendar;
+import java.util.Locale;
+import java.util.TimeZone;
import junit.framework.TestCase;
import org.apache.poi.POIXMLProperties.CoreProperties;
+import org.apache.poi.openxml4j.util.Nullable;
import org.apache.poi.xssf.XSSFTestDataSamples;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import org.apache.poi.xwpf.XWPFTestDataSamples;
import org.apache.poi.xwpf.usermodel.XWPFDocument;
-import org.apache.poi.openxml4j.util.Nullable;
/**
* Test setting extended and custom OOXML properties
private POIXMLProperties _props;
private CoreProperties _coreProperties;
- public void setUp() {
+ public void setUp() throws IOException {
XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("documentProperties.docx");
_props = sampleDoc.getProperties();
_coreProperties = _props.getCoreProperties();
assertEquals("Hello World", title);
}
- public void testTransitiveSetters() {
+ public void testTransitiveSetters() throws IOException {
XWPFDocument doc = new XWPFDocument();
CoreProperties cp = doc.getProperties().getCoreProperties();
import java.io.OutputStream;
import java.lang.reflect.Field;
import java.net.URI;
-import java.util.TreeMap;
-import java.util.Iterator;
+import java.util.*;
+import java.util.regex.Pattern;
import junit.framework.TestCase;
f.setAccessible(true);
return (ContentTypeManager)f.get(pkg);
}
+
+ public void testGetPartsByName() throws Exception {
+ String filepath = OpenXML4JTestDataSamples.getSampleFileName("sample.docx");
+
+ OPCPackage pkg = OPCPackage.open(filepath, PackageAccess.READ_WRITE);
+ List<PackagePart> rs = pkg.getPartsByName(Pattern.compile("/word/.*?\\.xml"));
+ HashMap<String, PackagePart> selected = new HashMap<String, PackagePart>();
+
+ for(PackagePart p : rs)
+ selected.put(p.getPartName().getName(), p);
+
+ assertEquals(6, selected.size());
+ assertTrue(selected.containsKey("/word/document.xml"));
+ assertTrue(selected.containsKey("/word/fontTable.xml"));
+ assertTrue(selected.containsKey("/word/settings.xml"));
+ assertTrue(selected.containsKey("/word/styles.xml"));
+ assertTrue(selected.containsKey("/word/theme/theme1.xml"));
+ assertTrue(selected.containsKey("/word/webSettings.xml"));
+ }
}
--- /dev/null
+package org.apache.poi.util;\r
+\r
+import junit.framework.TestCase;\r
+\r
+public class TestIdentifierManager extends TestCase\r
+{\r
+ public void testBasic()\r
+ {\r
+ IdentifierManager manager = new IdentifierManager(0L,100L);\r
+ assertEquals(101L,manager.getRemainingIdentifiers());\r
+ assertEquals(0L,manager.reserveNew());\r
+ assertEquals(100L,manager.getRemainingIdentifiers());\r
+ assertEquals(1L,manager.reserve(0L));\r
+ assertEquals(99L,manager.getRemainingIdentifiers());\r
+ }\r
+\r
+ public void testLongLimits()\r
+ {\r
+ long min = IdentifierManager.MIN_ID;\r
+ long max = IdentifierManager.MAX_ID;\r
+ IdentifierManager manager = new IdentifierManager(min,max);\r
+ assertTrue("Limits lead to a long variable overflow", max - min + 1 > 0);\r
+ assertTrue("Limits lead to a long variable overflow", manager.getRemainingIdentifiers() > 0);\r
+ assertEquals(min,manager.reserveNew());\r
+ assertEquals(max,manager.reserve(max));\r
+ assertEquals(max - min -1, manager.getRemainingIdentifiers());\r
+ manager.release(max);\r
+ manager.release(min);\r
+ }\r
+ \r
+ public void testReserve()\r
+ {\r
+ IdentifierManager manager = new IdentifierManager(10L,30L);\r
+ assertEquals(12L,manager.reserve(12L));\r
+ long reserve = manager.reserve(12L);\r
+ assertFalse("Same id must be reserved twice!",reserve == 12L);\r
+ assertTrue(manager.release(12L));\r
+ assertTrue(manager.release(reserve));\r
+ assertFalse(manager.release(12L));\r
+ assertFalse(manager.release(reserve));\r
+ \r
+ manager = new IdentifierManager(0L,2L);\r
+ assertEquals(0L,manager.reserve(0L));\r
+ assertEquals(1L,manager.reserve(1L));\r
+ assertEquals(2L,manager.reserve(2L));\r
+ try\r
+ {\r
+ manager.reserve(0L);\r
+ fail("Exception expected");\r
+ }\r
+ catch(IllegalStateException e)\r
+ {\r
+ // expected\r
+ }\r
+ try\r
+ {\r
+ manager.reserve(1L);\r
+ fail("Exception expected");\r
+ }\r
+ catch(IllegalStateException e)\r
+ {\r
+ // expected\r
+ }\r
+ try\r
+ {\r
+ manager.reserve(2L);\r
+ fail("Exception expected");\r
+ }\r
+ catch(IllegalStateException e)\r
+ {\r
+ // expected\r
+ }\r
+ }\r
+\r
+ public void testReserveNew()\r
+ {\r
+ IdentifierManager manager = new IdentifierManager(10L,12L);\r
+ assertSame(10L,manager.reserveNew());\r
+ assertSame(11L,manager.reserveNew());\r
+ assertSame(12L,manager.reserveNew());\r
+ try {\r
+ manager.reserveNew();\r
+ fail("IllegalStateException expected");\r
+ }\r
+ catch (IllegalStateException e)\r
+ {\r
+ // expected\r
+ }\r
+ }\r
+ \r
+ public void testRelease() {\r
+ IdentifierManager manager = new IdentifierManager(10L,20L);\r
+ assertEquals(10L,manager.reserve(10L));\r
+ assertEquals(11L,manager.reserve(11L));\r
+ assertEquals(12L,manager.reserve(12L));\r
+ assertEquals(13L,manager.reserve(13L));\r
+ assertEquals(14L,manager.reserve(14L));\r
+ \r
+ assertTrue(manager.release(10L));\r
+ assertEquals(10L,manager.reserve(10L));\r
+ assertTrue(manager.release(10L));\r
+ \r
+ assertTrue(manager.release(11L));\r
+ assertEquals(11L,manager.reserve(11L));\r
+ assertTrue(manager.release(11L));\r
+ assertFalse(manager.release(11L));\r
+ assertFalse(manager.release(10L));\r
+\r
+ assertEquals(10L,manager.reserve(10L));\r
+ assertEquals(11L,manager.reserve(11L));\r
+ assertTrue(manager.release(12L));\r
+ }\r
+}\r
import org.apache.poi.xwpf.extractor.TestXWPFWordExtractor;
import org.apache.poi.xwpf.model.TestXWPFHeaderFooterPolicy;
+import org.apache.poi.xwpf.usermodel.TestXWPFDocument;
import org.apache.poi.xwpf.usermodel.TestXWPFHeader;
import org.apache.poi.xwpf.usermodel.TestXWPFHeadings;
import org.apache.poi.xwpf.usermodel.TestXWPFNumbering;
package org.apache.poi.xwpf;
+import java.io.IOException;
+
import junit.framework.TestCase;
import org.apache.poi.POIXMLProperties.CoreProperties;
*
*/
public final class TestAllExtendedProperties extends TestCase {
- public void testGetAllExtendedProperties() {
+ public void testGetAllExtendedProperties() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("TestPoiXMLDocumentCorePropertiesGetKeywords.docx");
CTProperties ctProps = doc.getProperties().getExtendedProperties().getUnderlyingProperties();
assertEquals("Microsoft Office Word",ctProps.getApplication());
package org.apache.poi.xwpf;
+import java.io.IOException;
+
import junit.framework.TestCase;
import org.apache.poi.POIXMLProperties.CoreProperties;
*
*/
public final class TestPackageCorePropertiesGetKeywords extends TestCase {
- public void testGetSetKeywords() {
+ public void testGetSetKeywords() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("TestPoiXMLDocumentCorePropertiesGetKeywords.docx");
String keywords = doc.getProperties().getCoreProperties().getKeywords();
assertEquals("extractor, test, rdf", keywords);
+++ /dev/null
-/* ====================================================================
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (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.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
-==================================================================== */
-
-package org.apache.poi.xwpf;
-
-import java.util.ArrayList;
-import java.util.List;
-
-import junit.framework.TestCase;
-
-import org.apache.poi.POIXMLDocumentPart;
-import org.apache.poi.POIXMLProperties;
-import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
-import org.apache.poi.openxml4j.opc.OPCPackage;
-import org.apache.poi.openxml4j.opc.PackagePart;
-import org.apache.poi.xwpf.usermodel.XWPFDocument;
-import org.apache.poi.xwpf.usermodel.XWPFParagraph;
-import org.apache.poi.xwpf.usermodel.XWPFPictureData;
-import org.apache.poi.xwpf.usermodel.XWPFRelation;
-import org.apache.xmlbeans.XmlCursor;
-import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP;
-
-public final class TestXWPFDocument extends TestCase {
-
- public void testContainsMainContentType() throws Exception {
- XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("sample.docx");
- OPCPackage pack = doc.getPackage();
-
- boolean found = false;
- for(PackagePart part : pack.getParts()) {
- if(part.getContentType().equals(XWPFRelation.DOCUMENT.getContentType())) {
- found = true;
- }
- if (false) {
- // successful tests should be silent
- System.out.println(part);
- }
- }
- assertTrue(found);
- }
-
- public void testOpen() throws Exception {
- XWPFDocument xml;
-
- // Simple file
- xml = XWPFTestDataSamples.openSampleDocument("sample.docx");
- // Check it has key parts
- assertNotNull(xml.getDocument());
- assertNotNull(xml.getDocument().getBody());
- assertNotNull(xml.getStyle());
-
- // Complex file
- xml = XWPFTestDataSamples.openSampleDocument("IllustrativeCases.docx");
- assertNotNull(xml.getDocument());
- assertNotNull(xml.getDocument().getBody());
- assertNotNull(xml.getStyle());
- }
-
- public void testMetadataBasics() {
- XWPFDocument xml = XWPFTestDataSamples.openSampleDocument("sample.docx");
- assertNotNull(xml.getProperties().getCoreProperties());
- assertNotNull(xml.getProperties().getExtendedProperties());
-
- assertEquals("Microsoft Office Word", xml.getProperties().getExtendedProperties().getUnderlyingProperties().getApplication());
- assertEquals(1315, xml.getProperties().getExtendedProperties().getUnderlyingProperties().getCharacters());
- assertEquals(10, xml.getProperties().getExtendedProperties().getUnderlyingProperties().getLines());
-
- assertEquals(null, xml.getProperties().getCoreProperties().getTitle());
- assertEquals(null, xml.getProperties().getCoreProperties().getUnderlyingProperties().getSubjectProperty().getValue());
- }
-
- public void testMetadataComplex() {
- XWPFDocument xml = XWPFTestDataSamples.openSampleDocument("IllustrativeCases.docx");
- assertNotNull(xml.getProperties().getCoreProperties());
- assertNotNull(xml.getProperties().getExtendedProperties());
-
- assertEquals("Microsoft Office Outlook", xml.getProperties().getExtendedProperties().getUnderlyingProperties().getApplication());
- assertEquals(5184, xml.getProperties().getExtendedProperties().getUnderlyingProperties().getCharacters());
- assertEquals(0, xml.getProperties().getExtendedProperties().getUnderlyingProperties().getLines());
-
- assertEquals(" ", xml.getProperties().getCoreProperties().getTitle());
- assertEquals(" ", xml.getProperties().getCoreProperties().getUnderlyingProperties().getSubjectProperty().getValue());
- }
-
- public void testWorkbookProperties() {
- XWPFDocument doc = new XWPFDocument();
- POIXMLProperties props = doc.getProperties();
- assertNotNull(props);
- assertEquals("Apache POI", props.getExtendedProperties().getUnderlyingProperties().getApplication());
- }
-
- public void testAddParagraph(){
- XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("sample.docx");
- assertEquals(3, doc.getParagraphs().size());
-
- XWPFParagraph p = doc.createParagraph();
- assertEquals(p, doc.getParagraphs().get(3));
- assertEquals(4, doc.getParagraphs().size());
-
- assertEquals(3, doc.getParagraphPos(3));
- assertEquals(3, doc.getPosOfParagraph(p));
-
- CTP ctp = p.getCTP();
- XWPFParagraph newP = doc.getParagraph(ctp);
- assertSame(p, newP);
- XmlCursor cursor = doc.getDocument().getBody().getPArray(0).newCursor();
- XWPFParagraph cP = doc.insertNewParagraph(cursor);
- assertSame(cP, doc.getParagraphs().get(0));
- assertEquals(5, doc.getParagraphs().size());
- }
-
- public void testAddPicture(){
- XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("sample.docx");
- byte[] jpeg = "This is a jpeg".getBytes();
- try {
- int jpegNum = doc.addPicture(jpeg, XWPFDocument.PICTURE_TYPE_JPEG);
- byte[] newJpeg = doc.getAllPictures().get(jpegNum).getData();
- assertEquals(newJpeg.length, jpeg.length);
- for(int i = 0 ; i < jpeg.length; i++){
- assertEquals(newJpeg[i], jpeg[i]);
- }
- } catch (InvalidFormatException e) {
- // TODO Auto-generated catch block
- e.printStackTrace();
- }
- }
-
- public void testRemoveBodyElement() {
- XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("sample.docx");
- assertEquals(3, doc.getParagraphs().size());
- assertEquals(3, doc.getBodyElements().size());
-
- XWPFParagraph p1 = doc.getParagraphs().get(0);
- XWPFParagraph p2 = doc.getParagraphs().get(1);
- XWPFParagraph p3 = doc.getParagraphs().get(2);
-
- assertEquals(p1, doc.getBodyElements().get(0));
- assertEquals(p1, doc.getParagraphs().get(0));
- assertEquals(p2, doc.getBodyElements().get(1));
- assertEquals(p2, doc.getParagraphs().get(1));
- assertEquals(p3, doc.getBodyElements().get(2));
- assertEquals(p3, doc.getParagraphs().get(2));
-
- // Add another
- XWPFParagraph p4 = doc.createParagraph();
-
- assertEquals(4, doc.getParagraphs().size());
- assertEquals(4, doc.getBodyElements().size());
- assertEquals(p1, doc.getBodyElements().get(0));
- assertEquals(p1, doc.getParagraphs().get(0));
- assertEquals(p2, doc.getBodyElements().get(1));
- assertEquals(p2, doc.getParagraphs().get(1));
- assertEquals(p3, doc.getBodyElements().get(2));
- assertEquals(p3, doc.getParagraphs().get(2));
- assertEquals(p4, doc.getBodyElements().get(3));
- assertEquals(p4, doc.getParagraphs().get(3));
-
- // Remove the 2nd
- assertEquals(true, doc.removeBodyElement(1));
- assertEquals(3, doc.getParagraphs().size());
- assertEquals(3, doc.getBodyElements().size());
-
- assertEquals(p1, doc.getBodyElements().get(0));
- assertEquals(p1, doc.getParagraphs().get(0));
- assertEquals(p3, doc.getBodyElements().get(1));
- assertEquals(p3, doc.getParagraphs().get(1));
- assertEquals(p4, doc.getBodyElements().get(2));
- assertEquals(p4, doc.getParagraphs().get(2));
-
- // Remove the 1st
- assertEquals(true, doc.removeBodyElement(0));
- assertEquals(2, doc.getParagraphs().size());
- assertEquals(2, doc.getBodyElements().size());
-
- assertEquals(p3, doc.getBodyElements().get(0));
- assertEquals(p3, doc.getParagraphs().get(0));
- assertEquals(p4, doc.getBodyElements().get(1));
- assertEquals(p4, doc.getParagraphs().get(1));
-
- // Remove the last
- assertEquals(true, doc.removeBodyElement(1));
- assertEquals(1, doc.getParagraphs().size());
- assertEquals(1, doc.getBodyElements().size());
-
- assertEquals(p3, doc.getBodyElements().get(0));
- assertEquals(p3, doc.getParagraphs().get(0));
- }
-
- public void testSettings() throws Exception {
- XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("WithGIF.docx");
- assertEquals(120, doc.getZoomPercent());
- assertEquals(false, doc.isEnforcedCommentsProtection());
- assertEquals(false, doc.isEnforcedFillingFormsProtection());
- assertEquals(false, doc.isEnforcedReadonlyProtection());
- assertEquals(false, doc.isEnforcedTrackedChangesProtection());
-
- doc.setZoomPercent(124);
-
- // Only one enforcement allowed, last one wins!
- doc.enforceFillingFormsProtection();
- doc.enforceReadonlyProtection();
-
- doc = XWPFTestDataSamples.writeOutAndReadBack(doc);
-
- assertEquals(124, doc.getZoomPercent());
- assertEquals(false, doc.isEnforcedCommentsProtection());
- assertEquals(false, doc.isEnforcedFillingFormsProtection());
- assertEquals(true, doc.isEnforcedReadonlyProtection());
- assertEquals(false, doc.isEnforcedTrackedChangesProtection());
- }
-
- public void testGIFSupport() throws Exception {
- XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("WithGIF.docx");
- ArrayList<PackagePart> gifParts = doc.getPackage().getPartsByContentType(XWPFRelation.IMAGE_GIF.getContentType());
- assertEquals("Expected exactly one GIF part in package.",1,gifParts.size());
- PackagePart gifPart = gifParts.get(0);
-
- List<POIXMLDocumentPart> relations = doc.getRelations();
- POIXMLDocumentPart gifDocPart = null;
- for (POIXMLDocumentPart docPart : relations)
- {
- if (gifPart == docPart.getPackagePart())
- {
- assertNull("More than one POIXMLDocumentPart for GIF PackagePart.",gifDocPart);
- gifDocPart = docPart;
- }
- }
- assertNotNull("GIF part not related to document.xml PackagePart",gifDocPart);
- assertTrue("XWPFRelation for GIF image was not recognized properly, as the POIXMLDocumentPart created was of a wrong type.",XWPFRelation.IMAGE_GIF.getRelationClass().isInstance(gifDocPart));
- }
-}
import java.io.InputStream;\r
\r
import org.apache.poi.POIDataSamples;\r
+import org.apache.poi.util.IOUtils;\r
+import org.apache.poi.util.PackageHelper;\r
import org.apache.poi.xwpf.usermodel.XWPFDocument;\r
\r
/**\r
*/\r
public class XWPFTestDataSamples {\r
\r
- public static XWPFDocument openSampleDocument(String sampleName) {\r
+ public static XWPFDocument openSampleDocument(String sampleName) throws IOException {\r
InputStream is = POIDataSamples.getDocumentInstance().openResourceAsStream(sampleName);\r
- try {\r
- return new XWPFDocument(is);\r
- } catch (IOException e) {\r
- throw new RuntimeException(e);\r
- }\r
+ return new XWPFDocument(is);\r
}\r
\r
- public static XWPFDocument writeOutAndReadBack(XWPFDocument doc) {\r
- try {\r
- ByteArrayOutputStream baos = new ByteArrayOutputStream(4096);\r
- doc.write(baos);\r
- ByteArrayInputStream bais = new ByteArrayInputStream(baos.toByteArray());\r
- return new XWPFDocument(bais);\r
- } catch (IOException e) {\r
- throw new RuntimeException(e);\r
- }\r
+ public static XWPFDocument writeOutAndReadBack(XWPFDocument doc) throws IOException {\r
+ ByteArrayOutputStream baos = new ByteArrayOutputStream(4096);\r
+ doc.write(baos);\r
+ ByteArrayInputStream bais = new ByteArrayInputStream(baos.toByteArray());\r
+ return new XWPFDocument(bais);\r
+ }\r
+\r
+ public static byte[] getImage(String filename) throws IOException {\r
+ InputStream is = POIDataSamples.getDocumentInstance().openResourceAsStream(filename);\r
+ byte[] result = IOUtils.toByteArray(is);\r
+ return result;\r
}\r
}\r
package org.apache.poi.xwpf.extractor;
+import java.io.IOException;
+
import junit.framework.TestCase;
import org.apache.poi.xwpf.XWPFTestDataSamples;
/**
* Get text out of the simple file
+ * @throws IOException
*/
- public void testGetSimpleText() {
+ public void testGetSimpleText() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("sample.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
/**
* Tests getting the text out of a complex file
+ * @throws IOException
*/
- public void testGetComplexText() {
+ public void testGetComplexText() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("IllustrativeCases.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
assertEquals(134, ps);
}
- public void testGetWithHyperlinks() {
+ public void testGetWithHyperlinks() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("TestDocument.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
);
}
- public void testHeadersFooters() {
+ public void testHeadersFooters() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("ThreeColHeadFoot.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
);
}
- public void testFootnotes() {
+ public void testFootnotes() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("footnotes.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
}
- public void testTableFootnotes() {
+ public void testTableFootnotes() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("table_footnotes.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
assertTrue(extractor.getText().contains("snoska"));
}
- public void testFormFootnotes() {
+ public void testFormFootnotes() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("form_footnotes.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
assertTrue("Unable to find expected word in text\n" + text, text.contains("test phrase"));
}
- public void testEndnotes() {
+ public void testEndnotes() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("endnotes.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
assertTrue(extractor.getText().contains("XXX"));
}
- public void testInsertedDeletedText() {
+ public void testInsertedDeletedText() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("delins.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
assertTrue(extractor.getText().contains("extremely well"));
}
- public void testParagraphHeader() {
+ public void testParagraphHeader() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("Headers.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
/**
* Test that we can open and process .docm
* (macro enabled) docx files (bug #45690)
+ * @throws IOException
*/
- public void testDOCMFiles() {
+ public void testDOCMFiles() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("45690.docm");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
* Test that we handle things like tabs and
* carriage returns properly in the text that
* we're extracting (bug #49189)
+ * @throws IOException
*/
- public void testDocTabs() {
+ public void testDocTabs() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("WithTabs.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
/**
* The output should not contain field codes, e.g. those specified in the
* w:instrText tag (spec sec. 17.16.23)
+ * @throws IOException
*/
- public void testNoFieldCodes() {
+ public void testNoFieldCodes() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("FieldCodes.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
String text = extractor.getText();
/**
* The output should contain the values of simple fields, those specified
* with the fldSimple element (spec sec. 17.16.19)
+ * @throws IOException
*/
- public void testFldSimpleContent() {
+ public void testFldSimpleContent() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("FldSimple.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
String text = extractor.getText();
package org.apache.poi.xwpf.model;
+import java.io.IOException;
+
import junit.framework.TestCase;
import org.apache.poi.xwpf.XWPFTestDataSamples;
private XWPFDocument hyperlink;
private XWPFDocument comments;
- protected void setUp() {
- simple = XWPFTestDataSamples.openSampleDocument("SampleDoc.docx");
- hyperlink = XWPFTestDataSamples.openSampleDocument("TestDocument.docx");
- comments = XWPFTestDataSamples.openSampleDocument("WordWithAttachments.docx");
+ protected void setUp() throws IOException {
+ simple = XWPFTestDataSamples.openSampleDocument("SampleDoc.docx");
+ hyperlink = XWPFTestDataSamples.openSampleDocument("TestDocument.docx");
+ comments = XWPFTestDataSamples.openSampleDocument("WordWithAttachments.docx");
}
public void testHyperlink() {
package org.apache.poi.xwpf.model;
+import java.io.IOException;
+
import junit.framework.TestCase;
import org.apache.poi.xwpf.XWPFTestDataSamples;
private XWPFDocument oddEven;
private XWPFDocument diffFirst;
- protected void setUp() {
+ protected void setUp() throws IOException {
- noHeader = XWPFTestDataSamples.openSampleDocument("NoHeadFoot.docx");
+ noHeader = XWPFTestDataSamples.openSampleDocument("NoHeadFoot.docx");
header = XWPFTestDataSamples.openSampleDocument("ThreeColHead.docx");
headerFooter = XWPFTestDataSamples.openSampleDocument("SimpleHeadThreeColFoot.docx");
footer = XWPFTestDataSamples.openSampleDocument("FancyFoot.docx");
--- /dev/null
+/* ====================================================================
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (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.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+==================================================================== */
+
+package org.apache.poi.xwpf.usermodel;
+
+import java.io.IOException;
+import java.io.OutputStream;
+import java.util.Arrays;
+import java.util.List;
+
+import junit.framework.TestCase;
+
+import org.apache.poi.POIXMLDocumentPart;
+import org.apache.poi.POIXMLProperties;
+import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
+import org.apache.poi.openxml4j.opc.OPCPackage;
+import org.apache.poi.openxml4j.opc.PackagePart;
+import org.apache.poi.openxml4j.opc.PackagePartName;
+import org.apache.poi.openxml4j.opc.PackageRelationship;
+import org.apache.poi.openxml4j.opc.PackagingURIHelper;
+import org.apache.poi.openxml4j.opc.TargetMode;
+import org.apache.poi.xwpf.XWPFTestDataSamples;
+import org.apache.xmlbeans.XmlCursor;
+import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP;
+
+public final class TestXWPFDocument extends TestCase {
+
+ public void testContainsMainContentType() throws Exception {
+ XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("sample.docx");
+ OPCPackage pack = doc.getPackage();
+
+ boolean found = false;
+ for(PackagePart part : pack.getParts()) {
+ if(part.getContentType().equals(XWPFRelation.DOCUMENT.getContentType())) {
+ found = true;
+ }
+ if (false) {
+ // successful tests should be silent
+ System.out.println(part);
+ }
+ }
+ assertTrue(found);
+ }
+
+ public void testOpen() throws Exception {
+ XWPFDocument xml;
+
+ // Simple file
+ xml = XWPFTestDataSamples.openSampleDocument("sample.docx");
+ // Check it has key parts
+ assertNotNull(xml.getDocument());
+ assertNotNull(xml.getDocument().getBody());
+ assertNotNull(xml.getStyle());
+
+ // Complex file
+ xml = XWPFTestDataSamples.openSampleDocument("IllustrativeCases.docx");
+ assertNotNull(xml.getDocument());
+ assertNotNull(xml.getDocument().getBody());
+ assertNotNull(xml.getStyle());
+ }
+
+ public void testMetadataBasics() throws IOException {
+ XWPFDocument xml = XWPFTestDataSamples.openSampleDocument("sample.docx");
+ assertNotNull(xml.getProperties().getCoreProperties());
+ assertNotNull(xml.getProperties().getExtendedProperties());
+
+ assertEquals("Microsoft Office Word", xml.getProperties().getExtendedProperties().getUnderlyingProperties().getApplication());
+ assertEquals(1315, xml.getProperties().getExtendedProperties().getUnderlyingProperties().getCharacters());
+ assertEquals(10, xml.getProperties().getExtendedProperties().getUnderlyingProperties().getLines());
+
+ assertEquals(null, xml.getProperties().getCoreProperties().getTitle());
+ assertEquals(null, xml.getProperties().getCoreProperties().getUnderlyingProperties().getSubjectProperty().getValue());
+ }
+
+ public void testMetadataComplex() throws IOException {
+ XWPFDocument xml = XWPFTestDataSamples.openSampleDocument("IllustrativeCases.docx");
+ assertNotNull(xml.getProperties().getCoreProperties());
+ assertNotNull(xml.getProperties().getExtendedProperties());
+
+ assertEquals("Microsoft Office Outlook", xml.getProperties().getExtendedProperties().getUnderlyingProperties().getApplication());
+ assertEquals(5184, xml.getProperties().getExtendedProperties().getUnderlyingProperties().getCharacters());
+ assertEquals(0, xml.getProperties().getExtendedProperties().getUnderlyingProperties().getLines());
+
+ assertEquals(" ", xml.getProperties().getCoreProperties().getTitle());
+ assertEquals(" ", xml.getProperties().getCoreProperties().getUnderlyingProperties().getSubjectProperty().getValue());
+ }
+
+ public void testWorkbookProperties() {
+ XWPFDocument doc = new XWPFDocument();
+ POIXMLProperties props = doc.getProperties();
+ assertNotNull(props);
+ assertEquals("Apache POI", props.getExtendedProperties().getUnderlyingProperties().getApplication());
+ }
+
+ public void testAddParagraph() throws IOException{
+ XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("sample.docx");
+ assertEquals(3, doc.getParagraphs().size());
+
+ XWPFParagraph p = doc.createParagraph();
+ assertEquals(p, doc.getParagraphs().get(3));
+ assertEquals(4, doc.getParagraphs().size());
+
+ assertEquals(3, doc.getParagraphPos(3));
+ assertEquals(3, doc.getPosOfParagraph(p));
+
+ CTP ctp = p.getCTP();
+ XWPFParagraph newP = doc.getParagraph(ctp);
+ assertSame(p, newP);
+ XmlCursor cursor = doc.getDocument().getBody().getPArray(0).newCursor();
+ XWPFParagraph cP = doc.insertNewParagraph(cursor);
+ assertSame(cP, doc.getParagraphs().get(0));
+ assertEquals(5, doc.getParagraphs().size());
+ }
+
+ public void testAddPicture() throws IOException, InvalidFormatException
+ {
+ XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("sample.docx");
+ byte[] jpeg = XWPFTestDataSamples.getImage("nature1.jpg");
+ String relationId = doc.addPictureData(jpeg,XWPFDocument.PICTURE_TYPE_JPEG);
+
+ byte[] newJpeg = ((XWPFPictureData) doc.getRelationById(relationId)).getData();
+ assertEquals(newJpeg.length,jpeg.length);
+ for (int i = 0 ; i < jpeg.length ; i++)
+ {
+ assertEquals(newJpeg[i],jpeg[i]);
+ }
+ }
+
+ public void testRemoveBodyElement() throws IOException {
+ XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("sample.docx");
+ assertEquals(3, doc.getParagraphs().size());
+ assertEquals(3, doc.getBodyElements().size());
+
+ XWPFParagraph p1 = doc.getParagraphs().get(0);
+ XWPFParagraph p2 = doc.getParagraphs().get(1);
+ XWPFParagraph p3 = doc.getParagraphs().get(2);
+
+ assertEquals(p1, doc.getBodyElements().get(0));
+ assertEquals(p1, doc.getParagraphs().get(0));
+ assertEquals(p2, doc.getBodyElements().get(1));
+ assertEquals(p2, doc.getParagraphs().get(1));
+ assertEquals(p3, doc.getBodyElements().get(2));
+ assertEquals(p3, doc.getParagraphs().get(2));
+
+ // Add another
+ XWPFParagraph p4 = doc.createParagraph();
+
+ assertEquals(4, doc.getParagraphs().size());
+ assertEquals(4, doc.getBodyElements().size());
+ assertEquals(p1, doc.getBodyElements().get(0));
+ assertEquals(p1, doc.getParagraphs().get(0));
+ assertEquals(p2, doc.getBodyElements().get(1));
+ assertEquals(p2, doc.getParagraphs().get(1));
+ assertEquals(p3, doc.getBodyElements().get(2));
+ assertEquals(p3, doc.getParagraphs().get(2));
+ assertEquals(p4, doc.getBodyElements().get(3));
+ assertEquals(p4, doc.getParagraphs().get(3));
+
+ // Remove the 2nd
+ assertEquals(true, doc.removeBodyElement(1));
+ assertEquals(3, doc.getParagraphs().size());
+ assertEquals(3, doc.getBodyElements().size());
+
+ assertEquals(p1, doc.getBodyElements().get(0));
+ assertEquals(p1, doc.getParagraphs().get(0));
+ assertEquals(p3, doc.getBodyElements().get(1));
+ assertEquals(p3, doc.getParagraphs().get(1));
+ assertEquals(p4, doc.getBodyElements().get(2));
+ assertEquals(p4, doc.getParagraphs().get(2));
+
+ // Remove the 1st
+ assertEquals(true, doc.removeBodyElement(0));
+ assertEquals(2, doc.getParagraphs().size());
+ assertEquals(2, doc.getBodyElements().size());
+
+ assertEquals(p3, doc.getBodyElements().get(0));
+ assertEquals(p3, doc.getParagraphs().get(0));
+ assertEquals(p4, doc.getBodyElements().get(1));
+ assertEquals(p4, doc.getParagraphs().get(1));
+
+ // Remove the last
+ assertEquals(true, doc.removeBodyElement(1));
+ assertEquals(1, doc.getParagraphs().size());
+ assertEquals(1, doc.getBodyElements().size());
+
+ assertEquals(p3, doc.getBodyElements().get(0));
+ assertEquals(p3, doc.getParagraphs().get(0));
+ }
+
+ public void testRegisterPackagePictureData() throws IOException, InvalidFormatException {
+ XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("issue_51265_1.docx");
+
+ /* manually assemble a new image package part*/
+ OPCPackage opcPckg = doc.getPackage();
+ XWPFRelation jpgRelation = XWPFRelation.IMAGE_JPEG;
+ PackagePartName partName = PackagingURIHelper.createPartName(jpgRelation.getDefaultFileName().replace('#', '2'));
+ PackagePart newImagePart = opcPckg.createPart(partName, jpgRelation.getContentType());
+ byte[] nature1 = XWPFTestDataSamples.getImage("abstract4.jpg");
+ OutputStream os = newImagePart.getOutputStream();
+ os.write(nature1);
+ os.close();
+ XWPFHeader xwpfHeader = doc.getHeaderList().get(0);
+ PackageRelationship relationship = xwpfHeader.getPackagePart().addRelationship(partName, TargetMode.INTERNAL, jpgRelation.getRelation());
+ XWPFPictureData newPicData = new XWPFPictureData(newImagePart,relationship);
+ /* new part is now ready to rumble */
+
+ assertFalse(xwpfHeader.getAllPictures().contains(newPicData));
+ assertFalse(doc.getAllPictures().contains(newPicData));
+ assertFalse(doc.getAllPackagePictures().contains(newPicData));
+
+ doc.registerPackagePictureData(newPicData);
+
+ assertFalse(xwpfHeader.getAllPictures().contains(newPicData));
+ assertFalse(doc.getAllPictures().contains(newPicData));
+ assertTrue(doc.getAllPackagePictures().contains(newPicData));
+
+ doc.getPackage().revert();
+ }
+
+ public void testFindPackagePictureData() throws IOException {
+ XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("issue_51265_1.docx");
+ byte[] nature1 = XWPFTestDataSamples.getImage("nature1.gif");
+ XWPFPictureData part = doc.findPackagePictureData(nature1, Document.PICTURE_TYPE_GIF);
+ assertNotNull(part);
+ assertTrue(doc.getAllPictures().contains(part));
+ assertTrue(doc.getAllPackagePictures().contains(part));
+ doc.getPackage().revert();
+ }
+
+ public void testGetAllPictures() throws IOException {
+ XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("issue_51265_3.docx");
+ List<XWPFPictureData> allPictures = doc.getAllPictures();
+ List<XWPFPictureData> allPackagePictures = doc.getAllPackagePictures();
+
+ assertNotNull(allPictures);
+ assertEquals(3,allPictures.size());
+ for (XWPFPictureData xwpfPictureData : allPictures) {
+ assertTrue(allPackagePictures.contains(xwpfPictureData));
+ }
+
+ try {
+ allPictures.add(allPictures.get(0));
+ fail("This list must be unmodifiable!");
+ } catch (UnsupportedOperationException e) {
+ // all ok
+ }
+
+ doc.getPackage().revert();
+ }
+
+ public void testGetAllPackagePictures() throws IOException {
+ XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("issue_51265_3.docx");
+ List<XWPFPictureData> allPackagePictures = doc.getAllPackagePictures();
+
+ assertNotNull(allPackagePictures);
+ assertEquals(5,allPackagePictures.size());
+
+ try {
+ allPackagePictures.add(allPackagePictures.get(0));
+ fail("This list must be unmodifiable!");
+ } catch (UnsupportedOperationException e) {
+ // all ok
+ }
+
+ doc.getPackage().revert();
+ }
+
+ public void testPictureHandlingSimpleFile() throws IOException, InvalidFormatException {
+ XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("issue_51265_1.docx");
+ assertEquals(1,doc.getAllPackagePictures().size());
+ byte[] newPic = XWPFTestDataSamples.getImage("abstract4.jpg");
+ String id1 = doc.addPictureData(newPic, Document.PICTURE_TYPE_JPEG);
+ assertEquals(2,doc.getAllPackagePictures().size());
+ /* copy data, to avoid instance-equality */
+ byte[] newPicCopy = Arrays.copyOf(newPic, newPic.length);
+ String id2 = doc.addPictureData(newPicCopy, Document.PICTURE_TYPE_JPEG);
+ assertEquals(id1,id2);
+ doc.getPackage().revert();
+ }
+
+ public void testPictureHandlingHeaderDocumentImages() throws IOException {
+ XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("issue_51265_2.docx");
+ assertEquals(1,doc.getAllPictures().size());
+ assertEquals(1,doc.getAllPackagePictures().size());
+ assertEquals(1,doc.getHeaderList().get(0).getAllPictures().size());
+ doc.getPackage().revert();
+ }
+
+ public void testPictureHandlingComplex() throws IOException, InvalidFormatException {
+ XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("issue_51265_3.docx");
+ XWPFHeader xwpfHeader = doc.getHeaderList().get(0);
+
+ assertEquals(3,doc.getAllPictures().size());
+ assertEquals(3,xwpfHeader.getAllPictures().size());
+ assertEquals(5,doc.getAllPackagePictures().size());
+
+ byte[] nature1 = XWPFTestDataSamples.getImage("nature1.jpg");
+ String id = doc.addPictureData(nature1, Document.PICTURE_TYPE_JPEG);
+ POIXMLDocumentPart part1 = xwpfHeader.getRelationById("rId1");
+ XWPFPictureData part2 = (XWPFPictureData) doc.getRelationById(id);
+ assertSame(part1,part2);
+
+ doc.getPackage().revert();
+ }
+}
public final class TestXWPFHeader extends TestCase {
- public void testSimpleHeader() {
+ public void testSimpleHeader() throws IOException {
XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("headerFooter.docx");
XWPFHeaderFooterPolicy policy = sampleDoc.getHeaderFooterPolicy();
assertNotNull(footer);
}
- public void testImageInHeader() {
+ public void testImageInHeader() throws IOException {
XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("headerPic.docx");
XWPFHeaderFooterPolicy policy = sampleDoc.getHeaderFooterPolicy();
// make sure that it contains two paragraphs of text and that
// both do hold what is expected.
footer = policy.getDefaultFooter();
-
+
XWPFParagraph[] paras = new XWPFParagraph[footer.getParagraphs().size()];
int i=0;
for(XWPFParagraph p : footer.getParagraphs()) {
assertEquals("Second paragraph for the footer", paras[1].getText());
}
- public void testSetWatermark() {
+ public void testSetWatermark() throws IOException {
XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("SampleDoc.docx");
// no header is set (yet)
XWPFHeaderFooterPolicy policy = sampleDoc.getHeaderFooterPolicy();
assertNotNull(policy.getFirstPageHeader());
assertNotNull(policy.getEvenPageHeader());
}
+
+ public void testAddPictureData() {
+
+ }
+
+ public void testGetAllPictures() {
+
+ }
+
+ public void testGetAllPackagePictures() {
+
+ }
+
+ public void testGetPictureDataById() {
+
+ }
}
package org.apache.poi.xwpf.usermodel;
+import java.io.IOException;
import java.math.BigInteger;
import junit.framework.TestCase;
public class TestXWPFNumbering extends TestCase {
- public void testCompareAbstractNum(){
+ public void testCompareAbstractNum() throws IOException{
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("Numbering.docx");
XWPFNumbering numbering = doc.getNumbering();
BigInteger numId = BigInteger.valueOf(1);
package org.apache.poi.xwpf.usermodel;
+import java.io.IOException;
import java.math.BigInteger;
import java.util.List;
/**
* Check that we get the right paragraph from the header
+ * @throws IOException
*/
- public void disabled_testHeaderParagraph() {
+ public void disabled_testHeaderParagraph() throws IOException {
XWPFDocument xml = XWPFTestDataSamples.openSampleDocument("ThreeColHead.docx");
XWPFHeader hdr = xml.getHeaderFooterPolicy().getDefaultHeader();
/**
* Check that we get the right paragraphs from the document
+ * @throws IOException
*/
- public void disabled_testDocumentParagraph() {
+ public void disabled_testDocumentParagraph() throws IOException {
XWPFDocument xml = XWPFTestDataSamples.openSampleDocument("ThreeColHead.docx");
List<XWPFParagraph> ps = xml.getParagraphs();
assertEquals(10, ps.size());
assertEquals(STOnOff.TRUE, ppr.getPageBreakBefore().getVal());
}
- public void testBookmarks() {
+ public void testBookmarks() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("bookmarks.docx");
XWPFParagraph paragraph = doc.getParagraphs().get(0);
assertEquals("Sample Word Document", paragraph.getText());
package org.apache.poi.xwpf.usermodel;
+import java.io.IOException;
import java.util.Arrays;
import java.util.List;
import org.apache.poi.xwpf.model.XWPFHeaderFooterPolicy;
public class TestXWPFPictureData extends TestCase {
- public void testRead(){
- XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("VariousPictures.docx");
- List<XWPFPictureData> pictures = sampleDoc.getAllPictures();
- assertSame(pictures, sampleDoc.getAllPictures());
-
- assertEquals(5, pictures.size());
- String[] ext = {"wmf", "png", "emf", "emf", "jpeg"};
- for (int i = 0; i < pictures.size(); i++) {
- assertEquals(ext[i], pictures.get(i).suggestFileExtension());
- }
-
- int num = pictures.size();
-
- byte[] pictureData = {0xA, 0xB, 0XC, 0xD, 0xE, 0xF};
-
- int idx;
- try {
- idx = sampleDoc.addPicture(pictureData, XWPFDocument.PICTURE_TYPE_JPEG);
- assertEquals(num + 1, pictures.size());
- //idx is 0-based index in the #pictures array
- assertEquals(pictures.size() - 1, idx);
- XWPFPictureData pict = pictures.get(idx);
- assertEquals("jpeg", pict.suggestFileExtension());
- assertTrue(Arrays.equals(pictureData, pict.getData()));
- } catch (InvalidFormatException e) {
- // TODO Auto-generated catch block
- e.printStackTrace();
- }
- }
-
- public void testPictureInHeader() {
- XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("headerPic.docx");
- XWPFHeaderFooterPolicy policy = sampleDoc.getHeaderFooterPolicy();
-
- XWPFHeader header = policy.getDefaultHeader();
-
- List<XWPFPictureData> pictures = header.getAllPictures();
- assertEquals(1, pictures.size());
+
+ public void testRead() throws InvalidFormatException, IOException
+ {
+ XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("VariousPictures.docx");
+ List<XWPFPictureData> pictures = sampleDoc.getAllPictures();
+
+ assertEquals(5,pictures.size());
+ String[] ext = {"wmf","png","emf","emf","jpeg"};
+ for (int i = 0 ; i < pictures.size() ; i++)
+ {
+ assertEquals(ext[i],pictures.get(i).suggestFileExtension());
}
- public void testNew() throws Exception {
- XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("EmptyDocumentWithHeaderFooter.docx");
- byte[] jpegData = "test jpeg data".getBytes();
- byte[] wmfData = "test wmf data".getBytes();
- byte[] pngData = "test png data".getBytes();
-
- List<XWPFPictureData> pictures = doc.getAllPictures();
- assertEquals(0, pictures.size());
-
- // Document shouldn't have any image relationships
- assertEquals(13, doc.getPackagePart().getRelationships().size());
- for(PackageRelationship rel : doc.getPackagePart().getRelationships()) {
- if(rel.getRelationshipType().equals(XSSFRelation.IMAGE_JPEG.getRelation())) {
- fail("Shouldn't have JPEG yet");
- }
- }
-
- // Add the image
- int jpegIdx;
-
- jpegIdx = doc.addPicture(jpegData, XWPFDocument.PICTURE_TYPE_JPEG);
- assertEquals(1, pictures.size());
- assertEquals("jpeg", pictures.get(jpegIdx).suggestFileExtension());
- assertTrue(Arrays.equals(jpegData, pictures.get(jpegIdx).getData()));
-
- // Ensure it now has one
- assertEquals(14, doc.getPackagePart().getRelationships().size());
- PackageRelationship jpegRel = null;
- for(PackageRelationship rel : doc.getPackagePart().getRelationships()) {
- if(rel.getRelationshipType().equals(XWPFRelation.IMAGE_JPEG.getRelation())) {
- if(jpegRel != null)
+ int num = pictures.size();
+
+ byte[] pictureData = XWPFTestDataSamples.getImage("nature1.jpg");
+
+ String relationId = sampleDoc.addPictureData(pictureData,XWPFDocument.PICTURE_TYPE_JPEG);
+ // picture list was updated
+ assertEquals(num + 1,pictures.size());
+ XWPFPictureData pict = (XWPFPictureData) sampleDoc.getRelationById(relationId);
+ assertEquals("jpeg",pict.suggestFileExtension());
+ assertTrue(Arrays.equals(pictureData,pict.getData()));
+ }
+
+ public void testPictureInHeader() throws IOException
+ {
+ XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("headerPic.docx");
+ XWPFHeaderFooterPolicy policy = sampleDoc.getHeaderFooterPolicy();
+
+ XWPFHeader header = policy.getDefaultHeader();
+
+ List<XWPFPictureData> pictures = header.getAllPictures();
+ assertEquals(1,pictures.size());
+ }
+
+ public void testNew() throws InvalidFormatException, IOException
+ {
+ XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("EmptyDocumentWithHeaderFooter.docx");
+ byte[] jpegData = XWPFTestDataSamples.getImage("nature1.jpg");
+ byte[] gifData = XWPFTestDataSamples.getImage("nature1.gif");
+ byte[] pngData = XWPFTestDataSamples.getImage("nature1.png");
+
+ List<XWPFPictureData> pictures = doc.getAllPictures();
+ assertEquals(0,pictures.size());
+
+ // Document shouldn't have any image relationships
+ assertEquals(13,doc.getPackagePart().getRelationships().size());
+ for (PackageRelationship rel : doc.getPackagePart().getRelationships())
+ {
+ if (rel.getRelationshipType().equals(XSSFRelation.IMAGE_JPEG.getRelation()))
+ {
+ fail("Shouldn't have JPEG yet");
+ }
+ }
+
+ // Add the image
+ String relationId = doc.addPictureData(jpegData,XWPFDocument.PICTURE_TYPE_JPEG);
+ assertEquals(1,pictures.size());
+ XWPFPictureData jpgPicData = (XWPFPictureData) doc.getRelationById(relationId);
+ assertEquals("jpeg",jpgPicData.suggestFileExtension());
+ assertTrue(Arrays.equals(jpegData,jpgPicData.getData()));
+
+ // Ensure it now has one
+ assertEquals(14,doc.getPackagePart().getRelationships().size());
+ PackageRelationship jpegRel = null;
+ for (PackageRelationship rel : doc.getPackagePart().getRelationships())
+ {
+ if (rel.getRelationshipType().equals(XWPFRelation.IMAGE_JPEG.getRelation()))
+ {
+ if (jpegRel != null)
fail("Found 2 jpegs!");
- jpegRel = rel;
- }
- }
- assertNotNull("JPEG Relationship not found", jpegRel);
-
- // Check the details
- assertEquals(XWPFRelation.IMAGE_JPEG.getRelation(), jpegRel.getRelationshipType());
- assertEquals("/word/document.xml", jpegRel.getSource().getPartName().toString());
- assertEquals("/word/media/image1.jpeg", jpegRel.getTargetURI().getPath());
-
- XWPFPictureData pictureDataByID = doc.getPictureDataByID(jpegRel.getId());
- byte [] newJPEGData = pictureDataByID.getData();
- assertEquals(newJPEGData.length, jpegData.length);
- for(int i = 0; i < newJPEGData.length; i++){
- assertEquals(newJPEGData[i], jpegData[i]);
- }
-
- // Save an re-load, check it appears
- doc = XWPFTestDataSamples.writeOutAndReadBack(doc);
- assertEquals(1, doc.getAllPictures().size());
- assertEquals(1, doc.getAllPackagePictures().size());
- }
+ jpegRel = rel;
+ }
+ }
+ assertNotNull("JPEG Relationship not found",jpegRel);
+
+ // Check the details
+ assertEquals(XWPFRelation.IMAGE_JPEG.getRelation(),jpegRel.getRelationshipType());
+ assertEquals("/word/document.xml",jpegRel.getSource().getPartName().toString());
+ assertEquals("/word/media/image1.jpeg",jpegRel.getTargetURI().getPath());
+
+ XWPFPictureData pictureDataByID = doc.getPictureDataByID(jpegRel.getId());
+ byte[] newJPEGData = pictureDataByID.getData();
+ assertEquals(newJPEGData.length,jpegData.length);
+ for (int i = 0 ; i < newJPEGData.length ; i++)
+ {
+ assertEquals(newJPEGData[i],jpegData[i]);
+ }
+
+ // Save an re-load, check it appears
+ doc = XWPFTestDataSamples.writeOutAndReadBack(doc);
+ assertEquals(1,doc.getAllPictures().size());
+ assertEquals(1,doc.getAllPackagePictures().size());
+ }
+
+ public void testGetChecksum() {
+
+ }
}
package org.apache.poi.xwpf.usermodel;
import java.io.ByteArrayInputStream;
+import java.io.IOException;
import java.math.BigInteger;
import java.util.List;
/**
* Test that on an existing document, we do the
* right thing with it
+ * @throws IOException
*/
- public void testExisting() {
+ public void testExisting() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("TestDocument.docx");
XWPFParagraph p;
XWPFRun run;
assertEquals(null, run.getCTR().getRPr());
}
- public void testPictureInHeader() {
+ public void testPictureInHeader() throws IOException {
XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("headerPic.docx");
XWPFHeaderFooterPolicy policy = sampleDoc.getHeaderFooterPolicy();
package org.apache.poi.xwpf.usermodel;
+import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
// super.setUp();
// }
- public void testGetUsedStyles(){
+ public void testGetUsedStyles() throws IOException{
XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("Styles.docx");
List<XWPFStyle> testUsedStyleList = new ArrayList<XWPFStyle>();
XWPFStyles styles = sampleDoc.getStyles();
projects / poi.git / commitdiff
