Apache
/
poi
mirror of https://github.com/apache/poi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

bug 51265: Enhanced Handling of Picture Parts in XWPF 

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1130120 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Yegor Kozlov 2011-06-01 12:07:16 +00:00
parent 3d7cd947fd
commit b988ca3855
57 changed files with 2962 additions and 2012 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/documentation/content/xdocs/status.xml
View File

@ -34,10 +34,11 @@
<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>

8
src/java/org/apache/poi/util/IOUtils.java
View File

@ -23,6 +23,8 @@ import java.io.InputStream;
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() {
@ -129,4 +131,10 @@ public final class IOUtils {
}
}
}
public static long calculateChecksum(byte[] data) {
Checksum sum = new CRC32();
sum.update(data, 0, data.length);
return sum.getValue();
}
}

31
src/ooxml/java/org/apache/poi/POIXMLDocument.java
View File

@ -30,10 +30,8 @@ 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.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;
@ -80,33 +78,6 @@ public abstract class POIXMLDocument extends POIXMLDocumentPart{
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
@ -125,8 +96,6 @@ public abstract class POIXMLDocument extends POIXMLDocumentPart{
return parts;
}
/**
* Checks that the supplied InputStream (which MUST
* support mark and reset, or be a PushbackInputStream)

187
src/ooxml/java/org/apache/poi/POIXMLDocumentPart.java
View File

@ -17,15 +17,23 @@
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.
@ -47,19 +55,55 @@ public class POIXMLDocumentPart {
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;
}
@ -70,7 +114,6 @@ public class POIXMLDocumentPart {
* @see #createRelationship(POIXMLRelation, POIXMLFactory, int, boolean)
*/
public POIXMLDocumentPart(){
this.relations = new LinkedList<POIXMLDocumentPart>();
}
/**
@ -82,7 +125,6 @@ public class POIXMLDocumentPart {
* @see #read(POIXMLFactory, java.util.Map)
*/
public POIXMLDocumentPart(PackagePart part, PackageRelationship rel){
this.relations = new LinkedList<POIXMLDocumentPart>();
this.packagePart = part;
this.packageRel = rel;
}
@ -97,7 +139,6 @@ public class POIXMLDocumentPart {
* @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;
@ -145,7 +186,46 @@ public class POIXMLDocumentPart {
* @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;
}
/**
@ -153,17 +233,54 @@ public class POIXMLDocumentPart {
*
* @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());
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());
relations.remove(part);
}
}
return true;
}
/**
@ -211,7 +328,7 @@ public class POIXMLDocumentPart {
protected final void onSave(Set<PackagePart> alreadySaved) throws IOException{
commit();
alreadySaved.add(this.getPackagePart());
for(POIXMLDocumentPart p : relations){
for(POIXMLDocumentPart p : relations.values()){
if (!alreadySaved.contains(p.getPackagePart())) {
p.onSave(alreadySaved);
}
@ -246,15 +363,19 @@ public class POIXMLDocumentPart {
try {
PackagePartName ppName = PackagingURIHelper.createPartName(descriptor.getFileName(idx));
PackageRelationship rel = null;
PackagePart part = packagePart.getPackage().createPart(ppName, descriptor.getContentType());
if(!noRelation) {
/* 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);
@ -292,14 +413,14 @@ public class POIXMLDocumentPart {
if (!context.containsKey(p)) {
POIXMLDocumentPart childPart = factory.createDocumentPart(this, rel, p);
childPart.parent = this;
addRelation(childPart);
addRelation(rel.getId(),childPart);
if(p != null){
context.put(p, childPart);
if(p.hasRelationships()) childPart.read(factory, context);
}
}
else {
addRelation(context.get(p));
addRelation(rel.getId(),context.get(p));
}
}
}
@ -318,4 +439,22 @@ public class POIXMLDocumentPart {
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 {
}
}

22
src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java
View File

@ -31,7 +31,10 @@ import java.net.URISyntaxException;
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;
@ -553,6 +556,25 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
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.
*

2
src/ooxml/java/org/apache/poi/openxml4j/opc/internal/PackagePropertiesPart.java
View File

@ -22,7 +22,7 @@ import java.io.OutputStream;
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;

268
src/ooxml/java/org/apache/poi/util/IdentifierManager.java Normal file
View File

@ -0,0 +1,268 @@
/* ====================================================================
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.util;
import java.util.LinkedList;
import java.util.ListIterator;
/**
* <p>
* 24.08.2009<br>
* </p>
*
* @author Stefan Stern<br>
*/
public class IdentifierManager {
public static final long MAX_ID = Long.MAX_VALUE - 1;
public static final long MIN_ID = 0L;
/**
*
*/
private final long upperbound;
/**
*
*/
private final long lowerbound;
/**
* List of segments of available identifiers
*/
private LinkedList<Segment> segments;
/**
* @param lowerbound the lower limit of the id-range to manage. Must be greater than or equal to {@link #MIN_ID}.
* @param upperbound the upper limit of the id-range to manage. Must be less then or equal {@link #MAX_ID}.
*/
public IdentifierManager(long lowerbound, long upperbound) {
if (lowerbound > upperbound) {
String message = "lowerbound must not be greater than upperbound";
throw new IllegalArgumentException(message);
}
else if (lowerbound < MIN_ID) {
String message = "lowerbound must be greater than or equal to " + Long.toString(MIN_ID);
throw new IllegalArgumentException(message);
}
else if (upperbound > MAX_ID) {
/*
* while MAX_ID is Long.MAX_VALUE, this check is pointless. But if
* someone subclasses / tweaks the limits, this check if fine.
*/
String message = "upperbound must be less thean or equal " + Long.toString(MAX_ID);
throw new IllegalArgumentException(message);
}
this.lowerbound = lowerbound;
this.upperbound = upperbound;
this.segments = new LinkedList<Segment>();
segments.add(new Segment(lowerbound, upperbound));
}
public long reserve(long id) {
if (id < lowerbound || id > upperbound) {
throw new IllegalArgumentException("Value for parameter 'id' was out of bounds");
}
verifyIdentifiersLeft();
if (id == upperbound) {
Segment lastSegment = segments.getLast();
if (lastSegment.end == upperbound) {
lastSegment.end = upperbound - 1;
if (lastSegment.start > lastSegment.end) {
segments.removeLast();
}
return id;
}
return reserveNew();
}
if (id == lowerbound) {
Segment firstSegment = segments.getFirst();
if (firstSegment.start == lowerbound) {
firstSegment.start = lowerbound + 1;
if (firstSegment.end < firstSegment.start) {
segments.removeFirst();
}
return id;
}
return reserveNew();
}
ListIterator<Segment> iter = segments.listIterator();
while (iter.hasNext()) {
Segment segment = iter.next();
if (segment.end < id) {
continue;
}
else if (segment.start > id) {
break;
}
else if (segment.start == id) {
segment.start = id + 1;
if (segment.end < segment.start) {
iter.remove();
}
return id;
}
else if (segment.end == id) {
segment.end = id - 1;
if (segment.start > segment.end) {
iter.remove();
}
return id;
}
else {
iter.add(new Segment(id + 1, segment.end));
segment.end = id - 1;
return id;
}
}
return reserveNew();
}
/**
* @return a new identifier.
* @throws IllegalStateException if no more identifiers are available, then an Exception is raised.
*/
public long reserveNew() {
verifyIdentifiersLeft();
Segment segment = segments.getFirst();
long result = segment.start;
segment.start += 1;
if (segment.start > segment.end) {
segments.removeFirst();
}
return result;
}
/**
* @param id
* the identifier to release. Must be greater than or equal to
* {@link #lowerbound} and must be less than or equal to {@link #upperbound}
* @return true, if the identifier was reserved and has been successfully
* released, false, if the identifier was not reserved.
*/
public boolean release(long id) {
if (id < lowerbound || id > upperbound) {
throw new IllegalArgumentException("Value for parameter 'id' was out of bounds");
}
if (id == upperbound) {
Segment lastSegment = segments.getLast();
if (lastSegment.end == upperbound - 1) {
lastSegment.end = upperbound;
return true;
} else if (lastSegment.end == upperbound) {
return false;
} else {
segments.add(new Segment(upperbound, upperbound));
return true;
}
}
if (id == lowerbound) {
Segment firstSegment = segments.getFirst();
if (firstSegment.start == lowerbound + 1) {
firstSegment.start = lowerbound;
return true;
} else if (firstSegment.start == lowerbound) {
return false;
} else {
segments.addFirst(new Segment(lowerbound, lowerbound));
return true;
}
}
long higher = id + 1;
long lower = id - 1;
ListIterator<Segment> iter = segments.listIterator();
while (iter.hasNext()) {
Segment segment = iter.next();
if (segment.end < lower) {
continue;
}
if (segment.start > higher) {
iter.previous();
iter.add(new Segment(id, id));
return true;
}
if (segment.start == higher) {
segment.start = id;
return true;
}
else if (segment.end == lower) {
segment.end = id;
/* check if releasing this elements glues two segments into one */
if (iter.hasNext()) {
Segment next = iter.next();
if (next.start == segment.end + 1) {
segment.end = next.end;
iter.remove();
}
}
return true;
}
else {
/* id was not reserved, return false */
break;
}
}
return false;
}
public long getRemainingIdentifiers() {
long result = 0;
for (Segment segment : segments) {
result = result - segment.start;
result = result + segment.end + 1;
}
return result;
}
/**
*
*/
private void verifyIdentifiersLeft() {
if (segments.isEmpty()) {
throw new IllegalStateException("No identifiers left");
}
}
private static class Segment {
public Segment(long start, long end) {
this.start = start;
this.end = end;
}
public long start;
public long end;
/*
* (non-Javadoc)
*
* @see java.lang.Object#toString()
*/
public String toString() {
return "[" + start + "; " + end + "]";
}
}
}

2
src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFDrawing.java
View File

@ -213,7 +213,7 @@ public final class XSSFDrawing extends POIXMLDocumentPart implements Drawing {
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;
}

31
src/ooxml/java/org/apache/poi/xwpf/model/XWPFHeaderFooterPolicy.java
View File

@ -24,7 +24,6 @@ import java.util.List;
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;
@ -106,16 +105,11 @@ public class XWPFHeaderFooterPolicy {
for(int i=0; i<sectPr.sizeOfHeaderReferenceArray(); i++) {
// Get the header
CTHdrFtrRef ref = sectPr.getHeaderReferenceArray(i);
PackagePart hdrPart = doc.getPartById(ref.getId());
POIXMLDocumentPart relatedPart = doc.getRelationById(ref.getId());
XWPFHeader hdr = null;
for (POIXMLDocumentPart part : doc.getRelations()) {
if (part.getPackagePart().getPartName().equals(hdrPart.getPartName())) {
hdr = (XWPFHeader) part;
if (relatedPart != null && relatedPart instanceof XWPFHeader) {
hdr = (XWPFHeader) relatedPart;
}
}
// Assign it
Enum type = ref.getType();
assignHeader(hdr, type);
@ -123,17 +117,18 @@ public class XWPFHeaderFooterPolicy {
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());
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);
}
}
private void assignFooter(XWPFFooter ftr, Enum type) {
if(type == STHdrFtr.FIRST) {
firstPageFooter = ftr;
@ -144,7 +139,6 @@ public class XWPFHeaderFooterPolicy {
}
}
private void assignHeader(XWPFHeader hdr, Enum type) {
if(type == STHdrFtr.FIRST) {
firstPageHeader = hdr;
@ -180,8 +174,6 @@ public class XWPFHeaderFooterPolicy {
return wrapper;
}
public XWPFFooter createFooter(Enum type) throws IOException {
return createFooter(type, null);
}
@ -207,7 +199,6 @@ public class XWPFHeaderFooterPolicy {
return wrapper;
}
private int getRelationIndex(XWPFRelation relation) {
List<POIXMLDocumentPart> relations = doc.getRelations();
int i = 1;
@ -220,7 +211,6 @@ public class XWPFHeaderFooterPolicy {
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
@ -228,7 +218,6 @@ public class XWPFHeaderFooterPolicy {
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
@ -382,7 +371,6 @@ public class XWPFHeaderFooterPolicy {
return defaultFooter;
}
public void createWatermark(String text) {
XWPFParagraph[] pars = new XWPFParagraph[1];
try {
@ -398,7 +386,6 @@ public class XWPFHeaderFooterPolicy {
}
}
/*
* This is the default Watermark paragraph; the only variable is the text message
* TODO: manage all the other variables

3
src/ooxml/java/org/apache/poi/xwpf/usermodel/IBody.java
View File

@ -19,6 +19,7 @@ package org.apache.poi.xwpf.usermodel;
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;
@ -42,7 +43,7 @@ public interface IBody {
* belongs.
* @return the Part, to which the body belongs
*/
IBody getPart();
POIXMLDocumentPart getPart();
/**
* get the PartType of the body, for example

4
src/ooxml/java/org/apache/poi/xwpf/usermodel/IBodyElement.java
View File

@ -17,6 +17,7 @@
package org.apache.poi.xwpf.usermodel;
import org.apache.poi.POIXMLDocumentPart;
/**
* 9 Jan 2010
@ -24,7 +25,8 @@ package org.apache.poi.xwpf.usermodel;
*
*/
public interface IBodyElement{
IBody getPart();
IBody getBody();
POIXMLDocumentPart getPart();
BodyType getPartType();
BodyElementType getElementType();
}

373
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
View File

@ -16,12 +16,12 @@
==================================================================== */
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;
@ -36,6 +36,7 @@ import org.apache.poi.POIXMLDocument;
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;
@ -46,6 +47,7 @@ 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.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;
@ -85,16 +87,21 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
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;
@ -122,23 +129,12 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
@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();
@ -149,8 +145,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
XWPFParagraph p = new XWPFParagraph((CTP) o, this);
bodyElements.add(p);
paragraphs.add(p);
}
if (o instanceof CTTbl) {
} else if (o instanceof CTTbl) {
XWPFTable t = new XWPFTable((CTTbl) o, this);
bodyElements.add(t);
tables.add(t);
@ -167,28 +162,38 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
String relation = p.getPackageRelationship().getRelationshipType();
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())) {
footers.add((XWPFFooter)p);
XWPFFooter footer = (XWPFFooter) p;
footers.add(footer);
footer.onDocumentRead();
} else if (relation.equals(XWPFRelation.HEADER.getRelation())) {
headers.add((XWPFHeader)p);
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()) {
comments.add(new XWPFComment(ctcomment, this));
}
} 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(){
@ -251,16 +256,6 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
*/
@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();
@ -278,6 +273,10 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
return ctDocument;
}
IdentifierManager getDrawingIdManager() {
return drawingIdManager;
}
/**
* returns an Iterator with paragraphs and tables
* @see org.apache.poi.xwpf.usermodel.IBody#getBodyElements()
@ -340,8 +339,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
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;
@ -363,15 +361,12 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
}
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;
@ -379,10 +374,9 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
return null;
}
public XWPFComment[] getComments() {
return comments.toArray(
new XWPFComment[comments.size()]
);
return comments.toArray(new XWPFComment[comments.size()]);
}
/**
@ -391,9 +385,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
*/
public PackagePart getPartById(String id) {
try {
return getTargetPart(
getCorePart().getRelationship(id)
);
return getTargetPart(getCorePart().getRelationship(id));
} catch (InvalidFormatException e) {
throw new IllegalArgumentException(e);
}
@ -422,8 +414,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
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();
}
@ -435,11 +426,13 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
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;
}
@ -475,11 +468,15 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
}
/**
* 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) {
@ -498,39 +495,78 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
}
/**
* 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();
/*
* 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{
} 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(p.newCursor());
cursor.toCursor(newParaPos);
while (cursor.toPrevSibling()) {
o = cursor.getObject();
if (o instanceof CTP || o instanceof CTTbl)
i++;
}
bodyElements.add(i, newP);
cursor.toCursor(p.newCursor());
cursor.toCursor(newParaPos);
cursor.toEndToken();
return newP;
} finally {
newParaPos.dispose();
}
}
return null;
}
@ -550,8 +586,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
}
if (!(o instanceof CTTbl)) {
tables.add(0, newT);
}
else{
} else {
int pos = tables.indexOf(getTable((CTTbl) o)) + 1;
tables.add(pos, newT);
}
@ -577,12 +612,11 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
private boolean isCursorInBody(XmlCursor cursor) {
XmlCursor verify = cursor.newCursor();
verify.toParent();
if(verify.getObject() == this.ctDocument.getBody()){
return true;
try {
return (verify.getObject() == this.ctDocument.getBody());
} finally {
verify.dispose();
}
XmlObject o = verify.getObject();
return false;
}
private int getPosOfBodyElement(IBodyElement needle) {
@ -756,6 +790,10 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
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.)
*/
}
/**
@ -790,7 +828,6 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
return table;
}
/**
*
*/
@ -803,8 +840,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
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();
}
}
@ -961,20 +997,6 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
settings.removeEnforcement();
}
/**
* Return the zoom level, as a percentage
*/
public long getZoomPercent() {
return settings.getZoomPercent();
}
/**
* Sets the zoom level, as a percentage
*/
public void setZoomPercent(long zoomPercent) {
settings.setZoomPercent(zoomPercent);
}
/**
* inserts an existing XWPFTable to the arrays bodyElements and tables
* @param pos
@ -992,67 +1014,120 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
tables.add(i, table);
}
/**
* 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 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
*/
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());
List<XWPFPictureData> result = new ArrayList<XWPFPictureData>();
Collection<List<XWPFPictureData>> values = packagePictures.values();
for (List<XWPFPictureData> list : values) {
result.addAll(list);
}
}
return pkgpictures;
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}
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);
}
}
*
* @return the index to this picture (0 based), the added picture can be obtained from {@link #getAllPictures()} .
* @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.
*/
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;
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;
}
/**
* 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 {
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 {
return addPicture(new ByteArrayInputStream(pictureData), format);
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 {
byte[] data = IOUtils.toByteArray(is);
return addPictureData(data, format);
} catch (IOException e) {
throw new POIXMLException(e);
}
@ -1080,17 +1155,12 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
* 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;
}
}
}
POIXMLDocumentPart relatedPart = getRelationById(blipID);
if (relatedPart instanceof XWPFPictureData) {
XWPFPictureData xwpfPicData = (XWPFPictureData) relatedPart;
return xwpfPicData;
}
return null;
}
@ -1119,7 +1189,9 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
*/
public XWPFParagraph getParagraph(CTP p) {
for (int i = 0; i < getParagraphs().size(); i++) {
if(getParagraphs().get(i).getCTP() == p) return getParagraphs().get(i);
if (getParagraphs().get(i).getCTP() == p) {
return getParagraphs().get(i);
}
}
return null;
}
@ -1132,7 +1204,9 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
*/
public XWPFTable getTable(CTTbl ctTbl) {
for (int i = 0; i < tables.size(); i++) {
if(getTables().get(i).getCTTbl() == ctTbl) return getTables().get(i);
if (getTables().get(i).getCTTbl() == ctTbl) {
return getTables().get(i);
}
}
return null;
}
@ -1157,18 +1231,17 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
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 IBody getPart() {
public POIXMLDocumentPart getPart() {
return this;
}
/**
* get the PartType of the body, for example
* DOCUMENT, HEADER, FOOTER, FOOTNOTE,

29
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFFooter.java
View File

@ -19,17 +19,16 @@ package org.apache.poi.xwpf.usermodel;
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;
@ -48,9 +47,6 @@ public class XWPFFooter extends XWPFHeaderFooter {
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();
cursor.selectPath("./*");
while (cursor.toNextSelection()) {
@ -67,7 +63,6 @@ public class XWPFFooter extends XWPFHeaderFooter {
}
}
cursor.dispose();
getAllPictures();
}
public XWPFFooter(POIXMLDocumentPart parent, PackagePart part, PackageRelationship rel) throws IOException {
@ -99,10 +94,8 @@ public class XWPFFooter extends XWPFHeaderFooter {
}
@Override
protected void onDocumentRead(){
bodyElements = new ArrayList<IBodyElement>();
paragraphs = new ArrayList<XWPFParagraph>();
tables= new ArrayList<XWPFTable>();
protected void onDocumentRead() throws IOException{
super.onDocumentRead();
FtrDocument ftrDocument = null;
InputStream is;
try {
@ -127,22 +120,10 @@ public class XWPFFooter extends XWPFHeaderFooter {
}
}
cursor.dispose();
getAllPictures();
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (XmlException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (Exception e) {
throw new POIXMLException(e);
}
}
/**
* 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

36
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFHeader.java
View File

@ -19,13 +19,13 @@ package org.apache.poi.xwpf.usermodel;
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;
@ -50,10 +50,8 @@ public class XWPFHeader extends XWPFHeaderFooter {
super(parent, part, rel);
}
public XWPFHeader(XWPFDocument doc, CTHdrFtr hdrFtr) throws IOException {
public XWPFHeader(XWPFDocument doc, CTHdrFtr hdrFtr) {
super(doc, hdrFtr);
paragraphs = new ArrayList<XWPFParagraph>();
tables = new ArrayList<XWPFTable>();
XmlCursor cursor = headerFooter.newCursor();
cursor.selectPath("./*");
while (cursor.toNextSelection()) {
@ -68,13 +66,6 @@ public class XWPFHeader extends XWPFHeaderFooter {
}
}
cursor.dispose();
getAllPictures();
}
/**
public XWPFHeader(PackagePart part, PackageRelationship rel)
throws IOException {
super(part, rel);
}
/**
@ -103,12 +94,11 @@ public class XWPFHeader extends XWPFHeaderFooter {
/**
* reads the document
* @throws IOException
*/
@Override
protected void onDocumentRead(){
bodyElements = new ArrayList<IBodyElement>();
paragraphs = new ArrayList<XWPFParagraph>();
tables= new ArrayList<XWPFTable>();
protected void onDocumentRead() throws IOException {
super.onDocumentRead();
HdrDocument hdrDocument = null;
InputStream is;
try {
@ -133,23 +123,11 @@ public class XWPFHeader extends XWPFHeaderFooter {
}
}
cursor.dispose();
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (XmlException e) {
// TODO Auto-generated catch block
e.printStackTrace();
throw new POIXMLException(e);
}
}
/**
* 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()
@ -157,6 +135,4 @@ public class XWPFHeader extends XWPFHeaderFooter {
public BodyType getPartType() {
return BodyType.HEADER;
}
}//end class

218
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java
View File

@ -25,11 +25,12 @@ import java.util.List;
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;
@ -44,14 +45,15 @@ import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTc;
* 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;
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);
protected XWPFHeaderFooter(XWPFDocument doc, CTHdrFtr hdrFtr){
CTHdrFtr headerFooter;
XWPFDocument document;
XWPFHeaderFooter(XWPFDocument doc, CTHdrFtr hdrFtr){
if (doc==null) {
throw new NullPointerException();
}
@ -66,7 +68,6 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
readHdrFtr();
}
public XWPFHeaderFooter(POIXMLDocumentPart parent, PackagePart part, PackageRelationship rel) throws IOException {
super(parent, part, rel);
this.document = (XWPFDocument)getParent();
@ -74,8 +75,17 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
if (this.document==null) {
throw new NullPointerException();
}
}
onDocumentRead();
@Override
protected void onDocumentRead() throws IOException {
for (POIXMLDocumentPart poixmlDocumentPart : getRelations()){
if(poixmlDocumentPart instanceof XWPFPictureData){
XWPFPictureData xwpfPicData = (XWPFPictureData) poixmlDocumentPart;
pictures.add(xwpfPicData);
document.registerPackagePictureData(xwpfPicData);
}
}
}
@Internal
@ -201,15 +211,7 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
}
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);
}
/**
@ -217,14 +219,8 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
* @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();
}
/**
@ -234,61 +230,76 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
* @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);
}
/**
@ -298,63 +309,13 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
* @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;
}
}
}
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
*/
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;
}
/**
* 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
@ -505,7 +466,6 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
}
}
cursor.dispose();
getAllPictures();
}
/**
@ -545,4 +505,12 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
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

12
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFNumbering.java
View File

@ -44,10 +44,11 @@ import org.openxmlformats.schemas.wordprocessingml.x2006.main.NumberingDocument;
*
*/
public class XWPFNumbering extends POIXMLDocumentPart {
protected List<XWPFAbstractNum> abstractNums = new ArrayList<XWPFAbstractNum>();
protected List<XWPFNum> nums = new ArrayList<XWPFNum>();
private CTNumbering ctNumbering;
protected List<XWPFAbstractNum> abstractNums;
protected List<XWPFNum> nums;
protected boolean isNew;
boolean isNew;
/**
*create a new styles object with an existing document
@ -55,7 +56,6 @@ public class XWPFNumbering extends POIXMLDocumentPart {
public XWPFNumbering(PackagePart part, PackageRelationship rel) throws IOException, OpenXML4JException{
super(part, rel);
isNew = true;
onDocumentRead();
}
/**
@ -72,8 +72,6 @@ public class XWPFNumbering extends POIXMLDocumentPart {
*/
@Override
protected void onDocumentRead() throws IOException{
abstractNums = new ArrayList<XWPFAbstractNum>();
nums = new ArrayList<XWPFNum>();
NumberingDocument numberingDoc = null;
InputStream is;
is = getPackagePart().getInputStream();
@ -100,7 +98,7 @@ public class XWPFNumbering extends POIXMLDocumentPart {
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");

34
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java
View File

@ -21,6 +21,7 @@ import java.util.ArrayList;
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;
@ -50,7 +51,6 @@ import org.openxmlformats.schemas.wordprocessingml.x2006.main.STLineSpacingRule;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STOnOff;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STTextAlignment;
/**
* Sketch of XWPF paragraph class
*/
@ -260,9 +260,9 @@ public class XWPFParagraph implements IBodyElement{
* @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;
}
/**
@ -1241,11 +1241,17 @@ public class XWPFParagraph implements IBodyElement{
return BodyElementType.PARAGRAPH;
}
@Override
public IBody getBody()
{
return part;
}
/**
* returns the part of the bodyElement
* @see org.apache.poi.xwpf.usermodel.IBody#getPart()
*/
public IBody getPart() {
public POIXMLDocumentPart getPart() {
if(part != null){
return part.getPart();
}
@ -1254,6 +1260,7 @@ public class XWPFParagraph implements IBodyElement{
/**
* returns the partType of the bodyPart which owns the bodyElement
*
* @see org.apache.poi.xwpf.usermodel.IBody#getPartType()
*/
public BodyType getPartType() {
@ -1262,24 +1269,29 @@ public class XWPFParagraph implements IBodyElement{
/**
* 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);
if (getRuns().get(i).getCTR() == r) {
return getRuns().get(i);
}
}
return null;
}
}//end class

20
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFPicture.java
View File

@ -25,16 +25,13 @@ import org.openxmlformats.schemas.drawingml.x2006.picture.CTPicture;
* @author Philipp Epp
*/
public class XWPFPicture {
protected XWPFParagraph paragraph;
private CTPicture ctPic;
private String description;
private XWPFRun run;
public XWPFParagraph getParagraph(){
return paragraph;
}
public XWPFPicture(CTPicture ctPic, XWPFParagraph paragraph){
this.paragraph = paragraph;
public XWPFPicture(CTPicture ctPic, XWPFRun run){
this.run = run;
this.ctPic = ctPic;
description = ctPic.getNvPicPr().getCNvPr().getDescr();
}
@ -62,9 +59,12 @@ public class XWPFPicture {
*/
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;
POIXMLDocumentPart part = run.getParagraph().getPart();
if (part != null)
{
POIXMLDocumentPart relatedPart = part.getRelationById(blipId);
if (relatedPart instanceof XWPFPictureData) {
return (XWPFPictureData) relatedPart;
}
}
return null;

116
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFPictureData.java
View File

@ -18,9 +18,13 @@
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;
@ -32,7 +36,6 @@ import org.apache.poi.util.IOUtils;
/**
* @author Philipp Epp
*
*/
public class XWPFPictureData extends POIXMLDocumentPart {
@ -50,6 +53,9 @@ public class XWPFPictureData extends POIXMLDocumentPart {
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
*
@ -65,11 +71,15 @@ public class XWPFPictureData extends POIXMLDocumentPart {
* @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) {
super(part, rel);
}
@Override
protected void onDocumentRead() throws IOException {
super.onDocumentRead();
}
/**
* Gets the picture data as a byte array.
* <p>
@ -80,23 +90,20 @@ public class XWPFPictureData extends POIXMLDocumentPart {
* 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();
throw new POIXMLException(e);
}
return null;
}
/**
* 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();
@ -107,7 +114,6 @@ public class XWPFPictureData extends POIXMLDocumentPart {
/**
* Suggests a file extension for this image.
*
* @return the file extension.
*/
public String suggestFileExtension() {
@ -128,7 +134,9 @@ public class XWPFPictureData extends POIXMLDocumentPart {
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)) {
return i;
@ -136,4 +144,90 @@ public class XWPFPictureData extends POIXMLDocumentPart {
}
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();
}
}

65
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFRun.java
View File

@ -45,6 +45,7 @@ import org.openxmlformats.schemas.drawingml.x2006.main.CTPresetGeometry2D;
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;
@ -88,14 +89,33 @@ public class XWPFRun {
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");
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++) {
@ -114,7 +134,7 @@ public class XWPFRun {
pictures = new ArrayList<XWPFPicture>();
for(XmlObject o : pictTextObjs) {
for(CTPicture pict : getCTPictures(o)) {
XWPFPicture picture = new XWPFPicture( pict, p );
XWPFPicture picture = new XWPFPicture(pict, this);
pictures.add(picture);
}
}
@ -156,6 +176,17 @@ public class XWPFRun {
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
*/
@ -177,8 +208,9 @@ public class XWPFRun {
*/
public boolean isBold() {
CTRPr pr = run.getRPr();
if(pr == null || !pr.isSetB())
if(pr == null || !pr.isSetB()) {
return false;
}
return isCTOnOff(pr.getB());
}
@ -251,7 +283,6 @@ public class XWPFRun {
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.
@ -384,8 +415,7 @@ public class XWPFRun {
*/
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;
}
/**
@ -546,7 +576,6 @@ public class XWPFRun {
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
@ -607,8 +636,8 @@ public class XWPFRun {
XWPFDocument doc = paragraph.document;
// Add the picture + relationship
int picNumber = doc.addPicture(pictureData, pictureType);
XWPFPictureData picData = doc.getAllPackagePictures().get(picNumber);
String relationId = doc.addPictureData(pictureData, pictureType);
XWPFPictureData picData = (XWPFPictureData) doc.getRelationById(relationId);
// Create the drawing entry for it
try {
@ -632,8 +661,10 @@ public class XWPFRun {
inline.setDistL(0);
CTNonVisualDrawingProps docPr = inline.addNewDocPr();
docPr.setId(picNumber);
docPr.setName("Picture " + picNumber);
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();
@ -649,8 +680,10 @@ public class XWPFRun {
CTPictureNonVisual nvPicPr = pic.addNewNvPicPr();
CTNonVisualDrawingProps cNvPr = nvPicPr.addNewCNvPr();
cNvPr.setId(picNumber);
cNvPr.setName("Picture " + picNumber);
/* 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();
@ -677,7 +710,7 @@ public class XWPFRun {
prstGeom.addNewAvLst();
// Finish up
XWPFPicture xwpfPicture = new XWPFPicture(pic, paragraph);
XWPFPicture xwpfPicture = new XWPFPicture(pic, this);
pictures.add(xwpfPicture);
return xwpfPicture;
} catch(XmlException e) {

8
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSettings.java
View File

@ -42,7 +42,6 @@ public class XWPFSettings extends POIXMLDocumentPart {
public XWPFSettings(PackagePart part, PackageRelationship rel) throws IOException {
super(part, rel);
readFrom(part.getInputStream());
}
public XWPFSettings() {
@ -50,6 +49,13 @@ public class XWPFSettings extends POIXMLDocumentPart {
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/>

11
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFStyles.java
View File

@ -24,7 +24,6 @@ import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.lang.String;
import javax.xml.namespace.QName;
@ -49,9 +48,10 @@ import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTDocDefaults;
*
*/
public class XWPFStyles extends POIXMLDocumentPart{
private List<XWPFStyle> listStyle = new ArrayList<XWPFStyle>();
private CTStyles ctStyles;
protected XWPFLatentStyles latentStyles;
protected List<XWPFStyle> listStyle;
XWPFLatentStyles latentStyles;
/**
* Construct XWPFStyles from a package part
@ -62,14 +62,12 @@ public class XWPFStyles extends POIXMLDocumentPart{
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>();
}
/**
@ -77,7 +75,6 @@ public class XWPFStyles extends POIXMLDocumentPart{
*/
@Override
protected void onDocumentRead ()throws IOException{
listStyle = new ArrayList<XWPFStyle>();
StylesDocument stylesDoc;
try {
InputStream is = getPackagePart().getInputStream();
@ -98,7 +95,7 @@ public class XWPFStyles extends POIXMLDocumentPart{
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);

20
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFTable.java
View File

@ -20,6 +20,7 @@ import java.math.BigInteger;
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;
@ -58,7 +59,6 @@ public class XWPFTable implements IBodyElement{
}
}
public XWPFTable(CTTbl table, IBody part){
this.part = part;
this.ctTbl = table;
@ -131,17 +131,17 @@ public class XWPFTable implements IBodyElement{
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();
@ -268,7 +268,7 @@ public class XWPFTable implements IBodyElement{
* @param pos position the Row in the Table
*/
public boolean removeRow(int pos) throws IndexOutOfBoundsException {
if(pos > 0 && pos < tableRows.size()){
if (pos >= 0 && pos < tableRows.size()) {
ctTbl.removeTr(pos);
tableRows.remove(pos);
return true;
@ -289,25 +289,29 @@ public class XWPFTable implements IBodyElement{
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() {
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();
return part.getPartType();
}
/**

7
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFTableCell.java
View File

@ -20,6 +20,7 @@ import java.util.ArrayList;
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;
@ -248,14 +249,12 @@ public class XWPFTableCell implements IBody {
return null;
}
/**
* get the to which the TableCell belongs
*
* @see org.apache.poi.xwpf.usermodel.IBody#getPart()
*/
public IBody getPart() {
public POIXMLDocumentPart getPart() {
return tableRow.getTable().getPart();
}

6
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFTableRow.java
View File

@ -52,7 +52,7 @@ public class XWPFTableRow {
* @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;
}
@ -69,7 +69,7 @@ public class XWPFTableRow {
*/
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;
}
@ -123,7 +123,7 @@ public class XWPFTableRow {
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;
}

11
src/ooxml/testcases/org/apache/poi/TestPOIXMLDocument.java
View File

@ -141,4 +141,15 @@ public final class TestPOIXMLDocument extends TestCase {
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);
}
}
}

144
src/ooxml/testcases/org/apache/poi/TestPOIXMLDocumentPart.java Normal file
View File

@ -0,0 +1,144 @@
/* ====================================================================
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"))
);
}
}

13
src/ooxml/testcases/org/apache/poi/TestPOIXMLProperties.java
View File

@ -17,16 +17,21 @@
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
@ -35,7 +40,7 @@ public final class TestPOIXMLProperties extends TestCase {
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();
@ -152,7 +157,7 @@ public final class TestPOIXMLProperties extends TestCase {
assertEquals("Hello World", title);
}
public void testTransitiveSetters() {
public void testTransitiveSetters() throws IOException {
XWPFDocument doc = new XWPFDocument();
CoreProperties cp = doc.getProperties().getCoreProperties();

23
src/ooxml/testcases/org/apache/poi/openxml4j/opc/TestPackage.java
View File

@ -25,8 +25,8 @@ import java.io.IOException;
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;
@ -509,4 +509,23 @@ public final class TestPackage extends 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"));
}
}

113
src/ooxml/testcases/org/apache/poi/util/TestIdentifierManager.java Normal file
View File

@ -0,0 +1,113 @@
package org.apache.poi.util;
import junit.framework.TestCase;
public class TestIdentifierManager extends TestCase
{
public void testBasic()
{
IdentifierManager manager = new IdentifierManager(0L,100L);
assertEquals(101L,manager.getRemainingIdentifiers());
assertEquals(0L,manager.reserveNew());
assertEquals(100L,manager.getRemainingIdentifiers());
assertEquals(1L,manager.reserve(0L));
assertEquals(99L,manager.getRemainingIdentifiers());
}
public void testLongLimits()
{
long min = IdentifierManager.MIN_ID;
long max = IdentifierManager.MAX_ID;
IdentifierManager manager = new IdentifierManager(min,max);
assertTrue("Limits lead to a long variable overflow", max - min + 1 > 0);
assertTrue("Limits lead to a long variable overflow", manager.getRemainingIdentifiers() > 0);
assertEquals(min,manager.reserveNew());
assertEquals(max,manager.reserve(max));
assertEquals(max - min -1, manager.getRemainingIdentifiers());
manager.release(max);
manager.release(min);
}
public void testReserve()
{
IdentifierManager manager = new IdentifierManager(10L,30L);
assertEquals(12L,manager.reserve(12L));
long reserve = manager.reserve(12L);
assertFalse("Same id must be reserved twice!",reserve == 12L);
assertTrue(manager.release(12L));
assertTrue(manager.release(reserve));
assertFalse(manager.release(12L));
assertFalse(manager.release(reserve));
manager = new IdentifierManager(0L,2L);
assertEquals(0L,manager.reserve(0L));
assertEquals(1L,manager.reserve(1L));
assertEquals(2L,manager.reserve(2L));
try
{
manager.reserve(0L);
fail("Exception expected");
}
catch(IllegalStateException e)
{
// expected
}
try
{
manager.reserve(1L);
fail("Exception expected");
}
catch(IllegalStateException e)
{
// expected
}
try
{
manager.reserve(2L);
fail("Exception expected");
}
catch(IllegalStateException e)
{
// expected
}
}
public void testReserveNew()
{
IdentifierManager manager = new IdentifierManager(10L,12L);
assertSame(10L,manager.reserveNew());
assertSame(11L,manager.reserveNew());
assertSame(12L,manager.reserveNew());
try {
manager.reserveNew();
fail("IllegalStateException expected");
}
catch (IllegalStateException e)
{
// expected
}
}
public void testRelease() {
IdentifierManager manager = new IdentifierManager(10L,20L);
assertEquals(10L,manager.reserve(10L));
assertEquals(11L,manager.reserve(11L));
assertEquals(12L,manager.reserve(12L));
assertEquals(13L,manager.reserve(13L));
assertEquals(14L,manager.reserve(14L));
assertTrue(manager.release(10L));
assertEquals(10L,manager.reserve(10L));
assertTrue(manager.release(10L));
assertTrue(manager.release(11L));
assertEquals(11L,manager.reserve(11L));
assertTrue(manager.release(11L));
assertFalse(manager.release(11L));
assertFalse(manager.release(10L));
assertEquals(10L,manager.reserve(10L));
assertEquals(11L,manager.reserve(11L));
assertTrue(manager.release(12L));
}
}

1
src/ooxml/testcases/org/apache/poi/xwpf/AllXWPFTests.java
View File

@ -22,6 +22,7 @@ import junit.framework.TestSuite;
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;

4
src/ooxml/testcases/org/apache/poi/xwpf/TestAllExtendedProperties.java
View File

@ -17,6 +17,8 @@
package org.apache.poi.xwpf;
import java.io.IOException;
import junit.framework.TestCase;
import org.apache.poi.POIXMLProperties.CoreProperties;
@ -41,7 +43,7 @@ import org.openxmlformats.schemas.officeDocument.x2006.extendedProperties.CTVect
*
*/
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());

4
src/ooxml/testcases/org/apache/poi/xwpf/TestPackageCorePropertiesGetKeywords.java
View File

@ -17,6 +17,8 @@
package org.apache.poi.xwpf;
import java.io.IOException;
import junit.framework.TestCase;
import org.apache.poi.POIXMLProperties.CoreProperties;
@ -37,7 +39,7 @@ import org.apache.poi.xwpf.usermodel.XWPFDocument;
*
*/
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);

20
src/ooxml/testcases/org/apache/poi/xwpf/XWPFTestDataSamples.java
View File

@ -22,6 +22,8 @@ import java.io.IOException;
import java.io.InputStream;
import org.apache.poi.POIDataSamples;
import org.apache.poi.util.IOUtils;
import org.apache.poi.util.PackageHelper;
import org.apache.poi.xwpf.usermodel.XWPFDocument;
/**
@ -29,23 +31,21 @@ import org.apache.poi.xwpf.usermodel.XWPFDocument;
*/
public class XWPFTestDataSamples {
public static XWPFDocument openSampleDocument(String sampleName) {
public static XWPFDocument openSampleDocument(String sampleName) throws IOException {
InputStream is = POIDataSamples.getDocumentInstance().openResourceAsStream(sampleName);
try {
return new XWPFDocument(is);
} catch (IOException e) {
throw new RuntimeException(e);
}
}
public static XWPFDocument writeOutAndReadBack(XWPFDocument doc) {
try {
public static XWPFDocument writeOutAndReadBack(XWPFDocument doc) throws IOException {
ByteArrayOutputStream baos = new ByteArrayOutputStream(4096);
doc.write(baos);
ByteArrayInputStream bais = new ByteArrayInputStream(baos.toByteArray());
return new XWPFDocument(bais);
} catch (IOException e) {
throw new RuntimeException(e);
}
}
public static byte[] getImage(String filename) throws IOException {
InputStream is = POIDataSamples.getDocumentInstance().openResourceAsStream(filename);
byte[] result = IOUtils.toByteArray(is);
return result;
}
}

36
src/ooxml/testcases/org/apache/poi/xwpf/extractor/TestXWPFWordExtractor.java
View File

@ -17,6 +17,8 @@
package org.apache.poi.xwpf.extractor;
import java.io.IOException;
import junit.framework.TestCase;
import org.apache.poi.xwpf.XWPFTestDataSamples;
@ -29,8 +31,9 @@ public class TestXWPFWordExtractor extends TestCase {
/**
* 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);
@ -58,8 +61,9 @@ public class TestXWPFWordExtractor extends TestCase {
/**
* 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);
@ -91,7 +95,7 @@ public class TestXWPFWordExtractor extends TestCase {
assertEquals(134, ps);
}
public void testGetWithHyperlinks() {
public void testGetWithHyperlinks() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("TestDocument.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
@ -116,7 +120,7 @@ public class TestXWPFWordExtractor extends TestCase {
);
}
public void testHeadersFooters() {
public void testHeadersFooters() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("ThreeColHeadFoot.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
@ -159,7 +163,7 @@ public class TestXWPFWordExtractor extends TestCase {
);
}
public void testFootnotes() {
public void testFootnotes() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("footnotes.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
@ -167,14 +171,14 @@ public class TestXWPFWordExtractor extends TestCase {
}
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);
@ -183,14 +187,14 @@ public class TestXWPFWordExtractor extends TestCase {
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);
@ -198,7 +202,7 @@ public class TestXWPFWordExtractor extends TestCase {
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);
@ -210,8 +214,9 @@ public class TestXWPFWordExtractor extends TestCase {
/**
* 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);
@ -224,8 +229,9 @@ public class TestXWPFWordExtractor extends TestCase {
* 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);
@ -241,8 +247,9 @@ public class TestXWPFWordExtractor extends TestCase {
/**
* 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();
@ -254,8 +261,9 @@ public class TestXWPFWordExtractor extends TestCase {
/**
* 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();

4
src/ooxml/testcases/org/apache/poi/xwpf/model/TestXWPFDecorators.java
View File

@ -17,6 +17,8 @@
package org.apache.poi.xwpf.model;
import java.io.IOException;
import junit.framework.TestCase;
import org.apache.poi.xwpf.XWPFTestDataSamples;
@ -32,7 +34,7 @@ public class TestXWPFDecorators extends TestCase {
private XWPFDocument hyperlink;
private XWPFDocument comments;
protected void setUp() {
protected void setUp() throws IOException {
simple = XWPFTestDataSamples.openSampleDocument("SampleDoc.docx");
hyperlink = XWPFTestDataSamples.openSampleDocument("TestDocument.docx");
comments = XWPFTestDataSamples.openSampleDocument("WordWithAttachments.docx");

4
src/ooxml/testcases/org/apache/poi/xwpf/model/TestXWPFHeaderFooterPolicy.java
View File

@ -17,6 +17,8 @@
package org.apache.poi.xwpf.model;
import java.io.IOException;
import junit.framework.TestCase;
import org.apache.poi.xwpf.XWPFTestDataSamples;
@ -33,7 +35,7 @@ public class TestXWPFHeaderFooterPolicy extends TestCase {
private XWPFDocument oddEven;
private XWPFDocument diffFirst;
protected void setUp() {
protected void setUp() throws IOException {
noHeader = XWPFTestDataSamples.openSampleDocument("NoHeadFoot.docx");
header = XWPFTestDataSamples.openSampleDocument("ThreeColHead.docx");

182
src/ooxml/testcases/org/apache/poi/xwpf/TestXWPFDocument.java → src/ooxml/testcases/org/apache/poi/xwpf/usermodel/TestXWPFDocument.java
View File

@ -15,9 +15,11 @@
limitations under the License.
==================================================================== */
package org.apache.poi.xwpf;
package org.apache.poi.xwpf.usermodel;
import java.util.ArrayList;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Arrays;
import java.util.List;
import junit.framework.TestCase;
@ -27,10 +29,11 @@ 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.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;
@ -70,7 +73,7 @@ public final class TestXWPFDocument extends TestCase {
assertNotNull(xml.getStyle());
}
public void testMetadataBasics() {
public void testMetadataBasics() throws IOException {
XWPFDocument xml = XWPFTestDataSamples.openSampleDocument("sample.docx");
assertNotNull(xml.getProperties().getCoreProperties());
assertNotNull(xml.getProperties().getExtendedProperties());
@ -83,7 +86,7 @@ public final class TestXWPFDocument extends TestCase {
assertEquals(null, xml.getProperties().getCoreProperties().getUnderlyingProperties().getSubjectProperty().getValue());
}
public void testMetadataComplex() {
public void testMetadataComplex() throws IOException {
XWPFDocument xml = XWPFTestDataSamples.openSampleDocument("IllustrativeCases.docx");
assertNotNull(xml.getProperties().getCoreProperties());
assertNotNull(xml.getProperties().getExtendedProperties());
@ -103,7 +106,7 @@ public final class TestXWPFDocument extends TestCase {
assertEquals("Apache POI", props.getExtendedProperties().getUnderlyingProperties().getApplication());
}
public void testAddParagraph(){
public void testAddParagraph() throws IOException{
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("sample.docx");
assertEquals(3, doc.getParagraphs().size());
@ -123,23 +126,21 @@ public final class TestXWPFDocument extends TestCase {
assertEquals(5, doc.getParagraphs().size());
}
public void testAddPicture(){
public void testAddPicture() throws IOException, InvalidFormatException
{
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();
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++){
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() {
public void testRemoveBodyElement() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("sample.docx");
assertEquals(3, doc.getParagraphs().size());
assertEquals(3, doc.getBodyElements().size());
@ -200,46 +201,119 @@ public final class TestXWPFDocument extends TestCase {
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());
public void testRegisterPackagePictureData() throws IOException, InvalidFormatException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("issue_51265_1.docx");
doc.setZoomPercent(124);
/* 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 */
// Only one enforcement allowed, last one wins!
doc.enforceFillingFormsProtection();
doc.enforceReadonlyProtection();
assertFalse(xwpfHeader.getAllPictures().contains(newPicData));
assertFalse(doc.getAllPictures().contains(newPicData));
assertFalse(doc.getAllPackagePictures().contains(newPicData));
doc = XWPFTestDataSamples.writeOutAndReadBack(doc);
doc.registerPackagePictureData(newPicData);
assertEquals(124, doc.getZoomPercent());
assertEquals(false, doc.isEnforcedCommentsProtection());
assertEquals(false, doc.isEnforcedFillingFormsProtection());
assertEquals(true, doc.isEnforcedReadonlyProtection());
assertEquals(false, doc.isEnforcedTrackedChangesProtection());
assertFalse(xwpfHeader.getAllPictures().contains(newPicData));
assertFalse(doc.getAllPictures().contains(newPicData));
assertTrue(doc.getAllPackagePictures().contains(newPicData));
doc.getPackage().revert();
}
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);
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();
}
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));
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();
}
}

22
src/ooxml/testcases/org/apache/poi/xwpf/usermodel/TestXWPFHeader.java
View File

@ -29,7 +29,7 @@ import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTText;
public final class TestXWPFHeader extends TestCase {
public void testSimpleHeader() {
public void testSimpleHeader() throws IOException {
XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("headerFooter.docx");
XWPFHeaderFooterPolicy policy = sampleDoc.getHeaderFooterPolicy();
@ -40,7 +40,7 @@ public final class TestXWPFHeader extends TestCase {
assertNotNull(footer);
}
public void testImageInHeader() {
public void testImageInHeader() throws IOException {
XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("headerPic.docx");
XWPFHeaderFooterPolicy policy = sampleDoc.getHeaderFooterPolicy();
@ -122,7 +122,7 @@ public final class TestXWPFHeader extends TestCase {
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();
@ -136,4 +136,20 @@ public final class TestXWPFHeader extends TestCase {
assertNotNull(policy.getFirstPageHeader());
assertNotNull(policy.getEvenPageHeader());
}
public void testAddPictureData() {
}
public void testGetAllPictures() {
}
public void testGetAllPackagePictures() {
}
public void testGetPictureDataById() {
}
}

3
src/ooxml/testcases/org/apache/poi/xwpf/usermodel/TestXWPFNumbering.java
View File

@ -17,6 +17,7 @@
package org.apache.poi.xwpf.usermodel;
import java.io.IOException;
import java.math.BigInteger;
import junit.framework.TestCase;
@ -25,7 +26,7 @@ import org.apache.poi.xwpf.XWPFTestDataSamples;
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);

9
src/ooxml/testcases/org/apache/poi/xwpf/usermodel/TestXWPFParagraph.java
View File

@ -17,6 +17,7 @@
package org.apache.poi.xwpf.usermodel;
import java.io.IOException;
import java.math.BigInteger;
import java.util.List;
@ -49,8 +50,9 @@ public final class TestXWPFParagraph extends TestCase {
/**
* 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();
@ -67,8 +69,9 @@ public final class TestXWPFParagraph extends TestCase {
/**
* 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());
@ -231,7 +234,7 @@ public final class TestXWPFParagraph extends TestCase {
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());

64
src/ooxml/testcases/org/apache/poi/xwpf/usermodel/TestXWPFPictureData.java
View File

@ -17,6 +17,7 @@
package org.apache.poi.xwpf.usermodel;
import java.io.IOException;
import java.util.Arrays;
import java.util.List;
@ -29,37 +30,33 @@ import org.apache.poi.xwpf.XWPFTestDataSamples;
import org.apache.poi.xwpf.model.XWPFHeaderFooterPolicy;
public class TestXWPFPictureData extends TestCase {
public void testRead(){
public void testRead() throws InvalidFormatException, IOException
{
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++) {
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};
byte[] pictureData = XWPFTestDataSamples.getImage("nature1.jpg");
int idx;
try {
idx = sampleDoc.addPicture(pictureData, XWPFDocument.PICTURE_TYPE_JPEG);
String relationId = sampleDoc.addPictureData(pictureData,XWPFDocument.PICTURE_TYPE_JPEG);
// picture list was updated
assertEquals(num + 1,pictures.size());
//idx is 0-based index in the #pictures array
assertEquals(pictures.size() - 1, idx);
XWPFPictureData pict = pictures.get(idx);
XWPFPictureData pict = (XWPFPictureData) sampleDoc.getRelationById(relationId);
assertEquals("jpeg",pict.suggestFileExtension());
assertTrue(Arrays.equals(pictureData,pict.getData()));
} catch (InvalidFormatException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
public void testPictureInHeader() {
public void testPictureInHeader() throws IOException
{
XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("headerPic.docx");
XWPFHeaderFooterPolicy policy = sampleDoc.getHeaderFooterPolicy();
@ -69,36 +66,40 @@ public class TestXWPFPictureData extends TestCase {
assertEquals(1,pictures.size());
}
public void testNew() throws Exception {
public void testNew() throws InvalidFormatException, IOException
{
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("EmptyDocumentWithHeaderFooter.docx");
byte[] jpegData = "test jpeg data".getBytes();
byte[] wmfData = "test wmf data".getBytes();
byte[] pngData = "test png data".getBytes();
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())) {
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);
String relationId = doc.addPictureData(jpegData,XWPFDocument.PICTURE_TYPE_JPEG);
assertEquals(1,pictures.size());
assertEquals("jpeg", pictures.get(jpegIdx).suggestFileExtension());
assertTrue(Arrays.equals(jpegData, pictures.get(jpegIdx).getData()));
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())) {
for (PackageRelationship rel : doc.getPackagePart().getRelationships())
{
if (rel.getRelationshipType().equals(XWPFRelation.IMAGE_JPEG.getRelation()))
{
if (jpegRel != null)
fail("Found 2 jpegs!");
jpegRel = rel;
@ -114,7 +115,8 @@ public class TestXWPFPictureData extends TestCase {
XWPFPictureData pictureDataByID = doc.getPictureDataByID(jpegRel.getId());
byte[] newJPEGData = pictureDataByID.getData();
assertEquals(newJPEGData.length,jpegData.length);
for(int i = 0; i < newJPEGData.length; i++){
for (int i = 0 ; i < newJPEGData.length ; i++)
{
assertEquals(newJPEGData[i],jpegData[i]);
}
@ -123,4 +125,8 @@ public class TestXWPFPictureData extends TestCase {
assertEquals(1,doc.getAllPictures().size());
assertEquals(1,doc.getAllPackagePictures().size());
}
public void testGetChecksum() {
}
}

6
src/ooxml/testcases/org/apache/poi/xwpf/usermodel/TestXWPFRun.java
View File

@ -17,6 +17,7 @@
package org.apache.poi.xwpf.usermodel;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.math.BigInteger;
import java.util.List;
@ -198,8 +199,9 @@ public class TestXWPFRun extends TestCase {
/**
* 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;
@ -330,7 +332,7 @@ public class TestXWPFRun extends TestCase {
assertEquals(null, run.getCTR().getRPr());
}
public void testPictureInHeader() {
public void testPictureInHeader() throws IOException {
XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("headerPic.docx");
XWPFHeaderFooterPolicy policy = sampleDoc.getHeaderFooterPolicy();

3
src/ooxml/testcases/org/apache/poi/xwpf/usermodel/TestXWPFStyles.java
View File

@ -17,6 +17,7 @@
package org.apache.poi.xwpf.usermodel;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
@ -30,7 +31,7 @@ public class TestXWPFStyles extends TestCase {
// 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();

BIN
test-data/document/abstract1.jpg Executable file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 81 KiB

BIN
test-data/document/abstract2.jpg Executable file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 167 KiB

BIN
test-data/document/abstract3.jpg Executable file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 135 KiB

BIN
test-data/document/abstract4.jpg Executable file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 60 KiB

BIN
test-data/document/issue_51265_1.docx Executable file
View File

Binary file not shown.

BIN
test-data/document/issue_51265_2.docx Executable file
View File

Binary file not shown.

BIN
test-data/document/issue_51265_3.docx Executable file
View File

Binary file not shown.

BIN
test-data/document/nature1.gif Executable file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 399 KiB

BIN
test-data/document/nature1.jpg Executable file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 118 KiB

BIN
test-data/document/nature1.png Executable file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.1 MiB

BIN
test-data/document/nature2.jpg Executable file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 59 KiB

BIN
test-data/document/nature3.jpg Executable file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 99 KiB

BIN
test-data/document/nature4.jpg Executable file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 62 KiB