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> <changes>
<release version="3.8-beta4" date="2011-??-??"> <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> <action dev="poi-developers" type="add">51292 - Additional HWPF Table Cell Descriptor values</action>
</release> </release>
<release version="3.8-beta3" date="2011-??-??"> <release version="3.8-beta3" date="2011-06-06">
<action dev="poi-developers" type="fix">51098 - Correct calculate image width/height, if image fits into one cell</action> <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="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">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> <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.io.OutputStream;
import java.nio.ByteBuffer; import java.nio.ByteBuffer;
import java.nio.channels.ReadableByteChannel; import java.nio.channels.ReadableByteChannel;
import java.util.zip.CRC32;
import java.util.zip.Checksum;
public final class IOUtils { public final class IOUtils {
private 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();
}
} }

45
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.exceptions.OpenXML4JException;
import org.apache.poi.openxml4j.opc.OPCPackage; import org.apache.poi.openxml4j.opc.OPCPackage;
import org.apache.poi.openxml4j.opc.PackagePart; 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.PackageRelationship;
import org.apache.poi.openxml4j.opc.PackageRelationshipCollection; 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.poifs.common.POIFSConstants;
import org.apache.poi.util.IOUtils; import org.apache.poi.util.IOUtils;
@ -80,33 +78,6 @@ public abstract class POIXMLDocument extends POIXMLDocumentPart{
return getPackagePart(); 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 * Retrieves all the PackageParts which are defined as
* relationships of the base document with the * relationships of the base document with the
@ -125,8 +96,6 @@ public abstract class POIXMLDocument extends POIXMLDocumentPart{
return parts; return parts;
} }
/** /**
* Checks that the supplied InputStream (which MUST * Checks that the supplied InputStream (which MUST
* support mark and reset, or be a PushbackInputStream) * support mark and reset, or be a PushbackInputStream)
@ -153,10 +122,10 @@ public abstract class POIXMLDocument extends POIXMLDocumentPart{
// Did it match the ooxml zip signature? // Did it match the ooxml zip signature?
return ( return (
header[0] == POIFSConstants.OOXML_FILE_HEADER[0] && header[0] == POIFSConstants.OOXML_FILE_HEADER[0] &&
header[1] == POIFSConstants.OOXML_FILE_HEADER[1] && header[1] == POIFSConstants.OOXML_FILE_HEADER[1] &&
header[2] == POIFSConstants.OOXML_FILE_HEADER[2] && header[2] == POIFSConstants.OOXML_FILE_HEADER[2] &&
header[3] == POIFSConstants.OOXML_FILE_HEADER[3] header[3] == POIFSConstants.OOXML_FILE_HEADER[3]
); );
} }
@ -181,14 +150,14 @@ public abstract class POIXMLDocument extends POIXMLDocumentPart{
public abstract List<PackagePart> getAllEmbedds() throws OpenXML4JException; public abstract List<PackagePart> getAllEmbedds() throws OpenXML4JException;
protected final void load(POIXMLFactory factory) throws IOException { protected final void load(POIXMLFactory factory) throws IOException {
Map<PackagePart, POIXMLDocumentPart> context = new HashMap<PackagePart, POIXMLDocumentPart>(); Map<PackagePart, POIXMLDocumentPart> context = new HashMap<PackagePart, POIXMLDocumentPart>();
try { try {
read(factory, context); read(factory, context);
} catch (OpenXML4JException e){ } catch (OpenXML4JException e){
throw new POIXMLException(e); throw new POIXMLException(e);
} }
onDocumentRead(); onDocumentRead();
context.clear(); context.clear();
} }
/** /**

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

@ -17,15 +17,23 @@
package org.apache.poi; package org.apache.poi;
import java.io.IOException; import java.io.IOException;
import java.util.*;
import java.net.URI; 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.InvalidFormatException;
import org.apache.poi.openxml4j.exceptions.OpenXML4JException; 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. * Represents an entry of a OOXML package.
@ -47,19 +55,55 @@ public class POIXMLDocumentPart {
DEFAULT_XML_OPTIONS.setSaveAggressiveNamespaces(); DEFAULT_XML_OPTIONS.setSaveAggressiveNamespaces();
} }
private PackagePart packagePart; private PackagePart packagePart;
private PackageRelationship packageRel; private PackageRelationship packageRel;
private POIXMLDocumentPart parent; 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. * Construct POIXMLDocumentPart representing a "core document" package part.
*/ */
public POIXMLDocumentPart(OPCPackage pkg) { public POIXMLDocumentPart(OPCPackage pkg) {
PackageRelationship coreRel = pkg.getRelationshipsByType( PackageRelationship coreRel = pkg.getRelationshipsByType(PackageRelationshipTypes.CORE_DOCUMENT).getRelationship(0);
PackageRelationshipTypes.CORE_DOCUMENT).getRelationship(0);
this.relations = new LinkedList<POIXMLDocumentPart>();
this.packagePart = pkg.getPart(coreRel); this.packagePart = pkg.getPart(coreRel);
this.packageRel = coreRel; this.packageRel = coreRel;
} }
@ -70,7 +114,6 @@ public class POIXMLDocumentPart {
* @see #createRelationship(POIXMLRelation, POIXMLFactory, int, boolean) * @see #createRelationship(POIXMLRelation, POIXMLFactory, int, boolean)
*/ */
public POIXMLDocumentPart(){ public POIXMLDocumentPart(){
this.relations = new LinkedList<POIXMLDocumentPart>();
} }
/** /**
@ -82,7 +125,6 @@ public class POIXMLDocumentPart {
* @see #read(POIXMLFactory, java.util.Map) * @see #read(POIXMLFactory, java.util.Map)
*/ */
public POIXMLDocumentPart(PackagePart part, PackageRelationship rel){ public POIXMLDocumentPart(PackagePart part, PackageRelationship rel){
this.relations = new LinkedList<POIXMLDocumentPart>();
this.packagePart = part; this.packagePart = part;
this.packageRel = rel; this.packageRel = rel;
} }
@ -97,7 +139,6 @@ public class POIXMLDocumentPart {
* @see #read(POIXMLFactory, java.util.Map) * @see #read(POIXMLFactory, java.util.Map)
*/ */
public POIXMLDocumentPart(POIXMLDocumentPart parent, PackagePart part, PackageRelationship rel){ public POIXMLDocumentPart(POIXMLDocumentPart parent, PackagePart part, PackageRelationship rel){
this.relations = new LinkedList<POIXMLDocumentPart>();
this.packagePart = part; this.packagePart = part;
this.packageRel = rel; this.packageRel = rel;
this.parent = parent; this.parent = parent;
@ -109,16 +150,16 @@ public class POIXMLDocumentPart {
* current core document * current core document
*/ */
protected final void rebase(OPCPackage pkg) throws InvalidFormatException { protected final void rebase(OPCPackage pkg) throws InvalidFormatException {
PackageRelationshipCollection cores = PackageRelationshipCollection cores =
packagePart.getRelationshipsByType(PackageRelationshipTypes.CORE_DOCUMENT); packagePart.getRelationshipsByType(PackageRelationshipTypes.CORE_DOCUMENT);
if(cores.size() != 1) { if(cores.size() != 1) {
throw new IllegalStateException( throw new IllegalStateException(
"Tried to rebase using " + PackageRelationshipTypes.CORE_DOCUMENT + "Tried to rebase using " + PackageRelationshipTypes.CORE_DOCUMENT +
" but found " + cores.size() + " parts of the right type" " but found " + cores.size() + " parts of the right type"
); );
} }
packageRel = cores.getRelationship(0); packageRel = cores.getRelationship(0);
packagePart = POIXMLDocument.getTargetPart(pkg, packageRel); packagePart = POIXMLDocument.getTargetPart(pkg, packageRel);
} }
/** /**
@ -145,7 +186,46 @@ public class POIXMLDocumentPart {
* @return child relations * @return child relations
*/ */
public final List<POIXMLDocumentPart> getRelations(){ 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 * @param part the child to add
*/ */
protected final void addRelation(POIXMLDocumentPart part){ protected final void addRelation(String id,POIXMLDocumentPart part){
relations.add(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){ protected final void removeRelation(POIXMLDocumentPart part){
getPackagePart().removeRelationship(part.getPackageRelationship().getId()); removeRelation(part,true);
getPackagePart().getPackage().removePart(part.getPackagePart()); }
relations.remove(part);
/**
* Remove the relation to the specified part in this package and remove the
* part, if it is no longer needed and flag is set to true.
*
* @param part
* The related part, to which the relation shall be removed.
* @param removeUnusedParts
* true, if the part shall be removed from the package if not
* needed any longer.
*/
protected final boolean removeRelation(POIXMLDocumentPart part, boolean removeUnusedParts){
String id = getRelationId(part);
if (id == null) {
// part is not related with this POIXMLDocumentPart
return false;
}
/* decrement usage counter */
part.decrementRelationCounter();
/* remove packagepart relationship */
getPackagePart().removeRelationship(id);
/* remove POIXMLDocument from relations */
relations.remove(id);
if (removeUnusedParts) {
/* if last relation to target part was removed, delete according target part */
if (part.getRelationCounter() == 0) {
try {
part.onDocumentRemove();
} catch (IOException e) {
throw new POIXMLException(e);
}
getPackagePart().getPackage().removePart(part.getPackagePart());
}
}
return true;
} }
/** /**
@ -209,13 +326,13 @@ public class POIXMLDocumentPart {
* @param alreadySaved context set containing already visited nodes * @param alreadySaved context set containing already visited nodes
*/ */
protected final void onSave(Set<PackagePart> alreadySaved) throws IOException{ protected final void onSave(Set<PackagePart> alreadySaved) throws IOException{
commit(); commit();
alreadySaved.add(this.getPackagePart()); alreadySaved.add(this.getPackagePart());
for(POIXMLDocumentPart p : relations){ for(POIXMLDocumentPart p : relations.values()){
if (!alreadySaved.contains(p.getPackagePart())) { if (!alreadySaved.contains(p.getPackagePart())) {
p.onSave(alreadySaved); p.onSave(alreadySaved);
} }
} }
} }
/** /**
@ -246,15 +363,19 @@ public class POIXMLDocumentPart {
try { try {
PackagePartName ppName = PackagingURIHelper.createPartName(descriptor.getFileName(idx)); PackagePartName ppName = PackagingURIHelper.createPartName(descriptor.getFileName(idx));
PackageRelationship rel = null; PackageRelationship rel = null;
if(!noRelation) {
rel = packagePart.addRelationship(ppName, TargetMode.INTERNAL, descriptor.getRelation());
}
PackagePart part = packagePart.getPackage().createPart(ppName, descriptor.getContentType()); 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());
}
POIXMLDocumentPart doc = factory.newDocumentPart(descriptor); POIXMLDocumentPart doc = factory.newDocumentPart(descriptor);
doc.packageRel = rel; doc.packageRel = rel;
doc.packagePart = part; doc.packagePart = part;
doc.parent = this; doc.parent = this;
addRelation(doc); if(!noRelation) {
/* only add to relations, if according relationship is being created. */
addRelation(rel.getId(),doc);
}
return doc; return doc;
} catch (Exception e){ } catch (Exception e){
throw new POIXMLException(e); throw new POIXMLException(e);
@ -269,40 +390,40 @@ public class POIXMLDocumentPart {
* @param context context map containing already visited noted keyed by targetURI * @param context context map containing already visited noted keyed by targetURI
*/ */
protected void read(POIXMLFactory factory, Map<PackagePart, POIXMLDocumentPart> context) throws OpenXML4JException { protected void read(POIXMLFactory factory, Map<PackagePart, POIXMLDocumentPart> context) throws OpenXML4JException {
PackageRelationshipCollection rels = packagePart.getRelationships(); PackageRelationshipCollection rels = packagePart.getRelationships();
for (PackageRelationship rel : rels) { for (PackageRelationship rel : rels) {
if(rel.getTargetMode() == TargetMode.INTERNAL){ if(rel.getTargetMode() == TargetMode.INTERNAL){
URI uri = rel.getTargetURI(); URI uri = rel.getTargetURI();
PackagePart p; PackagePart p;
if(uri.getRawFragment() != null) { if(uri.getRawFragment() != null) {
/* /*
* For internal references (e.g. '#Sheet1!A1') the package part is null * For internal references (e.g. '#Sheet1!A1') the package part is null
*/ */
p = null; p = null;
} else { } else {
PackagePartName relName = PackagingURIHelper.createPartName(uri); PackagePartName relName = PackagingURIHelper.createPartName(uri);
p = packagePart.getPackage().getPart(relName); p = packagePart.getPackage().getPart(relName);
if(p == null) { if(p == null) {
logger.log(POILogger.ERROR, "Skipped invalid entry " + rel.getTargetURI()); logger.log(POILogger.ERROR, "Skipped invalid entry " + rel.getTargetURI());
continue; continue;
} }
} }
if (!context.containsKey(p)) { if (!context.containsKey(p)) {
POIXMLDocumentPart childPart = factory.createDocumentPart(this, rel, p); POIXMLDocumentPart childPart = factory.createDocumentPart(this, rel, p);
childPart.parent = this; childPart.parent = this;
addRelation(childPart); addRelation(rel.getId(),childPart);
if(p != null){ if(p != null){
context.put(p, childPart); context.put(p, childPart);
if(p.hasRelationships()) childPart.read(factory, context); if(p.hasRelationships()) childPart.read(factory, context);
} }
} }
else { else {
addRelation(context.get(p)); addRelation(rel.getId(),context.get(p));
} }
} }
} }
} }
/** /**
@ -315,7 +436,25 @@ public class POIXMLDocumentPart {
/** /**
* Fired when a package part is read * Fired when a package part is read
*/ */
protected void onDocumentRead() throws IOException{ protected void onDocumentRead() throws IOException {
}
/**
* Get the PackagePart that is the target of a relationship.
*
* @param rel The relationship
* @return The target part
* @throws InvalidFormatException
*/
protected PackagePart getTargetPart(PackageRelationship rel) throws InvalidFormatException {
return getTargetPart(getPackagePart().getPackage(), rel);
}
/**
* Fired when a package part is about to be removed from the package
*/
protected void onDocumentRemove() throws IOException {
} }
} }

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.ArrayList;
import java.util.Date; import java.util.Date;
import java.util.Hashtable; import java.util.Hashtable;
import java.util.List;
import java.util.concurrent.locks.ReentrantReadWriteLock; 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.InvalidFormatException;
import org.apache.poi.openxml4j.exceptions.InvalidOperationException; import org.apache.poi.openxml4j.exceptions.InvalidOperationException;
@ -553,6 +556,25 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
return retArr; 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. * 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.ParsePosition;
import java.text.SimpleDateFormat; import java.text.SimpleDateFormat;
import java.util.Date; import java.util.Date;
import java.util.Locale;
import java.util.TimeZone; import java.util.TimeZone;
import org.apache.poi.openxml4j.exceptions.InvalidFormatException; 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); XSSFPictureData data = wb.getAllPictures().get(pictureIndex);
PackagePartName ppName = data.getPackagePart().getPartName(); PackagePartName ppName = data.getPackagePart().getPartName();
PackageRelationship rel = getPackagePart().addRelationship(ppName, TargetMode.INTERNAL, XSSFRelation.IMAGES.getRelation()); 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; return rel;
} }

681
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 java.util.Map;
import org.apache.poi.POIXMLDocumentPart; 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.XWPFDocument;
import org.apache.poi.xwpf.usermodel.XWPFFactory; import org.apache.poi.xwpf.usermodel.XWPFFactory;
import org.apache.poi.xwpf.usermodel.XWPFFooter; import org.apache.poi.xwpf.usermodel.XWPFFooter;
@ -68,244 +67,234 @@ import schemasMicrosoftComVml.STTrueFalse;
* the right headers and footers for the document. * the right headers and footers for the document.
*/ */
public class XWPFHeaderFooterPolicy { public class XWPFHeaderFooterPolicy {
public static final Enum DEFAULT = STHdrFtr.DEFAULT; public static final Enum DEFAULT = STHdrFtr.DEFAULT;
public static final Enum EVEN = STHdrFtr.EVEN; public static final Enum EVEN = STHdrFtr.EVEN;
public static final Enum FIRST = STHdrFtr.FIRST; public static final Enum FIRST = STHdrFtr.FIRST;
private XWPFDocument doc; private XWPFDocument doc;
private XWPFHeader firstPageHeader; private XWPFHeader firstPageHeader;
private XWPFFooter firstPageFooter; private XWPFFooter firstPageFooter;
private XWPFHeader evenPageHeader; private XWPFHeader evenPageHeader;
private XWPFFooter evenPageFooter; private XWPFFooter evenPageFooter;
private XWPFHeader defaultHeader; private XWPFHeader defaultHeader;
private XWPFFooter defaultFooter; private XWPFFooter defaultFooter;
/** /**
* Figures out the policy for the given document, * Figures out the policy for the given document,
* and creates any header and footer objects * and creates any header and footer objects
* as required. * as required.
*/ */
public XWPFHeaderFooterPolicy(XWPFDocument doc) throws IOException, XmlException { public XWPFHeaderFooterPolicy(XWPFDocument doc) throws IOException, XmlException {
this(doc, doc.getDocument().getBody().getSectPr()); this(doc, doc.getDocument().getBody().getSectPr());
} }
/**
* Figures out the policy for the given document,
* and creates any header and footer objects
* as required.
*/
public XWPFHeaderFooterPolicy(XWPFDocument doc, CTSectPr sectPr) throws IOException, XmlException {
// Grab what headers and footers have been defined
// For now, we don't care about different ranges, as it
// doesn't seem that .docx properly supports that
// feature of the file format yet
this.doc = doc;
for(int i=0; i<sectPr.sizeOfHeaderReferenceArray(); i++) {
// Get the header
CTHdrFtrRef ref = sectPr.getHeaderReferenceArray(i);
PackagePart hdrPart = doc.getPartById(ref.getId());
/**
* Figures out the policy for the given document,
* and creates any header and footer objects
* as required.
*/
public XWPFHeaderFooterPolicy(XWPFDocument doc, CTSectPr sectPr) throws IOException, XmlException {
// Grab what headers and footers have been defined
// For now, we don't care about different ranges, as it
// doesn't seem that .docx properly supports that
// feature of the file format yet
this.doc = doc;
for(int i=0; i<sectPr.sizeOfHeaderReferenceArray(); i++) {
// Get the header
CTHdrFtrRef ref = sectPr.getHeaderReferenceArray(i);
POIXMLDocumentPart relatedPart = doc.getRelationById(ref.getId());
XWPFHeader hdr = null; XWPFHeader hdr = null;
if (relatedPart != null && relatedPart instanceof XWPFHeader) {
for (POIXMLDocumentPart part : doc.getRelations()) { hdr = (XWPFHeader) relatedPart;
if (part.getPackagePart().getPartName().equals(hdrPart.getPartName())) {
hdr = (XWPFHeader) part;
}
} }
// Assign it
Enum type = ref.getType();
assignHeader(hdr, type);
}
for(int i=0; i<sectPr.sizeOfFooterReferenceArray(); i++) {
// Get the footer
CTHdrFtrRef ref = sectPr.getFooterReferenceArray(i);
POIXMLDocumentPart relatedPart = doc.getRelationById(ref.getId());
XWPFFooter ftr = null;
if (relatedPart != null && relatedPart instanceof XWPFFooter)
{
ftr = (XWPFFooter) relatedPart;
}
// Assign it
Enum type = ref.getType();
assignFooter(ftr, type);
}
}
// Assign it private void assignFooter(XWPFFooter ftr, Enum type) {
Enum type = ref.getType(); if(type == STHdrFtr.FIRST) {
assignHeader(hdr, type); firstPageFooter = ftr;
} } else if(type == STHdrFtr.EVEN) {
for(int i=0; i<sectPr.sizeOfFooterReferenceArray(); i++) { evenPageFooter = ftr;
// Get the footer } else {
CTHdrFtrRef ref = sectPr.getFooterReferenceArray(i); defaultFooter = ftr;
PackagePart ftrPart = doc.getPartById(ref.getId()); }
XWPFFooter ftr = new XWPFFooter(doc, }
FtrDocument.Factory.parse(ftrPart.getInputStream()).getFtr());
// Assign it private void assignHeader(XWPFHeader hdr, Enum type) {
Enum type = ref.getType(); if(type == STHdrFtr.FIRST) {
assignFooter(ftr, type); firstPageHeader = hdr;
} } else if(type == STHdrFtr.EVEN) {
} evenPageHeader = hdr;
} else {
defaultHeader = hdr;
private void assignFooter(XWPFFooter ftr, Enum type) { }
if(type == STHdrFtr.FIRST) { }
firstPageFooter = ftr;
} else if(type == STHdrFtr.EVEN) {
evenPageFooter = ftr;
} else {
defaultFooter = ftr;
}
}
private void assignHeader(XWPFHeader hdr, Enum type) {
if(type == STHdrFtr.FIRST) {
firstPageHeader = hdr;
} else if(type == STHdrFtr.EVEN) {
evenPageHeader = hdr;
} else {
defaultHeader = hdr;
}
}
public XWPFHeader createHeader(Enum type) throws IOException { public XWPFHeader createHeader(Enum type) throws IOException {
return createHeader(type, null); return createHeader(type, null);
} }
public XWPFHeader createHeader(Enum type, XWPFParagraph[] pars) throws IOException { public XWPFHeader createHeader(Enum type, XWPFParagraph[] pars) throws IOException {
XWPFRelation relation = XWPFRelation.HEADER; XWPFRelation relation = XWPFRelation.HEADER;
String pStyle = "Header"; String pStyle = "Header";
int i = getRelationIndex(relation); int i = getRelationIndex(relation);
HdrDocument hdrDoc = HdrDocument.Factory.newInstance(); HdrDocument hdrDoc = HdrDocument.Factory.newInstance();
XWPFHeader wrapper = (XWPFHeader)doc.createRelationship(relation, XWPFFactory.getInstance(), i); XWPFHeader wrapper = (XWPFHeader)doc.createRelationship(relation, XWPFFactory.getInstance(), i);
CTHdrFtr hdr = buildHdr(type, pStyle, wrapper, pars); CTHdrFtr hdr = buildHdr(type, pStyle, wrapper, pars);
wrapper.setHeaderFooter(hdr); wrapper.setHeaderFooter(hdr);
OutputStream outputStream = wrapper.getPackagePart().getOutputStream(); OutputStream outputStream = wrapper.getPackagePart().getOutputStream();
hdrDoc.setHdr(hdr); hdrDoc.setHdr(hdr);
XmlOptions xmlOptions = commit(wrapper); XmlOptions xmlOptions = commit(wrapper);
assignHeader(wrapper, type); assignHeader(wrapper, type);
hdrDoc.save(outputStream, xmlOptions); hdrDoc.save(outputStream, xmlOptions);
outputStream.close(); outputStream.close();
return wrapper; return wrapper;
} }
public XWPFFooter createFooter(Enum type) throws IOException { public XWPFFooter createFooter(Enum type) throws IOException {
return createFooter(type, null); return createFooter(type, null);
} }
public XWPFFooter createFooter(Enum type, XWPFParagraph[] pars) throws IOException { public XWPFFooter createFooter(Enum type, XWPFParagraph[] pars) throws IOException {
XWPFRelation relation = XWPFRelation.FOOTER; XWPFRelation relation = XWPFRelation.FOOTER;
String pStyle = "Footer"; String pStyle = "Footer";
int i = getRelationIndex(relation); int i = getRelationIndex(relation);
FtrDocument ftrDoc = FtrDocument.Factory.newInstance(); FtrDocument ftrDoc = FtrDocument.Factory.newInstance();
XWPFFooter wrapper = (XWPFFooter)doc.createRelationship(relation, XWPFFactory.getInstance(), i); XWPFFooter wrapper = (XWPFFooter)doc.createRelationship(relation, XWPFFactory.getInstance(), i);
CTHdrFtr ftr = buildFtr(type, pStyle, wrapper, pars); CTHdrFtr ftr = buildFtr(type, pStyle, wrapper, pars);
wrapper.setHeaderFooter(ftr); wrapper.setHeaderFooter(ftr);
OutputStream outputStream = wrapper.getPackagePart().getOutputStream(); OutputStream outputStream = wrapper.getPackagePart().getOutputStream();
ftrDoc.setFtr(ftr); ftrDoc.setFtr(ftr);
XmlOptions xmlOptions = commit(wrapper); XmlOptions xmlOptions = commit(wrapper);
assignFooter(wrapper, type); assignFooter(wrapper, type);
ftrDoc.save(outputStream, xmlOptions); ftrDoc.save(outputStream, xmlOptions);
outputStream.close(); outputStream.close();
return wrapper; return wrapper;
}
private int getRelationIndex(XWPFRelation relation) {
List<POIXMLDocumentPart> relations = doc.getRelations();
int i = 1;
for (Iterator<POIXMLDocumentPart> it = relations.iterator(); it.hasNext() ; ) {
POIXMLDocumentPart item = it.next();
if (item.getPackageRelationship().getRelationshipType().equals(relation.getRelation())) {
i++;
}
}
return i;
}
private CTHdrFtr buildFtr(Enum type, String pStyle, XWPFHeaderFooter wrapper, XWPFParagraph[] pars) {
//CTHdrFtr ftr = buildHdrFtr(pStyle, pars); // MB 24 May 2010
CTHdrFtr ftr = buildHdrFtr(pStyle, pars, wrapper); // MB 24 May 2010
setFooterReference(type, wrapper);
return ftr;
}
private CTHdrFtr buildHdr(Enum type, String pStyle, XWPFHeaderFooter wrapper, XWPFParagraph[] pars) {
//CTHdrFtr hdr = buildHdrFtr(pStyle, pars); // MB 24 May 2010
CTHdrFtr hdr = buildHdrFtr(pStyle, pars, wrapper); // MB 24 May 2010
setHeaderReference(type, wrapper);
return hdr;
}
private CTHdrFtr buildHdrFtr(String pStyle, XWPFParagraph[] paragraphs) {
CTHdrFtr ftr = CTHdrFtr.Factory.newInstance();
if (paragraphs != null) {
for (int i = 0 ; i < paragraphs.length ; i++) {
CTP p = ftr.addNewP();
//ftr.setPArray(0, paragraphs[i].getCTP()); // MB 23 May 2010
ftr.setPArray(i, paragraphs[i].getCTP()); // MB 23 May 2010
}
}
else {
CTP p = ftr.addNewP();
byte[] rsidr = doc.getDocument().getBody().getPArray(0).getRsidR();
byte[] rsidrdefault = doc.getDocument().getBody().getPArray(0).getRsidRDefault();
p.setRsidP(rsidr);
p.setRsidRDefault(rsidrdefault);
CTPPr pPr = p.addNewPPr();
pPr.addNewPStyle().setVal(pStyle);
}
return ftr;
}
/**
* MB 24 May 2010. Created this overloaded buildHdrFtr() method because testing demonstrated
* that the XWPFFooter or XWPFHeader object returned by calls to the createHeader(int, XWPFParagraph[])
* and createFooter(int, XWPFParagraph[]) methods or the getXXXXXHeader/Footer methods where
* headers or footers had been added to a document since it had been created/opened, returned
* an object that contained no XWPFParagraph objects even if the header/footer itself did contain
* text. The reason was that this line of code; CTHdrFtr ftr = CTHdrFtr.Factory.newInstance();
* created a brand new instance of the CTHDRFtr class which was then populated with data when
* it should have recovered the CTHdrFtr object encapsulated within the XWPFHeaderFooter object
* that had previoulsy been instantiated in the createHeader(int, XWPFParagraph[]) or
* createFooter(int, XWPFParagraph[]) methods.
*/
private CTHdrFtr buildHdrFtr(String pStyle, XWPFParagraph[] paragraphs, XWPFHeaderFooter wrapper) {
CTHdrFtr ftr = wrapper._getHdrFtr();
if (paragraphs != null) {
for (int i = 0 ; i < paragraphs.length ; i++) {
CTP p = ftr.addNewP();
ftr.setPArray(i, paragraphs[i].getCTP());
}
}
else {
CTP p = ftr.addNewP();
byte[] rsidr = doc.getDocument().getBody().getPArray(0).getRsidR();
byte[] rsidrdefault = doc.getDocument().getBody().getPArray(0).getRsidRDefault();
p.setRsidP(rsidr);
p.setRsidRDefault(rsidrdefault);
CTPPr pPr = p.addNewPPr();
pPr.addNewPStyle().setVal(pStyle);
}
return ftr;
} }
private int getRelationIndex(XWPFRelation relation) { private void setFooterReference(Enum type, XWPFHeaderFooter wrapper) {
List<POIXMLDocumentPart> relations = doc.getRelations(); CTHdrFtrRef ref = doc.getDocument().getBody().getSectPr().addNewFooterReference();
int i = 1; ref.setType(type);
for (Iterator<POIXMLDocumentPart> it = relations.iterator(); it.hasNext() ; ) { ref.setId(wrapper.getPackageRelationship().getId());
POIXMLDocumentPart item = it.next(); }
if (item.getPackageRelationship().getRelationshipType().equals(relation.getRelation())) {
i++;
}
}
return i;
}
private CTHdrFtr buildFtr(Enum type, String pStyle, XWPFHeaderFooter wrapper, XWPFParagraph[] pars) { private void setHeaderReference(Enum type, XWPFHeaderFooter wrapper) {
//CTHdrFtr ftr = buildHdrFtr(pStyle, pars); // MB 24 May 2010 CTHdrFtrRef ref = doc.getDocument().getBody().getSectPr().addNewHeaderReference();
CTHdrFtr ftr = buildHdrFtr(pStyle, pars, wrapper); // MB 24 May 2010 ref.setType(type);
setFooterReference(type, wrapper); ref.setId(wrapper.getPackageRelationship().getId());
return ftr; }
}
private CTHdrFtr buildHdr(Enum type, String pStyle, XWPFHeaderFooter wrapper, XWPFParagraph[] pars) { private XmlOptions commit(XWPFHeaderFooter wrapper) {
//CTHdrFtr hdr = buildHdrFtr(pStyle, pars); // MB 24 May 2010 XmlOptions xmlOptions = new XmlOptions(wrapper.DEFAULT_XML_OPTIONS);
CTHdrFtr hdr = buildHdrFtr(pStyle, pars, wrapper); // MB 24 May 2010
setHeaderReference(type, wrapper);
return hdr;
}
private CTHdrFtr buildHdrFtr(String pStyle, XWPFParagraph[] paragraphs) {
CTHdrFtr ftr = CTHdrFtr.Factory.newInstance();
if (paragraphs != null) {
for (int i = 0 ; i < paragraphs.length ; i++) {
CTP p = ftr.addNewP();
//ftr.setPArray(0, paragraphs[i].getCTP()); // MB 23 May 2010
ftr.setPArray(i, paragraphs[i].getCTP()); // MB 23 May 2010
}
}
else {
CTP p = ftr.addNewP();
byte[] rsidr = doc.getDocument().getBody().getPArray(0).getRsidR();
byte[] rsidrdefault = doc.getDocument().getBody().getPArray(0).getRsidRDefault();
p.setRsidP(rsidr);
p.setRsidRDefault(rsidrdefault);
CTPPr pPr = p.addNewPPr();
pPr.addNewPStyle().setVal(pStyle);
}
return ftr;
}
/**
* MB 24 May 2010. Created this overloaded buildHdrFtr() method because testing demonstrated
* that the XWPFFooter or XWPFHeader object returned by calls to the createHeader(int, XWPFParagraph[])
* and createFooter(int, XWPFParagraph[]) methods or the getXXXXXHeader/Footer methods where
* headers or footers had been added to a document since it had been created/opened, returned
* an object that contained no XWPFParagraph objects even if the header/footer itself did contain
* text. The reason was that this line of code; CTHdrFtr ftr = CTHdrFtr.Factory.newInstance();
* created a brand new instance of the CTHDRFtr class which was then populated with data when
* it should have recovered the CTHdrFtr object encapsulated within the XWPFHeaderFooter object
* that had previoulsy been instantiated in the createHeader(int, XWPFParagraph[]) or
* createFooter(int, XWPFParagraph[]) methods.
*/
private CTHdrFtr buildHdrFtr(String pStyle, XWPFParagraph[] paragraphs, XWPFHeaderFooter wrapper) {
CTHdrFtr ftr = wrapper._getHdrFtr();
if (paragraphs != null) {
for (int i = 0 ; i < paragraphs.length ; i++) {
CTP p = ftr.addNewP();
ftr.setPArray(i, paragraphs[i].getCTP());
}
}
else {
CTP p = ftr.addNewP();
byte[] rsidr = doc.getDocument().getBody().getPArray(0).getRsidR();
byte[] rsidrdefault = doc.getDocument().getBody().getPArray(0).getRsidRDefault();
p.setRsidP(rsidr);
p.setRsidRDefault(rsidrdefault);
CTPPr pPr = p.addNewPPr();
pPr.addNewPStyle().setVal(pStyle);
}
return ftr;
}
private void setFooterReference(Enum type, XWPFHeaderFooter wrapper) {
CTHdrFtrRef ref = doc.getDocument().getBody().getSectPr().addNewFooterReference();
ref.setType(type);
ref.setId(wrapper.getPackageRelationship().getId());
}
private void setHeaderReference(Enum type, XWPFHeaderFooter wrapper) {
CTHdrFtrRef ref = doc.getDocument().getBody().getSectPr().addNewHeaderReference();
ref.setType(type);
ref.setId(wrapper.getPackageRelationship().getId());
}
private XmlOptions commit(XWPFHeaderFooter wrapper) {
XmlOptions xmlOptions = new XmlOptions(wrapper.DEFAULT_XML_OPTIONS);
Map<String, String> map = new HashMap<String, String>(); Map<String, String> map = new HashMap<String, String>();
map.put("http://schemas.openxmlformats.org/officeDocument/2006/math", "m"); map.put("http://schemas.openxmlformats.org/officeDocument/2006/math", "m");
map.put("urn:schemas-microsoft-com:office:office", "o"); map.put("urn:schemas-microsoft-com:office:office", "o");
@ -317,154 +306,152 @@ public class XWPFHeaderFooterPolicy {
map.put("http://schemas.microsoft.com/office/word/2006/wordml", "wne"); map.put("http://schemas.microsoft.com/office/word/2006/wordml", "wne");
map.put("http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing", "wp"); map.put("http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing", "wp");
xmlOptions.setSaveSuggestedPrefixes(map); xmlOptions.setSaveSuggestedPrefixes(map);
return xmlOptions; return xmlOptions;
} }
public XWPFHeader getFirstPageHeader() { public XWPFHeader getFirstPageHeader() {
return firstPageHeader; return firstPageHeader;
} }
public XWPFFooter getFirstPageFooter() { public XWPFFooter getFirstPageFooter() {
return firstPageFooter; return firstPageFooter;
} }
/** /**
* Returns the odd page header. This is * Returns the odd page header. This is
* also the same as the default one... * also the same as the default one...
*/ */
public XWPFHeader getOddPageHeader() { public XWPFHeader getOddPageHeader() {
return defaultHeader; return defaultHeader;
} }
/** /**
* Returns the odd page footer. This is * Returns the odd page footer. This is
* also the same as the default one... * also the same as the default one...
*/ */
public XWPFFooter getOddPageFooter() { public XWPFFooter getOddPageFooter() {
return defaultFooter; return defaultFooter;
} }
public XWPFHeader getEvenPageHeader() { public XWPFHeader getEvenPageHeader() {
return evenPageHeader; return evenPageHeader;
} }
public XWPFFooter getEvenPageFooter() { public XWPFFooter getEvenPageFooter() {
return evenPageFooter; return evenPageFooter;
} }
public XWPFHeader getDefaultHeader() { public XWPFHeader getDefaultHeader() {
return defaultHeader; return defaultHeader;
} }
public XWPFFooter getDefaultFooter() { public XWPFFooter getDefaultFooter() {
return defaultFooter; return defaultFooter;
} }
/** /**
* Get the header that applies to the given * Get the header that applies to the given
* (1 based) page. * (1 based) page.
* @param pageNumber The one based page number * @param pageNumber The one based page number
*/ */
public XWPFHeader getHeader(int pageNumber) { public XWPFHeader getHeader(int pageNumber) {
if(pageNumber == 1 && firstPageHeader != null) { if(pageNumber == 1 && firstPageHeader != null) {
return firstPageHeader; return firstPageHeader;
} }
if(pageNumber % 2 == 0 && evenPageHeader != null) { if(pageNumber % 2 == 0 && evenPageHeader != null) {
return evenPageHeader; return evenPageHeader;
} }
return defaultHeader; return defaultHeader;
} }
/** /**
* Get the footer that applies to the given * Get the footer that applies to the given
* (1 based) page. * (1 based) page.
* @param pageNumber The one based page number * @param pageNumber The one based page number
*/ */
public XWPFFooter getFooter(int pageNumber) { public XWPFFooter getFooter(int pageNumber) {
if(pageNumber == 1 && firstPageFooter != null) { if(pageNumber == 1 && firstPageFooter != null) {
return firstPageFooter; return firstPageFooter;
} }
if(pageNumber % 2 == 0 && evenPageFooter != null) { if(pageNumber % 2 == 0 && evenPageFooter != null) {
return evenPageFooter; return evenPageFooter;
} }
return defaultFooter; return defaultFooter;
} }
public void createWatermark(String text) {
XWPFParagraph[] pars = new XWPFParagraph[1];
try {
pars[0] = getWatermarkParagraph(text, 1);
createHeader(DEFAULT, pars);
pars[0] = getWatermarkParagraph(text, 2);
createHeader(FIRST, pars);
pars[0] = getWatermarkParagraph(text, 3);
createHeader(EVEN, pars);
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
public void createWatermark(String text) { /*
XWPFParagraph[] pars = new XWPFParagraph[1]; * This is the default Watermark paragraph; the only variable is the text message
try { * TODO: manage all the other variables
pars[0] = getWatermarkParagraph(text, 1); */
createHeader(DEFAULT, pars); private XWPFParagraph getWatermarkParagraph(String text, int idx) {
pars[0] = getWatermarkParagraph(text, 2); CTP p = CTP.Factory.newInstance();
createHeader(FIRST, pars); byte[] rsidr = doc.getDocument().getBody().getPArray(0).getRsidR();
pars[0] = getWatermarkParagraph(text, 3); byte[] rsidrdefault = doc.getDocument().getBody().getPArray(0).getRsidRDefault();
createHeader(EVEN, pars); p.setRsidP(rsidr);
} catch (IOException e) { p.setRsidRDefault(rsidrdefault);
// TODO Auto-generated catch block CTPPr pPr = p.addNewPPr();
e.printStackTrace(); pPr.addNewPStyle().setVal("Header");
} // start watermark paragraph
} CTR r = p.addNewR();
CTRPr rPr = r.addNewRPr();
rPr.addNewNoProof();
/* CTPicture pict = r.addNewPict();
* This is the default Watermark paragraph; the only variable is the text message CTGroup group = CTGroup.Factory.newInstance();
* TODO: manage all the other variables CTShapetype shapetype = group.addNewShapetype();
*/ shapetype.setId("_x0000_t136");
private XWPFParagraph getWatermarkParagraph(String text, int idx) { shapetype.setCoordsize("1600,21600");
CTP p = CTP.Factory.newInstance(); shapetype.setSpt(136);
byte[] rsidr = doc.getDocument().getBody().getPArray(0).getRsidR(); shapetype.setAdj("10800");
byte[] rsidrdefault = doc.getDocument().getBody().getPArray(0).getRsidRDefault(); shapetype.setPath2("m@7,0l@8,0m@5,21600l@6,21600e");
p.setRsidP(rsidr); CTFormulas formulas = shapetype.addNewFormulas();
p.setRsidRDefault(rsidrdefault); formulas.addNewF().setEqn("sum #0 0 10800");
CTPPr pPr = p.addNewPPr(); formulas.addNewF().setEqn("prod #0 2 1");
pPr.addNewPStyle().setVal("Header"); formulas.addNewF().setEqn("sum 21600 0 @1");
// start watermark paragraph formulas.addNewF().setEqn("sum 0 0 @2");
CTR r = p.addNewR(); formulas.addNewF().setEqn("sum 21600 0 @3");
CTRPr rPr = r.addNewRPr(); formulas.addNewF().setEqn("if @0 @3 0");
rPr.addNewNoProof(); formulas.addNewF().setEqn("if @0 21600 @1");
CTPicture pict = r.addNewPict(); formulas.addNewF().setEqn("if @0 0 @2");
CTGroup group = CTGroup.Factory.newInstance(); formulas.addNewF().setEqn("if @0 @4 21600");
CTShapetype shapetype = group.addNewShapetype(); formulas.addNewF().setEqn("mid @5 @6");
shapetype.setId("_x0000_t136"); formulas.addNewF().setEqn("mid @8 @5");
shapetype.setCoordsize("1600,21600"); formulas.addNewF().setEqn("mid @7 @8");
shapetype.setSpt(136); formulas.addNewF().setEqn("mid @6 @7");
shapetype.setAdj("10800"); formulas.addNewF().setEqn("sum @6 0 @5");
shapetype.setPath2("m@7,0l@8,0m@5,21600l@6,21600e"); CTPath path = shapetype.addNewPath();
CTFormulas formulas = shapetype.addNewFormulas(); path.setTextpathok(STTrueFalse.T);
formulas.addNewF().setEqn("sum #0 0 10800"); path.setConnecttype(STConnectType.CUSTOM);
formulas.addNewF().setEqn("prod #0 2 1"); path.setConnectlocs("@9,0;@10,10800;@11,21600;@12,10800");
formulas.addNewF().setEqn("sum 21600 0 @1"); path.setConnectangles("270,180,90,0");
formulas.addNewF().setEqn("sum 0 0 @2"); CTTextPath shapeTypeTextPath = shapetype.addNewTextpath();
formulas.addNewF().setEqn("sum 21600 0 @3"); shapeTypeTextPath.setOn(STTrueFalse.T);
formulas.addNewF().setEqn("if @0 @3 0"); shapeTypeTextPath.setFitshape(STTrueFalse.T);
formulas.addNewF().setEqn("if @0 21600 @1"); CTHandles handles = shapetype.addNewHandles();
formulas.addNewF().setEqn("if @0 0 @2"); CTH h = handles.addNewH();
formulas.addNewF().setEqn("if @0 @4 21600"); h.setPosition("#0,bottomRight");
formulas.addNewF().setEqn("mid @5 @6"); h.setXrange("6629,14971");
formulas.addNewF().setEqn("mid @8 @5"); CTLock lock = shapetype.addNewLock();
formulas.addNewF().setEqn("mid @7 @8"); lock.setExt(STExt.EDIT);
formulas.addNewF().setEqn("mid @6 @7"); CTShape shape = group.addNewShape();
formulas.addNewF().setEqn("sum @6 0 @5"); shape.setId("PowerPlusWaterMarkObject" + idx);
CTPath path = shapetype.addNewPath(); shape.setSpid("_x0000_s102" + (4+idx));
path.setTextpathok(STTrueFalse.T); shape.setType("#_x0000_t136");
path.setConnecttype(STConnectType.CUSTOM); shape.setStyle("position:absolute;margin-left:0;margin-top:0;width:415pt;height:207.5pt;z-index:-251654144;mso-wrap-edited:f;mso-position-horizontal:center;mso-position-horizontal-relative:margin;mso-position-vertical:center;mso-position-vertical-relative:margin");
path.setConnectlocs("@9,0;@10,10800;@11,21600;@12,10800"); shape.setWrapcoords("616 5068 390 16297 39 16921 -39 17155 7265 17545 7186 17467 -39 17467 18904 17467 10507 17467 8710 17545 18904 17077 18787 16843 18358 16297 18279 12554 19178 12476 20701 11774 20779 11228 21131 10059 21248 8811 21248 7563 20975 6316 20935 5380 19490 5146 14022 5068 2616 5068");
path.setConnectangles("270,180,90,0"); shape.setFillcolor("black");
CTTextPath shapeTypeTextPath = shapetype.addNewTextpath(); shape.setStroked(STTrueFalse.FALSE);
shapeTypeTextPath.setOn(STTrueFalse.T); CTTextPath shapeTextPath = shape.addNewTextpath();
shapeTypeTextPath.setFitshape(STTrueFalse.T); shapeTextPath.setStyle("font-family:&quot;Cambria&quot;;font-size:1pt");
CTHandles handles = shapetype.addNewHandles(); shapeTextPath.setString(text);
CTH h = handles.addNewH(); pict.set(group);
h.setPosition("#0,bottomRight"); // end watermark paragraph
h.setXrange("6629,14971"); return new XWPFParagraph(p, doc);
CTLock lock = shapetype.addNewLock(); }
lock.setExt(STExt.EDIT);
CTShape shape = group.addNewShape();
shape.setId("PowerPlusWaterMarkObject" + idx);
shape.setSpid("_x0000_s102" + (4+idx));
shape.setType("#_x0000_t136");
shape.setStyle("position:absolute;margin-left:0;margin-top:0;width:415pt;height:207.5pt;z-index:-251654144;mso-wrap-edited:f;mso-position-horizontal:center;mso-position-horizontal-relative:margin;mso-position-vertical:center;mso-position-vertical-relative:margin");
shape.setWrapcoords("616 5068 390 16297 39 16921 -39 17155 7265 17545 7186 17467 -39 17467 18904 17467 10507 17467 8710 17545 18904 17077 18787 16843 18358 16297 18279 12554 19178 12476 20701 11774 20779 11228 21131 10059 21248 8811 21248 7563 20975 6316 20935 5380 19490 5146 14022 5068 2616 5068");
shape.setFillcolor("black");
shape.setStroked(STTrueFalse.FALSE);
CTTextPath shapeTextPath = shape.addNewTextpath();
shapeTextPath.setStyle("font-family:&quot;Cambria&quot;;font-size:1pt");
shapeTextPath.setString(text);
pict.set(group);
// end watermark paragraph
return new XWPFParagraph(p, doc);
}
} }

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 java.util.List;
import org.apache.poi.POIXMLDocumentPart;
import org.apache.xmlbeans.XmlCursor; import org.apache.xmlbeans.XmlCursor;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP; import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl; import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl;
@ -42,7 +43,7 @@ public interface IBody {
* belongs. * belongs.
* @return the Part, to which the body belongs * @return the Part, to which the body belongs
*/ */
IBody getPart(); POIXMLDocumentPart getPart();
/** /**
* get the PartType of the body, for example * 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; package org.apache.poi.xwpf.usermodel;
import org.apache.poi.POIXMLDocumentPart;
/** /**
* 9 Jan 2010 * 9 Jan 2010
@ -24,7 +25,8 @@ package org.apache.poi.xwpf.usermodel;
* *
*/ */
public interface IBodyElement{ public interface IBodyElement{
IBody getPart(); IBody getBody();
POIXMLDocumentPart getPart();
BodyType getPartType(); BodyType getPartType();
BodyElementType getElementType(); BodyElementType getElementType();
} }

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

@ -16,12 +16,12 @@
==================================================================== */ ==================================================================== */
package org.apache.poi.xwpf.usermodel; package org.apache.poi.xwpf.usermodel;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream; import java.io.ByteArrayOutputStream;
import java.io.IOException; import java.io.IOException;
import java.io.InputStream; import java.io.InputStream;
import java.io.OutputStream; import java.io.OutputStream;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection; import java.util.Collection;
import java.util.Collections; import java.util.Collections;
import java.util.HashMap; import java.util.HashMap;
@ -36,6 +36,7 @@ import org.apache.poi.POIXMLDocument;
import org.apache.poi.POIXMLDocumentPart; import org.apache.poi.POIXMLDocumentPart;
import org.apache.poi.POIXMLException; import org.apache.poi.POIXMLException;
import org.apache.poi.POIXMLProperties; import org.apache.poi.POIXMLProperties;
import org.apache.poi.POIXMLRelation;
import org.apache.poi.openxml4j.exceptions.InvalidFormatException; import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
import org.apache.poi.openxml4j.exceptions.OpenXML4JException; import org.apache.poi.openxml4j.exceptions.OpenXML4JException;
import org.apache.poi.openxml4j.opc.OPCPackage; 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.PackagingURIHelper;
import org.apache.poi.openxml4j.opc.TargetMode; import org.apache.poi.openxml4j.opc.TargetMode;
import org.apache.poi.util.IOUtils; import org.apache.poi.util.IOUtils;
import org.apache.poi.util.IdentifierManager;
import org.apache.poi.util.Internal; import org.apache.poi.util.Internal;
import org.apache.poi.util.PackageHelper; import org.apache.poi.util.PackageHelper;
import org.apache.poi.xwpf.model.XWPFHeaderFooterPolicy; import org.apache.poi.xwpf.model.XWPFHeaderFooterPolicy;
@ -85,16 +87,21 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
private CTDocument1 ctDocument; private CTDocument1 ctDocument;
private XWPFSettings settings; private XWPFSettings settings;
protected List<XWPFFooter> footers; /**
protected List <XWPFHeader> headers; * Keeps track on all id-values used in this document and included parts, like headers, footers, etc.
protected List<XWPFComment> comments; */
protected List<XWPFHyperlink> hyperlinks; private IdentifierManager drawingIdManager = new IdentifierManager(1L,4294967295L);
protected List<XWPFParagraph> paragraphs; protected List<XWPFFooter> footers = new ArrayList<XWPFFooter>();
protected List<XWPFTable> tables; protected List<XWPFHeader> headers = new ArrayList<XWPFHeader>();
protected List<IBodyElement> bodyElements; protected List<XWPFComment> comments = new ArrayList<XWPFComment>();
protected List<XWPFPictureData> pictures; protected List<XWPFHyperlink> hyperlinks = new ArrayList<XWPFHyperlink>();
protected Map<Integer, XWPFFootnote> footnotes; protected List<XWPFParagraph> paragraphs = new ArrayList<XWPFParagraph>();
protected Map<Integer, XWPFFootnote> endnotes; 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 XWPFNumbering numbering;
protected XWPFStyles styles; protected XWPFStyles styles;
@ -122,80 +129,78 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
@Override @Override
protected void onDocumentRead() throws IOException { 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 { try {
DocumentDocument doc = DocumentDocument.Factory.parse(getPackagePart().getInputStream()); DocumentDocument doc = DocumentDocument.Factory.parse(getPackagePart().getInputStream());
ctDocument = doc.getDocument(); ctDocument = doc.getDocument();
initFootnotes(); initFootnotes();
// parse the document with cursor and add // parse the document with cursor and add
// the XmlObject to its lists // the XmlObject to its lists
XmlCursor cursor = ctDocument.getBody().newCursor(); XmlCursor cursor = ctDocument.getBody().newCursor();
cursor.selectPath("./*"); cursor.selectPath("./*");
while (cursor.toNextSelection()) { while (cursor.toNextSelection()) {
XmlObject o = cursor.getObject(); XmlObject o = cursor.getObject();
if (o instanceof CTP) { if (o instanceof CTP) {
XWPFParagraph p = new XWPFParagraph((CTP)o, this); XWPFParagraph p = new XWPFParagraph((CTP) o, this);
bodyElements.add(p); bodyElements.add(p);
paragraphs.add(p); paragraphs.add(p);
} } else if (o instanceof CTTbl) {
if (o instanceof CTTbl) { XWPFTable t = new XWPFTable((CTTbl) o, this);
XWPFTable t = new XWPFTable((CTTbl)o, this); bodyElements.add(t);
bodyElements.add(t); tables.add(t);
tables.add(t);
} }
} }
cursor.dispose(); cursor.dispose();
// Sort out headers and footers // Sort out headers and footers
if (doc.getDocument().getBody().getSectPr() != null) if (doc.getDocument().getBody().getSectPr() != null)
headerFooterPolicy = new XWPFHeaderFooterPolicy(this); headerFooterPolicy = new XWPFHeaderFooterPolicy(this);
// Create for each XML-part in the Package a PartClass // Create for each XML-part in the Package a PartClass
for(POIXMLDocumentPart p : getRelations()){ for (POIXMLDocumentPart p : getRelations()) {
String relation = p.getPackageRelationship().getRelationshipType(); String relation = p.getPackageRelationship().getRelationshipType();
if(relation.equals(XWPFRelation.STYLES.getRelation())){ if (relation.equals(XWPFRelation.STYLES.getRelation())) {
this.styles = (XWPFStyles) p; this.styles = (XWPFStyles) p;
} else if (relation.equals(XWPFRelation.NUMBERING.getRelation())){ this.styles.onDocumentRead();
this.numbering = (XWPFNumbering) p; } else if (relation.equals(XWPFRelation.NUMBERING.getRelation())) {
} else if (relation.equals(XWPFRelation.FOOTER.getRelation())){ this.numbering = (XWPFNumbering) p;
footers.add((XWPFFooter)p); this.numbering.onDocumentRead();
} else if (relation.equals(XWPFRelation.HEADER.getRelation())){ } else if (relation.equals(XWPFRelation.FOOTER.getRelation())) {
headers.add((XWPFHeader)p); XWPFFooter footer = (XWPFFooter) p;
} else if (relation.equals(XWPFRelation.COMMENT.getRelation())){ footers.add(footer);
footer.onDocumentRead();
} else if (relation.equals(XWPFRelation.HEADER.getRelation())) {
XWPFHeader header = (XWPFHeader) p;
headers.add(header);
header.onDocumentRead();
} else if (relation.equals(XWPFRelation.COMMENT.getRelation())) {
// TODO Create according XWPFComment class, extending POIXMLDocumentPart
CommentsDocument cmntdoc = CommentsDocument.Factory.parse(p.getPackagePart().getInputStream()); CommentsDocument cmntdoc = CommentsDocument.Factory.parse(p.getPackagePart().getInputStream());
for(CTComment ctcomment : cmntdoc.getComments().getCommentList()) { for (CTComment ctcomment : cmntdoc.getComments().getCommentList()) {
comments.add(new XWPFComment(ctcomment, this)); comments.add(new XWPFComment(ctcomment, this));
} }
} else if (relation.equals(XWPFRelation.SETTINGS.getRelation())){ } else if (relation.equals(XWPFRelation.SETTINGS.getRelation())) {
settings = (XWPFSettings)p; settings = (XWPFSettings) p;
settings.onDocumentRead();
} else if (relation.equals(XWPFRelation.IMAGES.getRelation())) {
XWPFPictureData picData = (XWPFPictureData) p;
picData.onDocumentRead();
registerPackagePictureData(picData);
pictures.add(picData);
} }
} }
initHyperlinks(); initHyperlinks();
} catch (XmlException e) { } catch (XmlException e) {
throw new POIXMLException(e); throw new POIXMLException(e);
} }
// create for every Graphic-Part in Package a new XWPFGraphic
getAllPictures();
} }
private void initHyperlinks(){ private void initHyperlinks(){
// Get the hyperlinks // Get the hyperlinks
// TODO: make me optional/separated in private function // TODO: make me optional/separated in private function
try { try {
Iterator <PackageRelationship> relIter = Iterator<PackageRelationship> relIter =
getPackagePart().getRelationshipsByType(XWPFRelation.HYPERLINK.getRelation()).iterator(); getPackagePart().getRelationshipsByType(XWPFRelation.HYPERLINK.getRelation()).iterator();
while(relIter.hasNext()) { while(relIter.hasNext()) {
PackageRelationship rel = relIter.next(); PackageRelationship rel = relIter.next();
@ -251,20 +256,10 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
*/ */
@Override @Override
protected void onDocumentCreate() { 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 = CTDocument1.Factory.newInstance();
ctDocument.addNewBody(); ctDocument.addNewBody();
settings = (XWPFSettings) createRelationship(XWPFRelation.SETTINGS, XWPFFactory.getInstance()); settings = (XWPFSettings) createRelationship(XWPFRelation.SETTINGS,XWPFFactory.getInstance());
POIXMLProperties.ExtendedProperties expProps = getProperties().getExtendedProperties(); POIXMLProperties.ExtendedProperties expProps = getProperties().getExtendedProperties();
expProps.getUnderlyingProperties().setApplication(DOCUMENT_CREATOR); expProps.getUnderlyingProperties().setApplication(DOCUMENT_CREATOR);
@ -278,6 +273,10 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
return ctDocument; return ctDocument;
} }
IdentifierManager getDrawingIdManager() {
return drawingIdManager;
}
/** /**
* returns an Iterator with paragraphs and tables * returns an Iterator with paragraphs and tables
* @see org.apache.poi.xwpf.usermodel.IBody#getBodyElements() * @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) { public XWPFHyperlink getHyperlinkByID(String id) {
Iterator<XWPFHyperlink> iter = hyperlinks.iterator(); Iterator<XWPFHyperlink> iter = hyperlinks.iterator();
while(iter.hasNext()) while (iter.hasNext()) {
{
XWPFHyperlink link = iter.next(); XWPFHyperlink link = iter.next();
if(link.getId().equals(id)) if(link.getId().equals(id))
return link; return link;
@ -363,15 +361,12 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
} }
public XWPFHyperlink[] getHyperlinks() { public XWPFHyperlink[] getHyperlinks() {
return hyperlinks.toArray( return hyperlinks.toArray(new XWPFHyperlink[hyperlinks.size()]);
new XWPFHyperlink[hyperlinks.size()]
);
} }
public XWPFComment getCommentByID(String id) { public XWPFComment getCommentByID(String id) {
Iterator<XWPFComment> iter = comments.iterator(); Iterator<XWPFComment> iter = comments.iterator();
while(iter.hasNext()) while (iter.hasNext()) {
{
XWPFComment comment = iter.next(); XWPFComment comment = iter.next();
if(comment.getId().equals(id)) if(comment.getId().equals(id))
return comment; return comment;
@ -379,10 +374,9 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
return null; return null;
} }
public XWPFComment[] getComments() { public XWPFComment[] getComments() {
return comments.toArray( return comments.toArray(new XWPFComment[comments.size()]);
new XWPFComment[comments.size()]
);
} }
/** /**
@ -391,10 +385,8 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
*/ */
public PackagePart getPartById(String id) { public PackagePart getPartById(String id) {
try { try {
return getTargetPart( return getTargetPart(getCorePart().getRelationship(id));
getCorePart().getRelationship(id) } catch (InvalidFormatException e) {
);
} catch(InvalidFormatException e) {
throw new IllegalArgumentException(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); throw new IllegalStateException("Expecting one Styles document part, but found " + parts.length);
} }
StylesDocument sd = StylesDocument sd = StylesDocument.Factory.parse(parts[0].getInputStream());
StylesDocument.Factory.parse(parts[0].getInputStream());
return sd.getStyles(); return sd.getStyles();
} }
@ -435,11 +426,13 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
List<PackagePart> embedds = new LinkedList<PackagePart>(); List<PackagePart> embedds = new LinkedList<PackagePart>();
// Get the embeddings for the workbook // 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)); 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)); embedds.add(getTargetPart(rel));
}
return embedds; return embedds;
} }
@ -475,14 +468,18 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
} }
/** /**
* get with the position of a Paragraph in the bodyelement array list * Look up the paragraph at the specified position in the body elemnts list
* the position of this paragraph in the paragraph array list * and return this paragraphs position in the paragraphs 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, * @param pos
* else it will return -1 * The position of the relevant paragraph in the body elements
* list
* @return the position of the paragraph in the paragraphs list, if there is
* a paragraph at the position in the bodyelements list. Else it
* will return -1
* *
*/ */
public int getParagraphPos(int pos){ public int getParagraphPos(int pos) {
return getBodyElementSpecificPos(pos, paragraphs); return getBodyElementSpecificPos(pos, paragraphs);
} }
@ -493,97 +490,134 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
* @return if there is a table at the position in the bodyelement array list, * @return if there is a table at the position in the bodyelement array list,
* else it will return null. * else it will return null.
*/ */
public int getTablePos(int pos){ public int getTablePos(int pos) {
return getBodyElementSpecificPos(pos, tables); return getBodyElementSpecificPos(pos, tables);
} }
/** /**
* add a new paragraph at position of the cursor * add a new paragraph at position of the cursor. The cursor must be on the
* {@link TokenType#START} tag of an subelement of the documents body. When
* this method is done, the cursor passed as parameter points to the
* {@link TokenType#END} of the newly inserted paragraph.
*
* @param cursor * @param cursor
* @return the {@link XWPFParagraph} object representing the newly inserted
* CTP object
*/ */
public XWPFParagraph insertNewParagraph(XmlCursor cursor){ public XWPFParagraph insertNewParagraph(XmlCursor cursor) {
if(isCursorInBody(cursor)){ if (isCursorInBody(cursor)) {
String uri = CTP.type.getName().getNamespaceURI(); String uri = CTP.type.getName().getNamespaceURI();
String localPart = "p"; /*
cursor.beginElement(localPart,uri); * TODO DO not use a coded constant, find the constant in the OOXML
cursor.toParent(); * classes instead, as the child of type CT_Paragraph is defined in the
CTP p = (CTP)cursor.getObject(); * OOXML schema as 'p'
XWPFParagraph newP = new XWPFParagraph(p, this); */
XmlObject o = null; String localPart = "p";
while(!(o instanceof CTP)&&(cursor.toPrevSibling())){ // creates a new Paragraph, cursor is positioned inside the new
o = cursor.getObject(); // element
} cursor.beginElement(localPart, uri);
if((!(o instanceof CTP)) || (CTP)o == p){ // move the cursor to the START token to the paragraph just created
paragraphs.add(0, newP); cursor.toParent();
} CTP p = (CTP) cursor.getObject();
else{ XWPFParagraph newP = new XWPFParagraph(p, this);
int pos = paragraphs.indexOf(getParagraph((CTP)o))+1; XmlObject o = null;
paragraphs.add(pos,newP); /*
} * move the cursor to the previous element until a) the next
int i=0; * paragraph is found or b) all elements have been passed
cursor.toCursor(p.newCursor()); */
while(cursor.toPrevSibling()){ while (!(o instanceof CTP) && (cursor.toPrevSibling())) {
o =cursor.getObject(); o = cursor.getObject();
if(o instanceof CTP || o instanceof CTTbl) }
i++; /*
} * if the object that has been found is a) not a paragraph or b) is
bodyElements.add(i, newP); * the paragraph that has just been inserted, as the cursor in the
cursor.toCursor(p.newCursor()); * while loop above was not moved as there were no other siblings,
cursor.toEndToken(); * then the paragraph that was just inserted is the first paragraph
return newP; * in the body. Otherwise, take the previous paragraph and calculate
} * the new index for the new paragraph.
return null; */
if ((!(o instanceof CTP)) || (CTP) o == p) {
paragraphs.add(0, newP);
} else {
int pos = paragraphs.indexOf(getParagraph((CTP) o)) + 1;
paragraphs.add(pos, newP);
}
/*
* create a new cursor, that points to the START token of the just
* inserted paragraph
*/
XmlCursor newParaPos = p.newCursor();
try {
/*
* Calculate the paragraphs index in the list of all body
* elements
*/
int i = 0;
cursor.toCursor(newParaPos);
while (cursor.toPrevSibling()) {
o = cursor.getObject();
if (o instanceof CTP || o instanceof CTTbl)
i++;
}
bodyElements.add(i, newP);
cursor.toCursor(newParaPos);
cursor.toEndToken();
return newP;
} finally {
newParaPos.dispose();
}
}
return null;
} }
public XWPFTable insertNewTbl(XmlCursor cursor) { public XWPFTable insertNewTbl(XmlCursor cursor) {
if(isCursorInBody(cursor)){ if (isCursorInBody(cursor)) {
String uri = CTTbl.type.getName().getNamespaceURI(); String uri = CTTbl.type.getName().getNamespaceURI();
String localPart ="tbl"; String localPart = "tbl";
cursor.beginElement(localPart,uri); cursor.beginElement(localPart, uri);
cursor.toParent(); cursor.toParent();
CTTbl t = (CTTbl)cursor.getObject(); CTTbl t = (CTTbl) cursor.getObject();
XWPFTable newT = new XWPFTable(t, this); XWPFTable newT = new XWPFTable(t, this);
cursor.removeXmlContents(); cursor.removeXmlContents();
XmlObject o = null; XmlObject o = null;
while(!(o instanceof CTTbl)&&(cursor.toPrevSibling())){ while (!(o instanceof CTTbl) && (cursor.toPrevSibling())) {
o = cursor.getObject(); o = cursor.getObject();
} }
if(!(o instanceof CTTbl)){ if (!(o instanceof CTTbl)) {
tables.add(0, newT); tables.add(0, newT);
} } else {
else{ int pos = tables.indexOf(getTable((CTTbl) o)) + 1;
int pos = tables.indexOf(getTable((CTTbl)o))+1; tables.add(pos, newT);
tables.add(pos,newT); }
} int i = 0;
int i=0; cursor = t.newCursor();
cursor = t.newCursor(); while (cursor.toPrevSibling()) {
while(cursor.toPrevSibling()){ o = cursor.getObject();
o =cursor.getObject(); if (o instanceof CTP || o instanceof CTTbl)
if(o instanceof CTP || o instanceof CTTbl) i++;
i++; }
} bodyElements.add(i, newT);
bodyElements.add(i, newT); cursor = t.newCursor();
cursor = t.newCursor(); cursor.toEndToken();
cursor.toEndToken(); return newT;
return newT; }
} return null;
return null; }
}
/** /**
* verifies that cursor is on the right position * verifies that cursor is on the right position
* @param cursor * @param cursor
*/ */
private boolean isCursorInBody(XmlCursor cursor) { private boolean isCursorInBody(XmlCursor cursor) {
XmlCursor verify = cursor.newCursor(); XmlCursor verify = cursor.newCursor();
verify.toParent(); verify.toParent();
if(verify.getObject() == this.ctDocument.getBody()){ try {
return true; return (verify.getObject() == this.ctDocument.getBody());
} } finally {
XmlObject o = verify.getObject(); verify.dispose();
return false; }
}
}
private int getPosOfBodyElement(IBodyElement needle) { private int getPosOfBodyElement(IBodyElement needle) {
BodyElementType type = needle.getElementType(); BodyElementType type = needle.getElementType();
@ -666,7 +700,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
* Appends a new paragraph to this document * Appends a new paragraph to this document
* @return a new paragraph * @return a new paragraph
*/ */
public XWPFParagraph createParagraph(){ public XWPFParagraph createParagraph() {
XWPFParagraph p = new XWPFParagraph(ctDocument.getBody().addNewP(), this); XWPFParagraph p = new XWPFParagraph(ctDocument.getBody().addNewP(), this);
bodyElements.add(p); bodyElements.add(p);
paragraphs.add(p); paragraphs.add(p);
@ -753,24 +787,28 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
* @param paragraph * @param paragraph
* @param pos * @param pos
*/ */
public void setParagraph(XWPFParagraph paragraph, int pos){ public void setParagraph(XWPFParagraph paragraph, int pos) {
paragraphs.set(pos, paragraph); paragraphs.set(pos, paragraph);
ctDocument.getBody().setPArray(pos, paragraph.getCTP()); ctDocument.getBody().setPArray(pos, paragraph.getCTP());
/* TODO update body element, update xwpf element, verify that
* incoming paragraph belongs to this document or if not, XML was
* copied properly (namespace-abbreviations, etc.)
*/
} }
/** /**
* @return the LastParagraph of the document * @return the LastParagraph of the document
*/ */
public XWPFParagraph getLastParagraph(){ public XWPFParagraph getLastParagraph() {
int lastPos = paragraphs.toArray().length - 1; int lastPos = paragraphs.toArray().length - 1;
return paragraphs.get(lastPos); return paragraphs.get(lastPos);
} }
/** /**
* Create an empty table with one row and one column as default. * Create an empty table with one row and one column as default.
* @return a new table * @return a new table
*/ */
public XWPFTable createTable(){ public XWPFTable createTable() {
XWPFTable table = new XWPFTable(ctDocument.getBody().addNewTbl(), this); XWPFTable table = new XWPFTable(ctDocument.getBody().addNewTbl(), this);
bodyElements.add(table); bodyElements.add(table);
tables.add(table); tables.add(table);
@ -790,21 +828,19 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
return table; return table;
} }
/** /**
* *
*/ */
public void createTOC() { public void createTOC() {
CTSdtBlock block = this.getDocument().getBody().addNewSdt(); CTSdtBlock block = this.getDocument().getBody().addNewSdt();
TOC toc = new TOC(block); TOC toc = new TOC(block);
for (XWPFParagraph par: paragraphs ) { for (XWPFParagraph par : paragraphs) {
String parStyle = par.getStyle(); String parStyle = par.getStyle();
if (parStyle != null && parStyle.substring(0, 7).equals("Heading")) { if (parStyle != null && parStyle.substring(0, 7).equals("Heading")) {
try { try {
int level = Integer.valueOf(parStyle.substring("Heading".length())).intValue(); int level = Integer.valueOf(parStyle.substring("Heading".length())).intValue();
toc.addRow(level, par.getText(), 1, "112723803"); toc.addRow(level, par.getText(), 1, "112723803");
} } catch (NumberFormatException e) {
catch (NumberFormatException e) {
e.printStackTrace(); e.printStackTrace();
} }
} }
@ -815,9 +851,9 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
* @param pos * @param pos
* @param table * @param table
*/ */
public void setTable(int pos, XWPFTable table){ public void setTable(int pos, XWPFTable table) {
tables.set(pos, table); tables.set(pos, table);
ctDocument.getBody().setTblArray(pos, table.getCTTbl()); ctDocument.getBody().setTblArray(pos, table.getCTTbl());
} }
/** /**
@ -962,98 +998,137 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
} }
/** /**
* Return the zoom level, as a percentage * inserts an existing XWPFTable to the arrays bodyElements and tables
* @param pos
* @param table
*/ */
public long getZoomPercent() { public void insertTable(int pos, XWPFTable table) {
return settings.getZoomPercent(); bodyElements.add(pos, table);
int i;
for (i = 0; i < ctDocument.getBody().getTblList().size(); i++) {
CTTbl tbl = ctDocument.getBody().getTblArray(i);
if (tbl == table.getCTTbl()) {
break;
}
}
tables.add(i, table);
} }
/** /**
* Sets the zoom level, as a percentage * Returns all Pictures, which are referenced from the document itself.
* @return a {@link List} of {@link XWPFPictureData}. The returned {@link List} is unmodifiable. Use #a
*/ */
public void setZoomPercent(long zoomPercent) {
settings.setZoomPercent(zoomPercent);
}
/**
* inserts an existing XWPFTable to the arrays bodyElements and tables
* @param pos
* @param table
*/
public void insertTable(int pos, XWPFTable table) {
bodyElements.add(pos, table);
int i;
for (i = 0; i < ctDocument.getBody().getTblList().size(); i++) {
CTTbl tbl = ctDocument.getBody().getTblArray(i);
if(tbl == table.getCTTbl()){
break;
}
}
tables.add(i, table);
}
public List<XWPFPictureData> getAllPictures() { public List<XWPFPictureData> getAllPictures() {
if(pictures == null){ return Collections.unmodifiableList(pictures);
pictures = new ArrayList<XWPFPictureData>();
for (POIXMLDocumentPart poixmlDocumentPart : getRelations()){
if(poixmlDocumentPart instanceof XWPFPictureData){
pictures.add((XWPFPictureData)poixmlDocumentPart);
}
}
}
return pictures;
} }
/** /**
* @return all Pictures in this package * @return all Pictures in this package
*/ */
public List<XWPFPictureData> getAllPackagePictures(){ public List<XWPFPictureData> getAllPackagePictures() {
List<XWPFPictureData> pkgpictures = new ArrayList<XWPFPictureData>(); List<XWPFPictureData> result = new ArrayList<XWPFPictureData>();
pkgpictures.addAll(getAllPictures()); Collection<List<XWPFPictureData>> values = packagePictures.values();
for (POIXMLDocumentPart poixmlDocumentPart : getRelations()){ for (List<XWPFPictureData> list : values) {
if(poixmlDocumentPart instanceof XWPFHeaderFooter){ result.addAll(list);
pkgpictures.addAll(((XWPFHeaderFooter)poixmlDocumentPart).getAllPictures()); }
} return Collections.unmodifiableList(result);
}
return pkgpictures;
} }
/** void registerPackagePictureData(XWPFPictureData picData) {
* Adds a picture to the document. Users should normally call List<XWPFPictureData> list = packagePictures.get(picData.getChecksum());
* {@link XWPFRun#addPicture(InputStream, int)} if (list == null) {
* list = new ArrayList<XWPFPictureData>(1);
* packagePictures.put(picData.getChecksum(), list);
* @param is The stream to read image from }
* @param format The format of the picture, eg {@link Document#PICTURE_TYPE_JPEG} 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
*/
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;
} }
/** XWPFPictureData findPackagePictureData(byte[] pictureData, int format)
* Adds a picture to the document. Users should normally call {
* {@link XWPFRun#addPicture(InputStream, int)} long checksum = IOUtils.calculateChecksum(pictureData);
* XWPFPictureData xwpfPicData = null;
* @param pictureData The bytes to read image from /*
* @param format The format of the picture, eg {@link Document#PICTURE_TYPE_JPEG} * Try to find PictureData with this checksum. Create new, if none
* * exists.
* @return the index to this picture (0 based), the added picture can be obtained from {@link #getAllPictures()} . */
* @throws InvalidFormatException List<XWPFPictureData> xwpfPicDataList = packagePictures.get(checksum);
*/ if (xwpfPicDataList != null) {
public int addPicture(byte[] pictureData, int format) throws InvalidFormatException { Iterator<XWPFPictureData> iter = xwpfPicDataList.iterator();
while (iter.hasNext() && xwpfPicData == null) {
XWPFPictureData curElem = iter.next();
if (Arrays.equals(pictureData, curElem.getData())) {
xwpfPicData = curElem;
}
}
}
return xwpfPicData;
}
public String addPictureData(byte[] pictureData,int format) throws InvalidFormatException
{
XWPFPictureData xwpfPicData = findPackagePictureData(pictureData, format);
POIXMLRelation relDesc = XWPFPictureData.RELATIONS[format];
if (xwpfPicData == null)
{
/* Part doesn't exist, create a new one */
int idx = getNextPicNameNumber(format);
xwpfPicData = (XWPFPictureData) createRelationship(relDesc, XWPFFactory.getInstance(),idx);
/* write bytes to new part */
PackagePart picDataPart = xwpfPicData.getPackagePart();
OutputStream out = null;
try {
out = picDataPart.getOutputStream();
out.write(pictureData);
} catch (IOException e) {
throw new POIXMLException(e);
} finally {
try {
out.close();
} catch (IOException e) {
// ignore
}
}
registerPackagePictureData(xwpfPicData);
pictures.add(xwpfPicData);
return getRelationId(xwpfPicData);
}
else if (!getRelations().contains(xwpfPicData))
{
/*
* Part already existed, but was not related so far. Create
* relationship to the already existing part and update
* POIXMLDocumentPart data.
*/
PackagePart picDataPart = xwpfPicData.getPackagePart();
// TODO add support for TargetMode.EXTERNAL relations.
TargetMode targetMode = TargetMode.INTERNAL;
PackagePartName partName = picDataPart.getPartName();
String relation = relDesc.getRelation();
PackageRelationship relShip = getPackagePart().addRelationship(partName,targetMode,relation);
String id = relShip.getId();
addRelation(id,xwpfPicData);
pictures.add(xwpfPicData);
return id;
}
else
{
/* Part already existed, get relation id and return it */
return getRelationId(xwpfPicData);
}
}
public String addPictureData(InputStream is,int format) throws InvalidFormatException
{
try { try {
return addPicture(new ByteArrayInputStream(pictureData), format); byte[] data = IOUtils.toByteArray(is);
} catch (IOException e){ return addPictureData(data, format);
} catch (IOException e) {
throw new POIXMLException(e); throw new POIXMLException(e);
} }
} }
@ -1064,78 +1139,77 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
* @return the next free ImageNumber * @return the next free ImageNumber
* @throws InvalidFormatException * @throws InvalidFormatException
*/ */
public int getNextPicNameNumber(int format) throws InvalidFormatException{ public int getNextPicNameNumber(int format) throws InvalidFormatException {
int img = getAllPackagePictures().size()+1; int img = getAllPackagePictures().size() + 1;
String proposal = XWPFPictureData.RELATIONS[format].getFileName(img); String proposal = XWPFPictureData.RELATIONS[format].getFileName(img);
PackagePartName createPartName = PackagingURIHelper.createPartName(proposal); PackagePartName createPartName = PackagingURIHelper.createPartName(proposal);
while (this.getPackage().getPart(createPartName)!= null){ while (this.getPackage().getPart(createPartName) != null) {
img++; img++;
proposal = XWPFPictureData.RELATIONS[format].getFileName(img); proposal = XWPFPictureData.RELATIONS[format].getFileName(img);
createPartName = PackagingURIHelper.createPartName(proposal); createPartName = PackagingURIHelper.createPartName(proposal);
} }
return img; return img;
} }
/** /**
* returns the PictureData by blipID * returns the PictureData by blipID
* @param blipID * @param blipID
* @return XWPFPictureData of a specificID * @return XWPFPictureData of a specificID
* @throws Exception
*/ */
public XWPFPictureData getPictureDataByID(String blipID) { public XWPFPictureData getPictureDataByID(String blipID) {
for(POIXMLDocumentPart part: getRelations()){ POIXMLDocumentPart relatedPart = getRelationById(blipID);
if(part.getPackageRelationship() != null){ if (relatedPart instanceof XWPFPictureData) {
if(part.getPackageRelationship().getId() != null){ XWPFPictureData xwpfPicData = (XWPFPictureData) relatedPart;
if(part.getPackageRelationship().getId().equals(blipID)){ return xwpfPicData;
return (XWPFPictureData)part; }
} return null;
}
}
}
return null;
} }
/** /**
* getNumbering * getNumbering
* @return numbering * @return numbering
*/ */
public XWPFNumbering getNumbering(){ public XWPFNumbering getNumbering() {
return numbering; return numbering;
} }
/** /**
* get Styles * get Styles
* @return styles for this document * @return styles for this document
*/ */
public XWPFStyles getStyles(){ public XWPFStyles getStyles() {
return styles; return styles;
} }
/** /**
* get the paragraph with the CTP class p * get the paragraph with the CTP class p
* *
* @param p * @param p
* @return the paragraph with the CTP class p * @return the paragraph with the CTP class p
*/ */
public XWPFParagraph getParagraph(CTP p){ public XWPFParagraph getParagraph(CTP p) {
for(int i=0; i<getParagraphs().size(); i++){ 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; }
} }
return null;
}
/** /**
* get a table by its CTTbl-Object * get a table by its CTTbl-Object
* @param ctTbl * @param ctTbl
* @see org.apache.poi.xwpf.usermodel.IBody#getTable(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl) * @see org.apache.poi.xwpf.usermodel.IBody#getTable(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl)
* @return a table by its CTTbl-Object or null * @return a table by its CTTbl-Object or null
*/ */
public XWPFTable getTable(CTTbl ctTbl) { public XWPFTable getTable(CTTbl ctTbl) {
for(int i=0; i<tables.size(); i++){ 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; }
} }
return null;
}
public Iterator<XWPFTable> getTablesIterator() { public Iterator<XWPFTable> getTablesIterator() {
@ -1157,18 +1231,17 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
return null; return null;
} }
/**
* returns the Part, to which the body belongs, which you need for adding relationship to other parts
* Actually it is needed of the class XWPFTableCell. Because you have to know to which part the tableCell
* belongs.
* @see org.apache.poi.xwpf.usermodel.IBody#getPart()
*/
public POIXMLDocumentPart getPart() {
return this;
}
/**
* returns the Part, to which the body belongs, which you need for adding relationship to other parts
* Actually it is needed of the class XWPFTableCell. Because you have to know to which part the tableCell
* belongs.
* @see org.apache.poi.xwpf.usermodel.IBody#getPart()
*/
public IBody getPart() {
return this;
}
/** /**
* get the PartType of the body, for example * get the PartType of the body, for example
* DOCUMENT, HEADER, FOOTER, FOOTNOTE, * DOCUMENT, HEADER, FOOTER, FOOTNOTE,
@ -1212,4 +1285,4 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
public XWPFDocument getXWPFDocument() { public XWPFDocument getXWPFDocument() {
return this; return this;
} }
}//end class } // end class

131
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.IOException;
import java.io.InputStream; import java.io.InputStream;
import java.io.OutputStream; import java.io.OutputStream;
import java.util.ArrayList;
import java.util.HashMap; import java.util.HashMap;
import java.util.Map; import java.util.Map;
import javax.xml.namespace.QName; import javax.xml.namespace.QName;
import org.apache.poi.POIXMLDocumentPart; import org.apache.poi.POIXMLDocumentPart;
import org.apache.poi.POIXMLException;
import org.apache.poi.openxml4j.opc.PackagePart; import org.apache.poi.openxml4j.opc.PackagePart;
import org.apache.poi.openxml4j.opc.PackageRelationship; import org.apache.poi.openxml4j.opc.PackageRelationship;
import org.apache.xmlbeans.XmlCursor; import org.apache.xmlbeans.XmlCursor;
import org.apache.xmlbeans.XmlException;
import org.apache.xmlbeans.XmlObject; import org.apache.xmlbeans.XmlObject;
import org.apache.xmlbeans.XmlOptions; import org.apache.xmlbeans.XmlOptions;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHdrFtr; import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHdrFtr;
@ -46,38 +45,34 @@ public class XWPFFooter extends XWPFHeaderFooter {
super(); super();
} }
public XWPFFooter(XWPFDocument doc, CTHdrFtr hdrFtr) throws IOException { public XWPFFooter(XWPFDocument doc, CTHdrFtr hdrFtr) throws IOException {
super(doc, hdrFtr); super(doc, hdrFtr);
bodyElements = new ArrayList<IBodyElement>(); XmlCursor cursor = headerFooter.newCursor();
paragraphs = new ArrayList<XWPFParagraph>();
tables = new ArrayList<XWPFTable>();
XmlCursor cursor = headerFooter.newCursor();
cursor.selectPath("./*"); cursor.selectPath("./*");
while (cursor.toNextSelection()) { while (cursor.toNextSelection()) {
XmlObject o = cursor.getObject(); XmlObject o = cursor.getObject();
if (o instanceof CTP) { if (o instanceof CTP) {
XWPFParagraph p = new XWPFParagraph((CTP)o, this); XWPFParagraph p = new XWPFParagraph((CTP)o, this);
paragraphs.add(p); paragraphs.add(p);
bodyElements.add(p); bodyElements.add(p);
} }
if (o instanceof CTTbl) { if (o instanceof CTTbl) {
XWPFTable t = new XWPFTable((CTTbl)o, this); XWPFTable t = new XWPFTable((CTTbl)o, this);
tables.add(t); tables.add(t);
bodyElements.add(t); bodyElements.add(t);
} }
} }
cursor.dispose(); cursor.dispose();
getAllPictures(); }
}
public XWPFFooter(POIXMLDocumentPart parent, PackagePart part, PackageRelationship rel) throws IOException { public XWPFFooter(POIXMLDocumentPart parent, PackagePart part, PackageRelationship rel) throws IOException {
super(parent, part, rel); super(parent, part, rel);
} }
/** /**
* save and commit footer * save and commit footer
*/ */
@Override @Override
protected void commit() throws IOException { protected void commit() throws IOException {
XmlOptions xmlOptions = new XmlOptions(DEFAULT_XML_OPTIONS); XmlOptions xmlOptions = new XmlOptions(DEFAULT_XML_OPTIONS);
xmlOptions.setSaveSyntheticDocumentElement(new QName(CTNumbering.type.getName().getNamespaceURI(), "ftr")); xmlOptions.setSaveSyntheticDocumentElement(new QName(CTNumbering.type.getName().getNamespaceURI(), "ftr"));
@ -98,57 +93,43 @@ public class XWPFFooter extends XWPFHeaderFooter {
out.close(); out.close();
} }
@Override @Override
protected void onDocumentRead(){ protected void onDocumentRead() throws IOException{
bodyElements = new ArrayList<IBodyElement>(); super.onDocumentRead();
paragraphs = new ArrayList<XWPFParagraph>(); FtrDocument ftrDocument = null;
tables= new ArrayList<XWPFTable>(); InputStream is;
FtrDocument ftrDocument = null; try {
InputStream is; is = getPackagePart().getInputStream();
try { ftrDocument = FtrDocument.Factory.parse(is);
is = getPackagePart().getInputStream(); headerFooter = ftrDocument.getFtr();
ftrDocument = FtrDocument.Factory.parse(is); // parse the document with cursor and add
headerFooter = ftrDocument.getFtr(); // the XmlObject to its lists
// parse the document with cursor and add XmlCursor cursor = headerFooter.newCursor();
// the XmlObject to its lists cursor.selectPath("./*");
XmlCursor cursor = headerFooter.newCursor(); while (cursor.toNextSelection()) {
cursor.selectPath("./*"); XmlObject o = cursor.getObject();
while (cursor.toNextSelection()) { if (o instanceof CTP) {
XmlObject o = cursor.getObject(); XWPFParagraph p = new XWPFParagraph((CTP)o, this);
if (o instanceof CTP) { paragraphs.add(p);
XWPFParagraph p = new XWPFParagraph((CTP)o, this); bodyElements.add(p);
paragraphs.add(p); }
bodyElements.add(p); if (o instanceof CTTbl) {
} XWPFTable t = new XWPFTable((CTTbl)o, this);
if (o instanceof CTTbl) { tables.add(t);
XWPFTable t = new XWPFTable((CTTbl)o, this); bodyElements.add(t);
tables.add(t); }
bodyElements.add(t); }
} cursor.dispose();
} } catch (Exception e) {
cursor.dispose(); throw new POIXMLException(e);
getAllPictures(); }
} catch (IOException e) { }
// TODO Auto-generated catch block
e.printStackTrace();
} catch (XmlException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
/**
* returns the Part, to which the body belongs, which you need for adding relationship to other parts
* @see org.apache.poi.xwpf.usermodel.IBody#getPart()
*/
public IBody getPart() {
return this;
}
/** /**
* get the PartType of the body * get the PartType of the body
* @see org.apache.poi.xwpf.usermodel.IBody#getPartType() * @see org.apache.poi.xwpf.usermodel.IBody#getPartType()
*/ */
public BodyType getPartType() { public BodyType getPartType() {
return BodyType.FOOTER; return BodyType.FOOTER;
} }
} }

152
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.IOException;
import java.io.InputStream; import java.io.InputStream;
import java.io.OutputStream; import java.io.OutputStream;
import java.util.ArrayList;
import java.util.HashMap; import java.util.HashMap;
import java.util.Map; import java.util.Map;
import javax.xml.namespace.QName; import javax.xml.namespace.QName;
import org.apache.poi.POIXMLDocumentPart; import org.apache.poi.POIXMLDocumentPart;
import org.apache.poi.POIXMLException;
import org.apache.poi.openxml4j.opc.PackagePart; import org.apache.poi.openxml4j.opc.PackagePart;
import org.apache.poi.openxml4j.opc.PackageRelationship; import org.apache.poi.openxml4j.opc.PackageRelationship;
import org.apache.xmlbeans.XmlCursor; import org.apache.xmlbeans.XmlCursor;
@ -47,40 +47,31 @@ public class XWPFHeader extends XWPFHeaderFooter {
} }
public XWPFHeader(POIXMLDocumentPart parent, PackagePart part, PackageRelationship rel) throws IOException { public XWPFHeader(POIXMLDocumentPart parent, PackagePart part, PackageRelationship rel) throws IOException {
super(parent, part, rel); super(parent, part, rel);
} }
public XWPFHeader(XWPFDocument doc, CTHdrFtr hdrFtr) throws IOException { public XWPFHeader(XWPFDocument doc, CTHdrFtr hdrFtr) {
super(doc, hdrFtr); super(doc, hdrFtr);
paragraphs = new ArrayList<XWPFParagraph>(); XmlCursor cursor = headerFooter.newCursor();
tables = new ArrayList<XWPFTable>(); cursor.selectPath("./*");
XmlCursor cursor = headerFooter.newCursor(); while (cursor.toNextSelection()) {
cursor.selectPath("./*"); XmlObject o = cursor.getObject();
while (cursor.toNextSelection()) { if (o instanceof CTP) {
XmlObject o = cursor.getObject(); XWPFParagraph p = new XWPFParagraph((CTP) o, this);
if (o instanceof CTP) { paragraphs.add(p);
XWPFParagraph p = new XWPFParagraph((CTP) o, this); }
paragraphs.add(p); if (o instanceof CTTbl) {
} XWPFTable t = new XWPFTable((CTTbl) o, this);
if (o instanceof CTTbl) { tables.add(t);
XWPFTable t = new XWPFTable((CTTbl) o, this); }
tables.add(t); }
}
}
cursor.dispose(); cursor.dispose();
getAllPictures(); }
}
/** /**
public XWPFHeader(PackagePart part, PackageRelationship rel) * save and commit footer
throws IOException { */
super(part, rel); @Override
}
/**
* save and commit footer
*/
@Override
protected void commit() throws IOException { protected void commit() throws IOException {
XmlOptions xmlOptions = new XmlOptions(DEFAULT_XML_OPTIONS); XmlOptions xmlOptions = new XmlOptions(DEFAULT_XML_OPTIONS);
xmlOptions.setSaveSyntheticDocumentElement(new QName(CTNumbering.type.getName().getNamespaceURI(), "hdr")); xmlOptions.setSaveSyntheticDocumentElement(new QName(CTNumbering.type.getName().getNamespaceURI(), "hdr"));
@ -101,62 +92,47 @@ public class XWPFHeader extends XWPFHeaderFooter {
out.close(); out.close();
} }
/** /**
* reads the document * reads the document
*/ * @throws IOException
@Override */
protected void onDocumentRead(){ @Override
bodyElements = new ArrayList<IBodyElement>(); protected void onDocumentRead() throws IOException {
paragraphs = new ArrayList<XWPFParagraph>(); super.onDocumentRead();
tables= new ArrayList<XWPFTable>(); HdrDocument hdrDocument = null;
HdrDocument hdrDocument = null; InputStream is;
InputStream is; try {
try { is = getPackagePart().getInputStream();
is = getPackagePart().getInputStream(); hdrDocument = HdrDocument.Factory.parse(is);
hdrDocument = HdrDocument.Factory.parse(is); headerFooter = hdrDocument.getHdr();
headerFooter = hdrDocument.getHdr(); // parse the document with cursor and add
// parse the document with cursor and add // the XmlObject to its lists
// the XmlObject to its lists XmlCursor cursor = headerFooter.newCursor();
XmlCursor cursor = headerFooter.newCursor(); cursor.selectPath("./*");
cursor.selectPath("./*"); while (cursor.toNextSelection()) {
while (cursor.toNextSelection()) { XmlObject o = cursor.getObject();
XmlObject o = cursor.getObject(); if (o instanceof CTP) {
if (o instanceof CTP) { XWPFParagraph p = new XWPFParagraph((CTP)o, this);
XWPFParagraph p = new XWPFParagraph((CTP)o, this); paragraphs.add(p);
paragraphs.add(p); bodyElements.add(p);
bodyElements.add(p); }
} if (o instanceof CTTbl) {
if (o instanceof CTTbl) { XWPFTable t = new XWPFTable((CTTbl)o, this);
XWPFTable t = new XWPFTable((CTTbl)o, this); tables.add(t);
tables.add(t); bodyElements.add(t);
bodyElements.add(t); }
} }
} cursor.dispose();
cursor.dispose(); } catch (XmlException e) {
} catch (IOException e) { throw new POIXMLException(e);
// TODO Auto-generated catch block }
e.printStackTrace(); }
} catch (XmlException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
/**
* returns the Part, to which the body belongs, which you need for adding relationship to other parts
* @see org.apache.poi.xwpf.usermodel.IBody#getPart()
*/
public IBody getPart() {
return this;
}
/**
* get the PartType of the body
* @see org.apache.poi.xwpf.usermodel.IBody#getPartType()
*/
public BodyType getPartType() {
return BodyType.HEADER;
}
/**
* get the PartType of the body
* @see org.apache.poi.xwpf.usermodel.IBody#getPartType()
*/
public BodyType getPartType() {
return BodyType.HEADER;
}
}//end class }//end class

740
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.POIXMLDocumentPart;
import org.apache.poi.POIXMLException; import org.apache.poi.POIXMLException;
import org.apache.poi.POIXMLRelation;
import org.apache.poi.openxml4j.exceptions.InvalidFormatException; import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
import org.apache.poi.openxml4j.opc.PackagePart; import org.apache.poi.openxml4j.opc.PackagePart;
import org.apache.poi.openxml4j.opc.PackagePartName; import org.apache.poi.openxml4j.opc.PackagePartName;
import org.apache.poi.openxml4j.opc.PackageRelationship; 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.IOUtils;
import org.apache.poi.util.Internal; import org.apache.poi.util.Internal;
import org.apache.xmlbeans.XmlCursor; import org.apache.xmlbeans.XmlCursor;
@ -43,173 +44,174 @@ import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTc;
/** /**
* Parent of XWPF headers and footers * Parent of XWPF headers and footers
*/ */
public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBody{ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBody {
protected CTHdrFtr headerFooter; List<XWPFParagraph> paragraphs = new ArrayList<XWPFParagraph>(1);
protected List<XWPFParagraph> paragraphs; List<XWPFTable> tables= new ArrayList<XWPFTable>(1);
protected List<XWPFTable> tables; List<XWPFPictureData> pictures = new ArrayList<XWPFPictureData>();
protected List<XWPFPictureData> pictures; List<IBodyElement> bodyElements = new ArrayList<IBodyElement>(1);
protected XWPFDocument document;
protected List<IBodyElement> bodyElements;
protected XWPFHeaderFooter(XWPFDocument doc, CTHdrFtr hdrFtr){ CTHdrFtr headerFooter;
XWPFDocument document;
XWPFHeaderFooter(XWPFDocument doc, CTHdrFtr hdrFtr){
if (doc==null) { if (doc==null) {
throw new NullPointerException(); throw new NullPointerException();
} }
document = doc; document = doc;
headerFooter = hdrFtr; headerFooter = hdrFtr;
readHdrFtr(); readHdrFtr();
} }
protected XWPFHeaderFooter() { protected XWPFHeaderFooter() {
headerFooter = CTHdrFtr.Factory.newInstance(); headerFooter = CTHdrFtr.Factory.newInstance();
readHdrFtr(); readHdrFtr();
} }
public XWPFHeaderFooter(POIXMLDocumentPart parent, PackagePart part, PackageRelationship rel) throws IOException { public XWPFHeaderFooter(POIXMLDocumentPart parent, PackagePart part, PackageRelationship rel) throws IOException {
super(parent, part, rel); super(parent, part, rel);
this.document = (XWPFDocument)getParent(); this.document = (XWPFDocument)getParent();
if (this.document==null) { if (this.document==null) {
throw new NullPointerException(); 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 @Internal
public CTHdrFtr _getHdrFtr() { public CTHdrFtr _getHdrFtr() {
return headerFooter; return headerFooter;
} }
public List<IBodyElement> getBodyElements(){ public List<IBodyElement> getBodyElements(){
return Collections.unmodifiableList(bodyElements); return Collections.unmodifiableList(bodyElements);
} }
/** /**
* Returns the paragraph(s) that holds * Returns the paragraph(s) that holds
* the text of the header or footer. * the text of the header or footer.
* Normally there is only the one paragraph, but * Normally there is only the one paragraph, but
* there could be more in certain cases, or * there could be more in certain cases, or
* a table. * a table.
*/ */
public List<XWPFParagraph> getParagraphs() { public List<XWPFParagraph> getParagraphs() {
return Collections.unmodifiableList(paragraphs); return Collections.unmodifiableList(paragraphs);
} }
/** /**
* Return the table(s) that holds the text * Return the table(s) that holds the text
* of the header or footer, for complex cases * of the header or footer, for complex cases
* where a paragraph isn't used. * where a paragraph isn't used.
* Normally there's just one paragraph, but some * Normally there's just one paragraph, but some
* complex headers/footers have a table or two * complex headers/footers have a table or two
* in addition. * in addition.
*/ */
public List<XWPFTable> getTables()throws ArrayIndexOutOfBoundsException { public List<XWPFTable> getTables()throws ArrayIndexOutOfBoundsException {
return Collections.unmodifiableList(tables); return Collections.unmodifiableList(tables);
} }
/** /**
* Returns the textual content of the header/footer, * Returns the textual content of the header/footer,
* by flattening out the text of its paragraph(s) * by flattening out the text of its paragraph(s)
*/ */
public String getText() { public String getText() {
StringBuffer t = new StringBuffer(); StringBuffer t = new StringBuffer();
for(int i=0; i<paragraphs.size(); i++) { for(int i=0; i<paragraphs.size(); i++) {
if(! paragraphs.get(i).isEmpty()) { if(! paragraphs.get(i).isEmpty()) {
String text = paragraphs.get(i).getText(); String text = paragraphs.get(i).getText();
if(text != null && text.length() > 0) { if(text != null && text.length() > 0) {
t.append(text); t.append(text);
t.append('\n'); t.append('\n');
} }
} }
} }
List<XWPFTable> tables = getTables(); List<XWPFTable> tables = getTables();
for(int i=0; i<tables.size(); i++) { for(int i=0; i<tables.size(); i++) {
String text = tables.get(i).getText(); String text = tables.get(i).getText();
if(text != null && text.length() > 0) { if(text != null && text.length() > 0) {
t.append(text); t.append(text);
t.append('\n'); t.append('\n');
} }
} }
return t.toString(); return t.toString();
} }
/** /**
* set a new headerFooter * set a new headerFooter
*/ */
public void setHeaderFooter(CTHdrFtr headerFooter){ public void setHeaderFooter(CTHdrFtr headerFooter){
this.headerFooter = headerFooter; this.headerFooter = headerFooter;
readHdrFtr(); readHdrFtr();
} }
/** /**
* if there is a corresponding {@link XWPFTable} of the parameter ctTable in the tableList of this header * if there is a corresponding {@link XWPFTable} of the parameter ctTable in the tableList of this header
* the method will return this table * the method will return this table
* if there is no corresponding {@link XWPFTable} the method will return null * if there is no corresponding {@link XWPFTable} the method will return null
* @param ctTable * @param ctTable
*/ */
public XWPFTable getTable(CTTbl ctTable){ public XWPFTable getTable(CTTbl ctTable){
for (XWPFTable table : tables) { for (XWPFTable table : tables) {
if(table==null) if(table==null)
return null; return null;
if(table.getCTTbl().equals(ctTable)) if(table.getCTTbl().equals(ctTable))
return table; return table;
} }
return null; return null;
} }
/** /**
* if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this header or footer * if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this header or footer
* the method will return this paragraph * the method will return this paragraph
* if there is no corresponding {@link XWPFParagraph} the method will return null * if there is no corresponding {@link XWPFParagraph} the method will return null
* @param p is instance of CTP and is searching for an XWPFParagraph * @param p is instance of CTP and is searching for an XWPFParagraph
* @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer * @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer
* XWPFParagraph with the correspondig CTP p * XWPFParagraph with the correspondig CTP p
*/ */
public XWPFParagraph getParagraph(CTP p){ public XWPFParagraph getParagraph(CTP p){
for (XWPFParagraph paragraph : paragraphs) { for (XWPFParagraph paragraph : paragraphs) {
if(paragraph.getCTP().equals(p)) if(paragraph.getCTP().equals(p))
return paragraph; return paragraph;
} }
return null; return null;
} }
/** /**
* Returns the paragraph that holds * Returns the paragraph that holds
* the text of the header or footer. * the text of the header or footer.
*/ */
public XWPFParagraph getParagraphArray(int pos) { public XWPFParagraph getParagraphArray(int pos) {
return paragraphs.get(pos); return paragraphs.get(pos);
} }
/** /**
* get a List of all Paragraphs * get a List of all Paragraphs
* @return a list of {@link XWPFParagraph} * @return a list of {@link XWPFParagraph}
*/ */
public List<XWPFParagraph> getListParagraph(){ public List<XWPFParagraph> getListParagraph(){
return paragraphs; return paragraphs;
} }
public List<XWPFPictureData> getAllPictures() { public List<XWPFPictureData> getAllPictures() {
if(pictures == null){ return Collections.unmodifiableList(pictures);
pictures = new ArrayList<XWPFPictureData>();
for (POIXMLDocumentPart poixmlDocumentPart : getRelations()){
if(poixmlDocumentPart instanceof XWPFPictureData){
pictures.add((XWPFPictureData)poixmlDocumentPart);
}
}
}
return pictures;
} }
/** /**
@ -217,78 +219,87 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
* @return all Pictures in this package * @return all Pictures in this package
*/ */
public List<XWPFPictureData> getAllPackagePictures(){ public List<XWPFPictureData> getAllPackagePictures(){
List<XWPFPictureData> pkgpictures = new ArrayList<XWPFPictureData>(); return document.getAllPackagePictures();
pkgpictures.addAll(getAllPictures());
for (POIXMLDocumentPart poixmlDocumentPart : getRelations()){
if(poixmlDocumentPart instanceof XWPFHeaderFooter){
pkgpictures.addAll(((XWPFHeaderFooter)poixmlDocumentPart).getAllPictures());
}
}
return pkgpictures;
} }
/** /**
* Adds a picture to the document. * Adds a picture to the document.
* *
* @param is The stream to read image from * @param is The stream to read image from
* @param format The format of the picture. * @param format The format of the picture.
* *
* @return the index to this picture (0 based), the added picture can be obtained from {@link #getAllPictures()} . * @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 { public String addPictureData(byte[] pictureData,int format) throws InvalidFormatException
int imageNumber = getNextPicNameNumber(format); {
XWPFPictureData img = (XWPFPictureData)createRelationship(XWPFPictureData.RELATIONS[format], XWPFFactory.getInstance(), imageNumber, true); XWPFPictureData xwpfPicData = document.findPackagePictureData(pictureData, format);
OutputStream out = img.getPackagePart().getOutputStream(); POIXMLRelation relDesc = XWPFPictureData.RELATIONS[format];
IOUtils.copy(is, out);
out.close();
pictures.add(img);
return getAllPictures().size()-1;
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. * 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. * @param format The format of the picture.
* *
* @return the index to this picture (0 based), the added picture can be obtained from {@link #getAllPictures()} . * @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) { public String addPictureData(InputStream is, int format) throws InvalidFormatException,IOException {
int imageNumber = getNextPicNameNumber(format); byte[] data = IOUtils.toByteArray(is);
XWPFPictureData img = (XWPFPictureData)createRelationship(XWPFPictureData.RELATIONS[format], XWPFFactory.getInstance(), imageNumber, false); return addPictureData(data,format);
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;
} }
/** /**
@ -298,245 +309,194 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
* @throws Exception * @throws Exception
*/ */
public XWPFPictureData getPictureDataByID(String blipID) { public XWPFPictureData getPictureDataByID(String blipID) {
for(POIXMLDocumentPart part: getRelations()){ POIXMLDocumentPart relatedPart = getRelationById(blipID);
if(part.getPackageRelationship() != null){ if (relatedPart != null && relatedPart instanceof XWPFPictureData) {
if(part.getPackageRelationship().getId() != null){ return (XWPFPictureData) relatedPart;
if(part.getPackageRelationship().getId().equals(blipID)){ }
return (XWPFPictureData)part; return null;
}
}
}
}
return null;
} }
/** /**
* Add the picture to drawing relations * add a new paragraph at position of the cursor
* * @param cursor
* @param pictureData the picture bytes * @return the inserted paragraph
* @param format the picture format
*/ */
public PackageRelationship addPictureReference(byte[] pictureData, int format){ public XWPFParagraph insertNewParagraph(XmlCursor cursor){
int imageNumber = getNextPicNameNumber(format); if(isCursorInHdrF(cursor)){
XWPFPictureData img = (XWPFPictureData)createRelationship(XWPFPictureData.RELATIONS[format], XWPFFactory.getInstance(), imageNumber, false); String uri = CTP.type.getName().getNamespaceURI();
PackageRelationship rel = null; String localPart = "p";
try { cursor.beginElement(localPart,uri);
OutputStream out = img.getPackagePart().getOutputStream(); cursor.toParent();
out.write(pictureData); CTP p = (CTP)cursor.getObject();
out.close(); XWPFParagraph newP = new XWPFParagraph(p, this);
rel = img.getPackageRelationship(); XmlObject o = null;
pictures.add(img); while(!(o instanceof CTP)&&(cursor.toPrevSibling())){
} catch (IOException e){ o = cursor.getObject();
throw new POIXMLException(e); }
} if((!(o instanceof CTP)) || (CTP)o == p){
return rel; paragraphs.add(0, newP);
}
else{
int pos = paragraphs.indexOf(getParagraph((CTP)o))+1;
paragraphs.add(pos,newP);
}
int i=0;
cursor.toCursor(p.newCursor());
while(cursor.toPrevSibling()){
o =cursor.getObject();
if(o instanceof CTP || o instanceof CTTbl)
i++;
}
bodyElements.add(i, newP);
cursor.toCursor(p.newCursor());
cursor.toEndToken();
return newP;
}
return null;
} }
/**
* 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); * @param cursor
XWPFPictureData img = (XWPFPictureData)createRelationship(XWPFPictureData.RELATIONS[format], XWPFFactory.getInstance(), imageNumber, false); * @return the inserted table
OutputStream out = img.getPackagePart().getOutputStream(); */
IOUtils.copy(is, out); public XWPFTable insertNewTbl(XmlCursor cursor) {
out.close(); if(isCursorInHdrF(cursor)){
rel = img.getPackageRelationship(); String uri = CTTbl.type.getName().getNamespaceURI();
pictures.add(img); String localPart = "tbl";
} catch (IOException e) { cursor.beginElement(localPart,uri);
// TODO Auto-generated catch block cursor.toParent();
e.printStackTrace(); CTTbl t = (CTTbl)cursor.getObject();
} XWPFTable newT = new XWPFTable(t, this);
return rel; cursor.removeXmlContents();
} XmlObject o = null;
while(!(o instanceof CTTbl)&&(cursor.toPrevSibling())){
o = cursor.getObject();
}
if(!(o instanceof CTTbl)){
tables.add(0, newT);
}
else{
int pos = tables.indexOf(getTable((CTTbl)o))+1;
tables.add(pos,newT);
}
int i=0;
cursor = t.newCursor();
while(cursor.toPrevSibling()){
o =cursor.getObject();
if(o instanceof CTP || o instanceof CTTbl)
i++;
}
bodyElements.add(i, newT);
cursor = t.newCursor();
cursor.toEndToken();
return newT;
}
return null;
}
/** /**
* add a new paragraph at position of the cursor * verifies that cursor is on the right position
* @param cursor * @param cursor
* @return the inserted paragraph */
*/ private boolean isCursorInHdrF(XmlCursor cursor) {
public XWPFParagraph insertNewParagraph(XmlCursor cursor){ XmlCursor verify = cursor.newCursor();
if(isCursorInHdrF(cursor)){ verify.toParent();
String uri = CTP.type.getName().getNamespaceURI(); if(verify.getObject() == this.headerFooter){
String localPart = "p"; return true;
cursor.beginElement(localPart,uri); }
cursor.toParent(); return false;
CTP p = (CTP)cursor.getObject(); }
XWPFParagraph newP = new XWPFParagraph(p, this);
XmlObject o = null;
while(!(o instanceof CTP)&&(cursor.toPrevSibling())){
o = cursor.getObject();
}
if((!(o instanceof CTP)) || (CTP)o == p){
paragraphs.add(0, newP);
}
else{
int pos = paragraphs.indexOf(getParagraph((CTP)o))+1;
paragraphs.add(pos,newP);
}
int i=0;
cursor.toCursor(p.newCursor());
while(cursor.toPrevSibling()){
o =cursor.getObject();
if(o instanceof CTP || o instanceof CTTbl)
i++;
}
bodyElements.add(i, newP);
cursor.toCursor(p.newCursor());
cursor.toEndToken();
return newP;
}
return null;
}
/** public POIXMLDocumentPart getOwner(){
* return this;
* @param cursor }
* @return the inserted table
*/
public XWPFTable insertNewTbl(XmlCursor cursor) {
if(isCursorInHdrF(cursor)){
String uri = CTTbl.type.getName().getNamespaceURI();
String localPart = "tbl";
cursor.beginElement(localPart,uri);
cursor.toParent();
CTTbl t = (CTTbl)cursor.getObject();
XWPFTable newT = new XWPFTable(t, this);
cursor.removeXmlContents();
XmlObject o = null;
while(!(o instanceof CTTbl)&&(cursor.toPrevSibling())){
o = cursor.getObject();
}
if(!(o instanceof CTTbl)){
tables.add(0, newT);
}
else{
int pos = tables.indexOf(getTable((CTTbl)o))+1;
tables.add(pos,newT);
}
int i=0;
cursor = t.newCursor();
while(cursor.toPrevSibling()){
o =cursor.getObject();
if(o instanceof CTP || o instanceof CTTbl)
i++;
}
bodyElements.add(i, newT);
cursor = t.newCursor();
cursor.toEndToken();
return newT;
}
return null;
}
/** /**
* verifies that cursor is on the right position * Returns the table at position pos
* @param cursor * @see org.apache.poi.xwpf.usermodel.IBody#getTableArray(int)
*/ */
private boolean isCursorInHdrF(XmlCursor cursor) { public XWPFTable getTableArray(int pos) {
XmlCursor verify = cursor.newCursor();
verify.toParent();
if(verify.getObject() == this.headerFooter){
return true;
}
return false;
}
if(pos > 0 && pos < tables.size()){
return tables.get(pos);
}
return null;
}
public POIXMLDocumentPart getOwner(){ /**
return this; * inserts an existing XWPFTable to the arrays bodyElements and tables
} * @param pos
* @param table
*/
public void insertTable(int pos, XWPFTable table) {
bodyElements.add(pos, table);
int i;
for (i = 0; i < headerFooter.getTblList().size(); i++) {
CTTbl tbl = headerFooter.getTblArray(i);
if(tbl == table.getCTTbl()){
break;
}
}
tables.add(i, table);
/** }
* Returns the table at position pos
* @see org.apache.poi.xwpf.usermodel.IBody#getTableArray(int)
*/
public XWPFTable getTableArray(int pos) {
if(pos > 0 && pos < tables.size()){ public void readHdrFtr(){
return tables.get(pos); bodyElements = new ArrayList<IBodyElement>();
}
return null;
}
/**
* inserts an existing XWPFTable to the arrays bodyElements and tables
* @param pos
* @param table
*/
public void insertTable(int pos, XWPFTable table) {
bodyElements.add(pos, table);
int i;
for (i = 0; i < headerFooter.getTblList().size(); i++) {
CTTbl tbl = headerFooter.getTblArray(i);
if(tbl == table.getCTTbl()){
break;
}
}
tables.add(i, table);
}
public void readHdrFtr(){
bodyElements = new ArrayList<IBodyElement>();
paragraphs = new ArrayList<XWPFParagraph>(); paragraphs = new ArrayList<XWPFParagraph>();
tables= new ArrayList<XWPFTable>(); tables= new ArrayList<XWPFTable>();
// parse the document with cursor and add // parse the document with cursor and add
// the XmlObject to its lists // the XmlObject to its lists
XmlCursor cursor = headerFooter.newCursor(); XmlCursor cursor = headerFooter.newCursor();
cursor.selectPath("./*"); cursor.selectPath("./*");
while (cursor.toNextSelection()) { while (cursor.toNextSelection()) {
XmlObject o = cursor.getObject(); XmlObject o = cursor.getObject();
if (o instanceof CTP) { if (o instanceof CTP) {
XWPFParagraph p = new XWPFParagraph((CTP)o, this); XWPFParagraph p = new XWPFParagraph((CTP)o, this);
paragraphs.add(p); paragraphs.add(p);
bodyElements.add(p); bodyElements.add(p);
} }
if (o instanceof CTTbl) { if (o instanceof CTTbl) {
XWPFTable t = new XWPFTable((CTTbl)o, this); XWPFTable t = new XWPFTable((CTTbl)o, this);
tables.add(t); tables.add(t);
bodyElements.add(t); bodyElements.add(t);
} }
} }
cursor.dispose(); cursor.dispose();
getAllPictures(); }
}
/** /**
* get the TableCell which belongs to the TableCell * get the TableCell which belongs to the TableCell
* @param cell * @param cell
*/ */
public XWPFTableCell getTableCell(CTTc cell) { public XWPFTableCell getTableCell(CTTc cell) {
XmlCursor cursor = cell.newCursor(); XmlCursor cursor = cell.newCursor();
cursor.toParent(); cursor.toParent();
XmlObject o = cursor.getObject(); XmlObject o = cursor.getObject();
if(!(o instanceof CTRow)){ if(!(o instanceof CTRow)){
return null; return null;
} }
CTRow row = (CTRow)o; CTRow row = (CTRow)o;
cursor.toParent(); cursor.toParent();
o = cursor.getObject(); o = cursor.getObject();
cursor.dispose(); cursor.dispose();
if(! (o instanceof CTTbl)){ if(! (o instanceof CTTbl)){
return null; return null;
} }
CTTbl tbl = (CTTbl) o; CTTbl tbl = (CTTbl) o;
XWPFTable table = getTable(tbl); XWPFTable table = getTable(tbl);
if(table == null){ if(table == null){
return null; return null;
} }
XWPFTableRow tableRow = table.getRow(row); XWPFTableRow tableRow = table.getRow(row);
if(row == null){ if(row == null){
return null; return null;
} }
return tableRow.getTableCell(cell); return tableRow.getTableCell(cell);
} }
public XWPFDocument getXWPFDocument() { public XWPFDocument getXWPFDocument() {
if (document!=null) { if (document!=null) {
@ -545,4 +505,12 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
return (XWPFDocument)getParent(); 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 }//end class

14
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 { public class XWPFNumbering extends POIXMLDocumentPart {
private CTNumbering ctNumbering; protected List<XWPFAbstractNum> abstractNums = new ArrayList<XWPFAbstractNum>();
protected List<XWPFAbstractNum> abstractNums; protected List<XWPFNum> nums = new ArrayList<XWPFNum>();
protected List<XWPFNum> nums;
protected boolean isNew; private CTNumbering ctNumbering;
boolean isNew;
/** /**
*create a new styles object with an existing document *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{ public XWPFNumbering(PackagePart part, PackageRelationship rel) throws IOException, OpenXML4JException{
super(part, rel); super(part, rel);
isNew = true; isNew = true;
onDocumentRead();
} }
/** /**
@ -72,8 +72,6 @@ public class XWPFNumbering extends POIXMLDocumentPart {
*/ */
@Override @Override
protected void onDocumentRead() throws IOException{ protected void onDocumentRead() throws IOException{
abstractNums = new ArrayList<XWPFAbstractNum>();
nums = new ArrayList<XWPFNum>();
NumberingDocument numberingDoc = null; NumberingDocument numberingDoc = null;
InputStream is; InputStream is;
is = getPackagePart().getInputStream(); is = getPackagePart().getInputStream();
@ -100,7 +98,7 @@ public class XWPFNumbering extends POIXMLDocumentPart {
protected void commit() throws IOException { protected void commit() throws IOException {
XmlOptions xmlOptions = new XmlOptions(DEFAULT_XML_OPTIONS); XmlOptions xmlOptions = new XmlOptions(DEFAULT_XML_OPTIONS);
xmlOptions.setSaveSyntheticDocumentElement(new QName(CTNumbering.type.getName().getNamespaceURI(), "numbering")); 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("http://schemas.openxmlformats.org/markup-compatibility/2006", "ve");
map.put("urn:schemas-microsoft-com:office:office", "o"); map.put("urn:schemas-microsoft-com:office:office", "o");
map.put("http://schemas.openxmlformats.org/officeDocument/2006/relationships", "r"); map.put("http://schemas.openxmlformats.org/officeDocument/2006/relationships", "r");

108
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.Collections;
import java.util.List; import java.util.List;
import org.apache.poi.POIXMLDocumentPart;
import org.apache.poi.util.Internal; import org.apache.poi.util.Internal;
import org.apache.xmlbeans.XmlCursor; import org.apache.xmlbeans.XmlCursor;
import org.apache.xmlbeans.XmlObject; import org.apache.xmlbeans.XmlObject;
@ -50,11 +51,10 @@ import org.openxmlformats.schemas.wordprocessingml.x2006.main.STLineSpacingRule;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STOnOff; import org.openxmlformats.schemas.wordprocessingml.x2006.main.STOnOff;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STTextAlignment; import org.openxmlformats.schemas.wordprocessingml.x2006.main.STTextAlignment;
/** /**
* Sketch of XWPF paragraph class * Sketch of XWPF paragraph class
*/ */
public class XWPFParagraph implements IBodyElement{ public class XWPFParagraph implements IBodyElement {
private final CTP paragraph; private final CTP paragraph;
protected IBody part; protected IBody part;
/** For access to the document's hyperlink, comments, tables etc */ /** For access to the document's hyperlink, comments, tables etc */
@ -260,9 +260,9 @@ public class XWPFParagraph implements IBodyElement{
* @return a new text run * @return a new text run
*/ */
public XWPFRun createRun() { public XWPFRun createRun() {
XWPFRun run = new XWPFRun(paragraph.addNewR(), this); XWPFRun xwpfRun = new XWPFRun(paragraph.addNewR(), this);
runs.add(run); runs.add(xwpfRun);
return run; return xwpfRun;
} }
/** /**
@ -1233,53 +1233,65 @@ public class XWPFParagraph implements IBodyElement{
return false; return false;
} }
/** /**
* returns the type of the BodyElement Paragraph * returns the type of the BodyElement Paragraph
* @see org.apache.poi.xwpf.usermodel.IBodyElement#getElementType() * @see org.apache.poi.xwpf.usermodel.IBodyElement#getElementType()
*/ */
public BodyElementType getElementType() { public BodyElementType getElementType() {
return BodyElementType.PARAGRAPH; return BodyElementType.PARAGRAPH;
} }
/** @Override
* returns the part of the bodyElement public IBody getBody()
* @see org.apache.poi.xwpf.usermodel.IBody#getPart() {
*/ return part;
public IBody getPart() { }
if(part != null){
return part.getPart();
}
return null;
}
/** /**
* returns the partType of the bodyPart which owns the bodyElement * returns the part of the bodyElement
* @see org.apache.poi.xwpf.usermodel.IBody#getPartType() * @see org.apache.poi.xwpf.usermodel.IBody#getPart()
*/ */
public BodyType getPartType() { public POIXMLDocumentPart getPart() {
return part.getPartType(); if(part != null){
} return part.getPart();
}
return null;
}
/** /**
* adds a new Run to the Paragraph * returns the partType of the bodyPart which owns the bodyElement
*/ *
public void addRun(XWPFRun r){ * @see org.apache.poi.xwpf.usermodel.IBody#getPartType()
runs.add(r); */
} public BodyType getPartType() {
return part.getPartType();
/** }
* return the XWPFRun-Element which owns the CTR run-Element
*/
public XWPFRun getRun(CTR r){
for(int i=0; i < getRuns().size(); i++){
if(getRuns().get(i).getCTR() == r) return getRuns().get(i);
}
return null;
}
/**
* adds a new Run to the Paragraph
*
* @param r
* @return
*/
public void addRun(XWPFRun r) {
if (!runs.contains(r)) {
runs.add(r);
}
}
/**
* return the XWPFRun-Element which owns the CTR run-Element
*
* @param r
* @return
*/
public XWPFRun getRun(CTR r) {
for (int i = 0; i < getRuns().size(); i++) {
if (getRuns().get(i).getCTR() == r) {
return getRuns().get(i);
}
}
return null;
}
}//end class }//end class

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

@ -25,27 +25,24 @@ import org.openxmlformats.schemas.drawingml.x2006.picture.CTPicture;
* @author Philipp Epp * @author Philipp Epp
*/ */
public class XWPFPicture { public class XWPFPicture {
protected XWPFParagraph paragraph;
private CTPicture ctPic; private CTPicture ctPic;
private String description; private String description;
private XWPFRun run;
public XWPFParagraph getParagraph(){ public XWPFPicture(CTPicture ctPic, XWPFRun run){
return paragraph; this.run = run;
} this.ctPic = ctPic;
description = ctPic.getNvPicPr().getCNvPr().getDescr();
}
public XWPFPicture(CTPicture ctPic, XWPFParagraph paragraph){ /**
this.paragraph = paragraph; * Link Picture with PictureData
this.ctPic = ctPic; * @param rel
description = ctPic.getNvPicPr().getCNvPr().getDescr(); */
} public void setPictureReference(PackageRelationship rel){
ctPic.getBlipFill().getBlip().setEmbed(rel.getId());
/** }
* Link Picture with PictureData
* @param rel
*/
public void setPictureReference(PackageRelationship rel){
ctPic.getBlipFill().getBlip().setEmbed(rel.getId());
}
/** /**
* Return the underlying CTPicture bean that holds all properties for this picture * Return the underlying CTPicture bean that holds all properties for this picture
@ -61,13 +58,16 @@ public class XWPFPicture {
* Note - not all kinds of picture have data * Note - not all kinds of picture have data
*/ */
public XWPFPictureData getPictureData(){ public XWPFPictureData getPictureData(){
String blipId = ctPic.getBlipFill().getBlip().getEmbed(); String blipId = ctPic.getBlipFill().getBlip().getEmbed();
for(POIXMLDocumentPart part: ((POIXMLDocumentPart) paragraph.getPart()).getRelations()){ POIXMLDocumentPart part = run.getParagraph().getPart();
if(part.getPackageRelationship().getId().equals(blipId)){ if (part != null)
return (XWPFPictureData)part; {
} POIXMLDocumentPart relatedPart = part.getRelationById(blipId);
} if (relatedPart instanceof XWPFPictureData) {
return null; return (XWPFPictureData) relatedPart;
}
}
return null;
} }
public String getDescription() { public String getDescription() {

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

@ -18,9 +18,13 @@
package org.apache.poi.xwpf.usermodel; package org.apache.poi.xwpf.usermodel;
import java.io.IOException; import java.io.IOException;
import java.io.InputStream;
import java.util.Arrays;
import org.apache.poi.POIXMLDocumentPart; import org.apache.poi.POIXMLDocumentPart;
import org.apache.poi.POIXMLException;
import org.apache.poi.POIXMLRelation; 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.PackagePart;
import org.apache.poi.openxml4j.opc.PackageRelationship; import org.apache.poi.openxml4j.opc.PackageRelationship;
import org.apache.poi.util.IOUtils; import org.apache.poi.util.IOUtils;
@ -32,7 +36,6 @@ import org.apache.poi.util.IOUtils;
/** /**
* @author Philipp Epp * @author Philipp Epp
*
*/ */
public class XWPFPictureData extends POIXMLDocumentPart { public class XWPFPictureData extends POIXMLDocumentPart {
@ -42,19 +45,22 @@ public class XWPFPictureData extends POIXMLDocumentPart {
protected static final POIXMLRelation[] RELATIONS; protected static final POIXMLRelation[] RELATIONS;
static { static {
RELATIONS = new POIXMLRelation[9]; RELATIONS = new POIXMLRelation[9];
RELATIONS[Document.PICTURE_TYPE_EMF] = XWPFRelation.IMAGE_EMF; RELATIONS[Document.PICTURE_TYPE_EMF] = XWPFRelation.IMAGE_EMF;
RELATIONS[Document.PICTURE_TYPE_WMF] = XWPFRelation.IMAGE_WMF; RELATIONS[Document.PICTURE_TYPE_WMF] = XWPFRelation.IMAGE_WMF;
RELATIONS[Document.PICTURE_TYPE_PICT] = XWPFRelation.IMAGE_PICT; RELATIONS[Document.PICTURE_TYPE_PICT] = XWPFRelation.IMAGE_PICT;
RELATIONS[Document.PICTURE_TYPE_JPEG] = XWPFRelation.IMAGE_JPEG; RELATIONS[Document.PICTURE_TYPE_JPEG] = XWPFRelation.IMAGE_JPEG;
RELATIONS[Document.PICTURE_TYPE_PNG] = XWPFRelation.IMAGE_PNG; RELATIONS[Document.PICTURE_TYPE_PNG] = XWPFRelation.IMAGE_PNG;
RELATIONS[Document.PICTURE_TYPE_DIB] = XWPFRelation.IMAGE_DIB; RELATIONS[Document.PICTURE_TYPE_DIB] = XWPFRelation.IMAGE_DIB;
RELATIONS[Document.PICTURE_TYPE_GIF] = XWPFRelation.IMAGE_GIF; RELATIONS[Document.PICTURE_TYPE_GIF] = XWPFRelation.IMAGE_GIF;
} }
private Long checksum = null;
/** /**
* Create a new XWPFGraphicData node * Create a new XWPFGraphicData node
* *
*/ */
protected XWPFPictureData() { protected XWPFPictureData() {
super(); super();
} }
@ -65,11 +71,15 @@ public class XWPFPictureData extends POIXMLDocumentPart {
* @param rel the package relationship holding this drawing, * @param rel the package relationship holding this drawing,
* the relationship type must be http://schemas.openxmlformats.org/officeDocument/2006/relationships/image * the relationship type must be http://schemas.openxmlformats.org/officeDocument/2006/relationships/image
*/ */
public XWPFPictureData(PackagePart part, PackageRelationship rel) {
public XWPFPictureData(PackagePart part, PackageRelationship rel) {
super(part, rel); super(part, rel);
} }
@Override
protected void onDocumentRead() throws IOException {
super.onDocumentRead();
}
/** /**
* Gets the picture data as a byte array. * Gets the picture data as a byte array.
* <p> * <p>
@ -80,34 +90,30 @@ public class XWPFPictureData extends POIXMLDocumentPart {
* InputStream is = getPackagePart().getInputStream(); * InputStream is = getPackagePart().getInputStream();
* </code> * </code>
* </p> * </p>
*
* @return the Picture data. * @return the Picture data.
*/ */
public byte[] getData() { public byte[] getData() {
try { try {
return IOUtils.toByteArray(getPackagePart().getInputStream()); return IOUtils.toByteArray(getPackagePart().getInputStream());
} catch (IOException e) { } catch (IOException e) {
// TODO Auto-generated catch block throw new POIXMLException(e);
e.printStackTrace(); }
}
return null;
} }
/** /**
* Returns the file name of the image, eg image7.jpg . * Returns the file name of the image, eg image7.jpg . The original filename
* The original filename isn't always available, but if it * isn't always available, but if it can be found it's likely to be in the
* can be found it's likely to be in the CTDrawing * CTDrawing
*/ */
public String getFileName() { public String getFileName() {
String name = getPackagePart().getPartName().getName(); String name = getPackagePart().getPartName().getName();
if(name == null) if (name == null)
return null; return null;
return name.substring(name.lastIndexOf('/') + 1); return name.substring(name.lastIndexOf('/') + 1);
} }
/** /**
* Suggests a file extension for this image. * Suggests a file extension for this image.
*
* @return the file extension. * @return the file extension.
*/ */
public String suggestFileExtension() { public String suggestFileExtension() {
@ -125,15 +131,103 @@ public class XWPFPictureData extends POIXMLDocumentPart {
* @see org.apache.poi.xwpf.usermodel.Document#PICTURE_TYPE_PNG * @see org.apache.poi.xwpf.usermodel.Document#PICTURE_TYPE_PNG
* @see org.apache.poi.xwpf.usermodel.Document#PICTURE_TYPE_DIB * @see org.apache.poi.xwpf.usermodel.Document#PICTURE_TYPE_DIB
*/ */
public int getPictureType(){ public int getPictureType() {
String contentType = getPackagePart().getContentType(); String contentType = getPackagePart().getContentType();
for (int i = 0; i < RELATIONS.length; i++) { for (int i = 0; i < RELATIONS.length; i++) {
if(RELATIONS[i] == null) continue; if (RELATIONS[i] == null) {
continue;
}
if(RELATIONS[i].getContentType().equals(contentType)){ if (RELATIONS[i].getContentType().equals(contentType)) {
return i; return i;
} }
} }
return 0; 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();
}
} }

383
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.CTShapeProperties;
import org.openxmlformats.schemas.drawingml.x2006.main.CTTransform2D; import org.openxmlformats.schemas.drawingml.x2006.main.CTTransform2D;
import org.openxmlformats.schemas.drawingml.x2006.main.STShapeType; 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.drawingml.x2006.wordprocessingDrawing.CTInline;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTBr; import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTBr;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTDrawing; import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTDrawing;
@ -88,24 +89,43 @@ public class XWPFRun {
this.run = r; this.run = r;
this.paragraph = p; 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 // Look for any text in any of our pictures or drawings
StringBuffer text = new StringBuffer(); StringBuffer text = new StringBuffer();
List<XmlObject> pictTextObjs = new ArrayList<XmlObject>(); List<XmlObject> pictTextObjs = new ArrayList<XmlObject>();
pictTextObjs.addAll(r.getPictList()); pictTextObjs.addAll(r.getPictList());
pictTextObjs.addAll(r.getDrawingList()); pictTextObjs.addAll(drawingList);
for(XmlObject o : pictTextObjs) { for(XmlObject o : pictTextObjs) {
XmlObject[] t = o XmlObject[] t = o.selectPath("declare namespace w='http://schemas.openxmlformats.org/wordprocessingml/2006/main' .//w:t");
.selectPath("declare namespace w='http://schemas.openxmlformats.org/wordprocessingml/2006/main' .//w:t"); for (int m = 0; m < t.length; m++) {
for (int m = 0; m < t.length; m++) { NodeList kids = t[m].getDomNode().getChildNodes();
NodeList kids = t[m].getDomNode().getChildNodes(); for (int n = 0; n < kids.getLength(); n++) {
for (int n = 0; n < kids.getLength(); n++) { if (kids.item(n) instanceof Text) {
if (kids.item(n) instanceof Text) { if(text.length() > 0)
if(text.length() > 0) text.append("\n");
text.append("\n"); text.append(kids.item(n).getNodeValue());
text.append(kids.item(n).getNodeValue()); }
} }
} }
}
} }
pictureText = text.toString(); pictureText = text.toString();
@ -113,30 +133,30 @@ public class XWPFRun {
// (They're a different CTPicture, under the drawingml namespace) // (They're a different CTPicture, under the drawingml namespace)
pictures = new ArrayList<XWPFPicture>(); pictures = new ArrayList<XWPFPicture>();
for(XmlObject o : pictTextObjs) { for(XmlObject o : pictTextObjs) {
for(CTPicture pict : getCTPictures(o)) { for(CTPicture pict : getCTPictures(o)) {
XWPFPicture picture = new XWPFPicture( pict, p ); XWPFPicture picture = new XWPFPicture(pict, this);
pictures.add(picture); pictures.add(picture);
} }
} }
} }
private List<CTPicture> getCTPictures(XmlObject o) { private List<CTPicture> getCTPictures(XmlObject o) {
List<CTPicture> pictures = new ArrayList<CTPicture>(); List<CTPicture> pictures = new ArrayList<CTPicture>();
XmlObject[] picts = o.selectPath("declare namespace pic='"+CTPicture.type.getName().getNamespaceURI()+"' .//pic:pic"); XmlObject[] picts = o.selectPath("declare namespace pic='"+CTPicture.type.getName().getNamespaceURI()+"' .//pic:pic");
for(XmlObject pict : picts) { for(XmlObject pict : picts) {
if(pict instanceof XmlAnyTypeImpl) { if(pict instanceof XmlAnyTypeImpl) {
// Pesky XmlBeans bug - see Bugzilla #49934 // Pesky XmlBeans bug - see Bugzilla #49934
try { try {
pict = CTPicture.Factory.parse( pict.toString() ); pict = CTPicture.Factory.parse( pict.toString() );
} catch(XmlException e) { } catch(XmlException e) {
throw new POIXMLException(e); throw new POIXMLException(e);
} }
} }
if(pict instanceof CTPicture) { if(pict instanceof CTPicture) {
pictures.add((CTPicture)pict); pictures.add((CTPicture)pict);
} }
} }
return pictures; return pictures;
} }
/** /**
@ -156,17 +176,28 @@ public class XWPFRun {
return paragraph; 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 * For isBold, isItalic etc
*/ */
private boolean isCTOnOff(CTOnOff onoff) { private boolean isCTOnOff(CTOnOff onoff) {
if(! onoff.isSetVal()) if(! onoff.isSetVal())
return true; return true;
if(onoff.getVal() == STOnOff.ON) if(onoff.getVal() == STOnOff.ON)
return true; return true;
if(onoff.getVal() == STOnOff.TRUE) if(onoff.getVal() == STOnOff.TRUE)
return true; return true;
return false; return false;
} }
/** /**
@ -177,8 +208,9 @@ public class XWPFRun {
*/ */
public boolean isBold() { public boolean isBold() {
CTRPr pr = run.getRPr(); CTRPr pr = run.getRPr();
if(pr == null || !pr.isSetB()) if(pr == null || !pr.isSetB()) {
return false; return false;
}
return isCTOnOff(pr.getB()); return isCTOnOff(pr.getB());
} }
@ -235,7 +267,7 @@ public class XWPFRun {
* @param value the literal text which shall be displayed in the document * @param value the literal text which shall be displayed in the document
*/ */
public void setText(String value) { public void setText(String value) {
setText(value,run.getTList().size()); setText(value,run.getTList().size());
} }
/** /**
@ -245,13 +277,12 @@ public class XWPFRun {
* @param pos - position in the text array (NB: 0 based) * @param pos - position in the text array (NB: 0 based)
*/ */
public void setText(String value, int pos) { public void setText(String value, int pos) {
if(pos > run.sizeOfTArray()) throw new ArrayIndexOutOfBoundsException("Value too large for the parameter position in XWPFRun.setText(String value,int pos)"); if(pos > run.sizeOfTArray()) throw new ArrayIndexOutOfBoundsException("Value too large for the parameter position in XWPFRun.setText(String value,int pos)");
CTText t = (pos < run.sizeOfTArray() && pos >= 0) ? run.getTArray(pos) : run.addNewT(); CTText t = (pos < run.sizeOfTArray() && pos >= 0) ? run.getTArray(pos) : run.addNewT();
t.setStringValue(value); t.setStringValue(value);
preserveSpaces(t); preserveSpaces(t);
} }
/** /**
* Whether the italic property should be applied to all non-complex script * Whether the italic property should be applied to all non-complex script
* characters in the contents of this run when displayed in a document. * characters in the contents of this run when displayed in a document.
@ -261,7 +292,7 @@ public class XWPFRun {
public boolean isItalic() { public boolean isItalic() {
CTRPr pr = run.getRPr(); CTRPr pr = run.getRPr();
if(pr == null || !pr.isSetI()) if(pr == null || !pr.isSetI())
return false; return false;
return isCTOnOff(pr.getI()); return isCTOnOff(pr.getI());
} }
@ -306,7 +337,7 @@ public class XWPFRun {
public UnderlinePatterns getUnderline() { public UnderlinePatterns getUnderline() {
CTRPr pr = run.getRPr(); CTRPr pr = run.getRPr();
return (pr != null && pr.isSetU()) ? UnderlinePatterns.valueOf(pr return (pr != null && pr.isSetU()) ? UnderlinePatterns.valueOf(pr
.getU().getVal().intValue()) : UnderlinePatterns.NONE; .getU().getVal().intValue()) : UnderlinePatterns.NONE;
} }
/** /**
@ -339,7 +370,7 @@ public class XWPFRun {
public boolean isStrike() { public boolean isStrike() {
CTRPr pr = run.getRPr(); CTRPr pr = run.getRPr();
if(pr == null || !pr.isSetStrike()) if(pr == null || !pr.isSetStrike())
return false; return false;
return isCTOnOff(pr.getStrike()); return isCTOnOff(pr.getStrike());
} }
@ -384,8 +415,7 @@ public class XWPFRun {
*/ */
public VerticalAlign getSubscript() { public VerticalAlign getSubscript() {
CTRPr pr = run.getRPr(); CTRPr pr = run.getRPr();
return (pr != null && pr.isSetVertAlign()) ? VerticalAlign.valueOf(pr return (pr != null && pr.isSetVertAlign()) ? VerticalAlign.valueOf(pr.getVertAlign().getVal().intValue()) : VerticalAlign.BASELINE;
.getVertAlign().getVal().intValue()) : VerticalAlign.BASELINE;
} }
/** /**
@ -460,7 +490,7 @@ public class XWPFRun {
* @param size * @param size
*/ */
public void setFontSize(int size) { public void setFontSize(int size) {
BigInteger bint=new BigInteger(""+size); BigInteger bint=new BigInteger(""+size);
CTRPr pr = run.isSetRPr() ? run.getRPr() : run.addNewRPr(); CTRPr pr = run.isSetRPr() ? run.getRPr() : run.addNewRPr();
CTHpsMeasure ctSize = pr.isSetSz() ? pr.getSz() : pr.addNewSz(); CTHpsMeasure ctSize = pr.isSetSz() ? pr.getSz() : pr.addNewSz();
ctSize.setVal(bint.multiply(new BigInteger("2"))); ctSize.setVal(bint.multiply(new BigInteger("2")));
@ -503,7 +533,7 @@ public class XWPFRun {
* @param val * @param val
*/ */
public void setTextPosition(int val) { public void setTextPosition(int val) {
BigInteger bint=new BigInteger(""+val); BigInteger bint=new BigInteger(""+val);
CTRPr pr = run.isSetRPr() ? run.getRPr() : run.addNewRPr(); CTRPr pr = run.isSetRPr() ? run.getRPr() : run.addNewRPr();
CTSignedHpsMeasure position = pr.isSetPosition() ? pr.getPosition() : pr.addNewPosition(); CTSignedHpsMeasure position = pr.isSetPosition() ? pr.getPosition() : pr.addNewPosition();
position.setVal(bint); position.setVal(bint);
@ -513,7 +543,7 @@ public class XWPFRun {
* *
*/ */
public void removeBreak() { public void removeBreak() {
// TODO // TODO
} }
/** /**
@ -525,7 +555,7 @@ public class XWPFRun {
* @see #addCarriageReturn() * @see #addCarriageReturn()
*/ */
public void addBreak() { public void addBreak() {
run.addNewBr(); run.addNewBr();
} }
/** /**
@ -542,11 +572,10 @@ public class XWPFRun {
* @see BreakType * @see BreakType
*/ */
public void addBreak(BreakType type){ public void addBreak(BreakType type){
CTBr br=run.addNewBr(); CTBr br=run.addNewBr();
br.setType(STBrType.Enum.forInt(type.getValue())); br.setType(STBrType.Enum.forInt(type.getValue()));
} }
/** /**
* Specifies that a break shall be placed at the current location in the run * 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 * content. A break is a special character which is used to override the
@ -560,9 +589,9 @@ public class XWPFRun {
* @see BreakClear * @see BreakClear
*/ */
public void addBreak(BreakClear clear){ public void addBreak(BreakClear clear){
CTBr br=run.addNewBr(); CTBr br=run.addNewBr();
br.setType(STBrType.Enum.forInt(BreakType.TEXT_WRAPPING.getValue())); br.setType(STBrType.Enum.forInt(BreakType.TEXT_WRAPPING.getValue()));
br.setClear(STBrClear.Enum.forInt(clear.getValue())); br.setClear(STBrClear.Enum.forInt(clear.getValue()));
} }
/** /**
@ -578,11 +607,11 @@ public class XWPFRun {
* restarted on the next available line in the document. * restarted on the next available line in the document.
*/ */
public void addCarriageReturn() { public void addCarriageReturn() {
run.addNewCr(); run.addNewCr();
} }
public void removeCarriageReturn() { public void removeCarriageReturn() {
//TODO //TODO
} }
/** /**
@ -598,91 +627,95 @@ public class XWPFRun {
* *
* @param pictureData The raw picture data * @param pictureData The raw picture data
* @param pictureType The type of the picture, eg {@link Document#PICTURE_TYPE_JPEG} * @param pictureType The type of the picture, eg {@link Document#PICTURE_TYPE_JPEG}
* @throws IOException * @throws IOException
* @throws org.apache.poi.openxml4j.exceptions.InvalidFormatException * @throws org.apache.poi.openxml4j.exceptions.InvalidFormatException
* @throws IOException * @throws IOException
*/ */
public XWPFPicture addPicture(InputStream pictureData, int pictureType, String filename, int width, int height) public XWPFPicture addPicture(InputStream pictureData, int pictureType, String filename, int width, int height)
throws InvalidFormatException, IOException { throws InvalidFormatException, IOException {
XWPFDocument doc = paragraph.document; XWPFDocument doc = paragraph.document;
// Add the picture + relationship // Add the picture + relationship
int picNumber = doc.addPicture(pictureData, pictureType); String relationId = doc.addPictureData(pictureData, pictureType);
XWPFPictureData picData = doc.getAllPackagePictures().get(picNumber); XWPFPictureData picData = (XWPFPictureData) doc.getRelationById(relationId);
// Create the drawing entry for it // Create the drawing entry for it
try { try {
CTDrawing drawing = run.addNewDrawing(); CTDrawing drawing = run.addNewDrawing();
CTInline inline = drawing.addNewInline(); CTInline inline = drawing.addNewInline();
// Do the fiddly namespace bits on the inline // Do the fiddly namespace bits on the inline
// (We need full control of what goes where and as what) // (We need full control of what goes where and as what)
String xml = String xml =
"<a:graphic xmlns:a=\"" + CTGraphicalObject.type.getName().getNamespaceURI() + "\">" + "<a:graphic xmlns:a=\"" + CTGraphicalObject.type.getName().getNamespaceURI() + "\">" +
"<a:graphicData uri=\"" + CTGraphicalObject.type.getName().getNamespaceURI() + "\">" + "<a:graphicData uri=\"" + CTGraphicalObject.type.getName().getNamespaceURI() + "\">" +
"<pic:pic xmlns:pic=\"" + CTPicture.type.getName().getNamespaceURI() + "\" />" + "<pic:pic xmlns:pic=\"" + CTPicture.type.getName().getNamespaceURI() + "\" />" +
"</a:graphicData>" + "</a:graphicData>" +
"</a:graphic>"; "</a:graphic>";
inline.set(XmlToken.Factory.parse(xml)); inline.set(XmlToken.Factory.parse(xml));
// Setup the inline // Setup the inline
inline.setDistT(0); inline.setDistT(0);
inline.setDistR(0); inline.setDistR(0);
inline.setDistB(0); inline.setDistB(0);
inline.setDistL(0); inline.setDistL(0);
CTNonVisualDrawingProps docPr = inline.addNewDocPr(); CTNonVisualDrawingProps docPr = inline.addNewDocPr();
docPr.setId(picNumber); long id = getParagraph().document.getDrawingIdManager().reserveNew();
docPr.setName("Picture " + picNumber); docPr.setId(id);
docPr.setDescr(filename); /* This name is not visible in Word 2010 anywhere. */
docPr.setName("Drawing " + id);
docPr.setDescr(filename);
CTPositiveSize2D extent = inline.addNewExtent(); CTPositiveSize2D extent = inline.addNewExtent();
extent.setCx(width); extent.setCx(width);
extent.setCy(height); extent.setCy(height);
// Grab the picture object // Grab the picture object
CTGraphicalObject graphic = inline.getGraphic(); CTGraphicalObject graphic = inline.getGraphic();
CTGraphicalObjectData graphicData = graphic.getGraphicData(); CTGraphicalObjectData graphicData = graphic.getGraphicData();
CTPicture pic = getCTPictures(graphicData).get(0); CTPicture pic = getCTPictures(graphicData).get(0);
// Set it up // Set it up
CTPictureNonVisual nvPicPr = pic.addNewNvPicPr(); CTPictureNonVisual nvPicPr = pic.addNewNvPicPr();
CTNonVisualDrawingProps cNvPr = nvPicPr.addNewCNvPr(); CTNonVisualDrawingProps cNvPr = nvPicPr.addNewCNvPr();
cNvPr.setId(picNumber); /* use "0" for the id. See ECM-576, 20.2.2.3 */
cNvPr.setName("Picture " + picNumber); cNvPr.setId(0L);
cNvPr.setDescr(filename); /* This name is not visible in Word 2010 anywhere */
cNvPr.setName("Picture " + id);
cNvPr.setDescr(filename);
CTNonVisualPictureProperties cNvPicPr = nvPicPr.addNewCNvPicPr(); CTNonVisualPictureProperties cNvPicPr = nvPicPr.addNewCNvPicPr();
cNvPicPr.addNewPicLocks().setNoChangeAspect(true); cNvPicPr.addNewPicLocks().setNoChangeAspect(true);
CTBlipFillProperties blipFill = pic.addNewBlipFill(); CTBlipFillProperties blipFill = pic.addNewBlipFill();
CTBlip blip = blipFill.addNewBlip(); CTBlip blip = blipFill.addNewBlip();
blip.setEmbed( picData.getPackageRelationship().getId() ); blip.setEmbed( picData.getPackageRelationship().getId() );
blipFill.addNewStretch().addNewFillRect(); blipFill.addNewStretch().addNewFillRect();
CTShapeProperties spPr = pic.addNewSpPr(); CTShapeProperties spPr = pic.addNewSpPr();
CTTransform2D xfrm = spPr.addNewXfrm(); CTTransform2D xfrm = spPr.addNewXfrm();
CTPoint2D off = xfrm.addNewOff(); CTPoint2D off = xfrm.addNewOff();
off.setX(0); off.setX(0);
off.setY(0); off.setY(0);
CTPositiveSize2D ext = xfrm.addNewExt(); CTPositiveSize2D ext = xfrm.addNewExt();
ext.setCx(width); ext.setCx(width);
ext.setCy(height); ext.setCy(height);
CTPresetGeometry2D prstGeom = spPr.addNewPrstGeom(); CTPresetGeometry2D prstGeom = spPr.addNewPrstGeom();
prstGeom.setPrst(STShapeType.RECT); prstGeom.setPrst(STShapeType.RECT);
prstGeom.addNewAvLst(); prstGeom.addNewAvLst();
// Finish up // Finish up
XWPFPicture xwpfPicture = new XWPFPicture(pic, paragraph); XWPFPicture xwpfPicture = new XWPFPicture(pic, this);
pictures.add(xwpfPicture); pictures.add(xwpfPicture);
return xwpfPicture; return xwpfPicture;
} catch(XmlException e) { } catch(XmlException e) {
throw new IllegalStateException(e); throw new IllegalStateException(e);
} }
} }
/** /**
@ -691,7 +724,7 @@ public class XWPFRun {
* embedded picture image such as a .png or .jpg * embedded picture image such as a .png or .jpg
*/ */
public List<XWPFPicture> getEmbeddedPictures() { public List<XWPFPicture> getEmbeddedPictures() {
return pictures; return pictures;
} }
/** /**
@ -714,56 +747,56 @@ public class XWPFRun {
* carriage returns in place of their xml equivalents. * carriage returns in place of their xml equivalents.
*/ */
public String toString() { public String toString() {
StringBuffer text = new StringBuffer(); StringBuffer text = new StringBuffer();
// Grab the text and tabs of the text run // Grab the text and tabs of the text run
// Do so in a way that preserves the ordering // Do so in a way that preserves the ordering
XmlCursor c = run.newCursor(); XmlCursor c = run.newCursor();
c.selectPath("./*"); c.selectPath("./*");
while (c.toNextSelection()) { while (c.toNextSelection()) {
XmlObject o = c.getObject(); XmlObject o = c.getObject();
if (o instanceof CTText) { if (o instanceof CTText) {
String tagName = o.getDomNode().getNodeName(); String tagName = o.getDomNode().getNodeName();
// Field Codes (w:instrText, defined in spec sec. 17.16.23) // Field Codes (w:instrText, defined in spec sec. 17.16.23)
// come up as instances of CTText, but we don't want them // come up as instances of CTText, but we don't want them
// in the normal text output // in the normal text output
if (!"w:instrText".equals(tagName)) { if (!"w:instrText".equals(tagName)) {
text.append(((CTText) o).getStringValue()); text.append(((CTText) o).getStringValue());
} }
} }
if (o instanceof CTPTab) { if (o instanceof CTPTab) {
text.append("\t"); text.append("\t");
} }
if (o instanceof CTBr) { if (o instanceof CTBr) {
text.append("\n"); text.append("\n");
} }
if (o instanceof CTEmpty) { if (o instanceof CTEmpty) {
// Some inline text elements get returned not as // Some inline text elements get returned not as
// themselves, but as CTEmpty, owing to some odd // themselves, but as CTEmpty, owing to some odd
// definitions around line 5642 of the XSDs // definitions around line 5642 of the XSDs
// This bit works around it, and replicates the above // This bit works around it, and replicates the above
// rules for that case // rules for that case
String tagName = o.getDomNode().getNodeName(); String tagName = o.getDomNode().getNodeName();
if ("w:tab".equals(tagName)) { if ("w:tab".equals(tagName)) {
text.append("\t"); text.append("\t");
} }
if ("w:br".equals(tagName)) { if ("w:br".equals(tagName)) {
text.append("\n"); text.append("\n");
} }
if ("w:cr".equals(tagName)) { if ("w:cr".equals(tagName)) {
text.append("\n"); text.append("\n");
} }
} }
} }
c.dispose(); c.dispose();
// Any picture text? // Any picture text?
if(pictureText != null && pictureText.length() > 0) { if(pictureText != null && pictureText.length() > 0) {
text.append("\n").append(pictureText); text.append("\n").append(pictureText);
} }
return text.toString(); return text.toString();
} }
} }

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 { public XWPFSettings(PackagePart part, PackageRelationship rel) throws IOException {
super(part, rel); super(part, rel);
readFrom(part.getInputStream());
} }
public XWPFSettings() { public XWPFSettings() {
@ -50,6 +49,13 @@ public class XWPFSettings extends POIXMLDocumentPart {
ctSettings = CTSettings.Factory.newInstance(); ctSettings = CTSettings.Factory.newInstance();
} }
@Override
protected void onDocumentRead() throws IOException
{
super.onDocumentRead();
readFrom(getPackagePart().getInputStream());
}
/** /**
* Set zoom.<br/> * Set zoom.<br/>
* In the zoom tag inside settings.xml file <br/> * In the zoom tag inside settings.xml file <br/>

15
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.HashMap;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import java.lang.String;
import javax.xml.namespace.QName; import javax.xml.namespace.QName;
@ -49,11 +48,12 @@ import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTDocDefaults;
* *
*/ */
public class XWPFStyles extends POIXMLDocumentPart{ public class XWPFStyles extends POIXMLDocumentPart{
private CTStyles ctStyles;
protected XWPFLatentStyles latentStyles;
protected List<XWPFStyle> listStyle;
/** private List<XWPFStyle> listStyle = new ArrayList<XWPFStyle>();
private CTStyles ctStyles;
XWPFLatentStyles latentStyles;
/**
* Construct XWPFStyles from a package part * Construct XWPFStyles from a package part
* *
* @param part the package part holding the data of the styles, * @param part the package part holding the data of the styles,
@ -62,14 +62,12 @@ public class XWPFStyles extends POIXMLDocumentPart{
public XWPFStyles(PackagePart part, PackageRelationship rel) throws IOException, OpenXML4JException{ public XWPFStyles(PackagePart part, PackageRelationship rel) throws IOException, OpenXML4JException{
super(part, rel); super(part, rel);
onDocumentRead();
} }
/** /**
* Construct XWPFStyles from scratch for a new document. * Construct XWPFStyles from scratch for a new document.
*/ */
public XWPFStyles() { public XWPFStyles() {
listStyle = new ArrayList<XWPFStyle>();
} }
/** /**
@ -77,7 +75,6 @@ public class XWPFStyles extends POIXMLDocumentPart{
*/ */
@Override @Override
protected void onDocumentRead ()throws IOException{ protected void onDocumentRead ()throws IOException{
listStyle = new ArrayList<XWPFStyle>();
StylesDocument stylesDoc; StylesDocument stylesDoc;
try { try {
InputStream is = getPackagePart().getInputStream(); InputStream is = getPackagePart().getInputStream();
@ -98,7 +95,7 @@ public class XWPFStyles extends POIXMLDocumentPart{
protected void commit() throws IOException { protected void commit() throws IOException {
XmlOptions xmlOptions = new XmlOptions(DEFAULT_XML_OPTIONS); XmlOptions xmlOptions = new XmlOptions(DEFAULT_XML_OPTIONS);
xmlOptions.setSaveSyntheticDocumentElement(new QName(CTStyles.type.getName().getNamespaceURI(), "styles")); 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/officeDocument/2006/relationships", "r");
map.put("http://schemas.openxmlformats.org/wordprocessingml/2006/main", "w"); map.put("http://schemas.openxmlformats.org/wordprocessingml/2006/main", "w");
xmlOptions.setSaveSuggestedPrefixes(map); xmlOptions.setSaveSuggestedPrefixes(map);

60
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.ArrayList;
import java.util.List; import java.util.List;
import org.apache.poi.POIXMLDocumentPart;
import org.apache.poi.util.Internal; import org.apache.poi.util.Internal;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP; import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTRow; import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTRow;
@ -58,7 +59,6 @@ public class XWPFTable implements IBodyElement{
} }
} }
public XWPFTable(CTTbl table, IBody part){ public XWPFTable(CTTbl table, IBody part){
this.part = part; this.part = part;
this.ctTbl = table; this.ctTbl = table;
@ -131,17 +131,17 @@ public class XWPFTable implements IBodyElement{
return text.toString(); return text.toString();
} }
public void addNewRowBetween(int start, int end) { public void addNewRowBetween(int start, int end) {
// TODO // TODO
} }
/** /**
* add a new column for each row in this table * add a new column for each row in this table
*/ */
public void addNewCol() { public void addNewCol() {
if (ctTbl.sizeOfTrArray() == 0) createRow(); if (ctTbl.sizeOfTrArray() == 0) {
createRow();
}
for (int i = 0; i < ctTbl.sizeOfTrArray(); i++) { for (int i = 0; i < ctTbl.sizeOfTrArray(); i++) {
XWPFTableRow tabRow = new XWPFTableRow(ctTbl.getTrArray(i), this); XWPFTableRow tabRow = new XWPFTableRow(ctTbl.getTrArray(i), this);
tabRow.createCell(); tabRow.createCell();
@ -268,12 +268,12 @@ public class XWPFTable implements IBodyElement{
* @param pos position the Row in the Table * @param pos position the Row in the Table
*/ */
public boolean removeRow(int pos) throws IndexOutOfBoundsException { public boolean removeRow(int pos) throws IndexOutOfBoundsException {
if(pos > 0 && pos < tableRows.size()){ if (pos >= 0 && pos < tableRows.size()) {
ctTbl.removeTr(pos); ctTbl.removeTr(pos);
tableRows.remove(pos); tableRows.remove(pos);
return true; return true;
} }
return false; return false;
} }
public List<XWPFTableRow> getRows() { public List<XWPFTableRow> getRows() {
@ -289,26 +289,30 @@ public class XWPFTable implements IBodyElement{
return BodyElementType.TABLE; return BodyElementType.TABLE;
} }
@Override
public IBody getBody()
{
return part;
}
/** /**
* returns the part of the bodyElement * returns the part of the bodyElement
* @see org.apache.poi.xwpf.usermodel.IBody#getPart() * @see org.apache.poi.xwpf.usermodel.IBody#getPart()
*/ */
public IBody getPart() { public POIXMLDocumentPart getPart() {
if(part != null){ if(part != null){
return part.getPart(); return part.getPart();
} }
return null; return null;
} }
/**
/** * returns the partType of the bodyPart which owns the bodyElement
* returns the partType of the bodyPart which owns the bodyElement * @see org.apache.poi.xwpf.usermodel.IBody#getPartType()
* @see org.apache.poi.xwpf.usermodel.IBody#getPartType() */
*/ public BodyType getPartType() {
public BodyType getPartType() { return part.getPartType();
return ((IBody)part).getPartType(); }
}
/** /**
* returns the XWPFRow which belongs to the CTRow row * returns the XWPFRow which belongs to the CTRow row

19
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.Collections;
import java.util.List; import java.util.List;
import org.apache.poi.POIXMLDocumentPart;
import org.apache.poi.util.Internal; import org.apache.poi.util.Internal;
import org.apache.xmlbeans.XmlCursor; import org.apache.xmlbeans.XmlCursor;
import org.apache.xmlbeans.XmlObject; import org.apache.xmlbeans.XmlObject;
@ -248,16 +249,14 @@ public class XWPFTableCell implements IBody {
return null; return null;
} }
/**
* get the to which the TableCell belongs
*
/** * @see org.apache.poi.xwpf.usermodel.IBody#getPart()
* get the to which the TableCell belongs */
* @see org.apache.poi.xwpf.usermodel.IBody#getPart() public POIXMLDocumentPart getPart() {
*/ return tableRow.getTable().getPart();
public IBody 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 * @return the newly created XWPFTableCell
*/ */
public XWPFTableCell createCell() { public XWPFTableCell createCell() {
XWPFTableCell tableCell = new XWPFTableCell(ctRow.addNewTc(), this, table.getPart()); XWPFTableCell tableCell = new XWPFTableCell(ctRow.addNewTc(), this, table.getBody());
tableCells.add(tableCell); tableCells.add(tableCell);
return tableCell; return tableCell;
} }
@ -69,7 +69,7 @@ public class XWPFTableRow {
*/ */
public XWPFTableCell addNewTableCell(){ public XWPFTableCell addNewTableCell(){
CTTc cell = ctRow.addNewTc(); CTTc cell = ctRow.addNewTc();
XWPFTableCell tableCell = new XWPFTableCell(cell, this, table.getPart()); XWPFTableCell tableCell = new XWPFTableCell(cell, this, table.getBody());
tableCells.add(tableCell); tableCells.add(tableCell);
return tableCell; return tableCell;
} }
@ -123,7 +123,7 @@ public class XWPFTableRow {
if(tableCells == null){ if(tableCells == null){
List<XWPFTableCell> cells = new ArrayList<XWPFTableCell>(); List<XWPFTableCell> cells = new ArrayList<XWPFTableCell>();
for (CTTc tableCell : ctRow.getTcList()) { for (CTTc tableCell : ctRow.getTcList()) {
cells.add(new XWPFTableCell(tableCell, this, table.getPart())); cells.add(new XWPFTableCell(tableCell, this, table.getBody()));
} }
this.tableCells = cells; 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")) 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; 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 junit.framework.TestCase;
import org.apache.poi.POIXMLProperties.CoreProperties; import org.apache.poi.POIXMLProperties.CoreProperties;
import org.apache.poi.openxml4j.util.Nullable;
import org.apache.poi.xssf.XSSFTestDataSamples; import org.apache.poi.xssf.XSSFTestDataSamples;
import org.apache.poi.xssf.usermodel.XSSFWorkbook; import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import org.apache.poi.xwpf.XWPFTestDataSamples; import org.apache.poi.xwpf.XWPFTestDataSamples;
import org.apache.poi.xwpf.usermodel.XWPFDocument; import org.apache.poi.xwpf.usermodel.XWPFDocument;
import org.apache.poi.openxml4j.util.Nullable;
/** /**
* Test setting extended and custom OOXML properties * Test setting extended and custom OOXML properties
@ -35,7 +40,7 @@ public final class TestPOIXMLProperties extends TestCase {
private POIXMLProperties _props; private POIXMLProperties _props;
private CoreProperties _coreProperties; private CoreProperties _coreProperties;
public void setUp() { public void setUp() throws IOException {
XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("documentProperties.docx"); XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("documentProperties.docx");
_props = sampleDoc.getProperties(); _props = sampleDoc.getProperties();
_coreProperties = _props.getCoreProperties(); _coreProperties = _props.getCoreProperties();
@ -152,7 +157,7 @@ public final class TestPOIXMLProperties extends TestCase {
assertEquals("Hello World", title); assertEquals("Hello World", title);
} }
public void testTransitiveSetters() { public void testTransitiveSetters() throws IOException {
XWPFDocument doc = new XWPFDocument(); XWPFDocument doc = new XWPFDocument();
CoreProperties cp = doc.getProperties().getCoreProperties(); 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.io.OutputStream;
import java.lang.reflect.Field; import java.lang.reflect.Field;
import java.net.URI; import java.net.URI;
import java.util.TreeMap; import java.util.*;
import java.util.Iterator; import java.util.regex.Pattern;
import junit.framework.TestCase; import junit.framework.TestCase;
@ -509,4 +509,23 @@ public final class TestPackage extends TestCase {
f.setAccessible(true); f.setAccessible(true);
return (ContentTypeManager)f.get(pkg); 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.extractor.TestXWPFWordExtractor;
import org.apache.poi.xwpf.model.TestXWPFHeaderFooterPolicy; 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.TestXWPFHeader;
import org.apache.poi.xwpf.usermodel.TestXWPFHeadings; import org.apache.poi.xwpf.usermodel.TestXWPFHeadings;
import org.apache.poi.xwpf.usermodel.TestXWPFNumbering; 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; package org.apache.poi.xwpf;
import java.io.IOException;
import junit.framework.TestCase; import junit.framework.TestCase;
import org.apache.poi.POIXMLProperties.CoreProperties; 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 final class TestAllExtendedProperties extends TestCase {
public void testGetAllExtendedProperties() { public void testGetAllExtendedProperties() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("TestPoiXMLDocumentCorePropertiesGetKeywords.docx"); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("TestPoiXMLDocumentCorePropertiesGetKeywords.docx");
CTProperties ctProps = doc.getProperties().getExtendedProperties().getUnderlyingProperties(); CTProperties ctProps = doc.getProperties().getExtendedProperties().getUnderlyingProperties();
assertEquals("Microsoft Office Word",ctProps.getApplication()); 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; package org.apache.poi.xwpf;
import java.io.IOException;
import junit.framework.TestCase; import junit.framework.TestCase;
import org.apache.poi.POIXMLProperties.CoreProperties; import org.apache.poi.POIXMLProperties.CoreProperties;
@ -37,7 +39,7 @@ import org.apache.poi.xwpf.usermodel.XWPFDocument;
* *
*/ */
public final class TestPackageCorePropertiesGetKeywords extends TestCase { public final class TestPackageCorePropertiesGetKeywords extends TestCase {
public void testGetSetKeywords() { public void testGetSetKeywords() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("TestPoiXMLDocumentCorePropertiesGetKeywords.docx"); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("TestPoiXMLDocumentCorePropertiesGetKeywords.docx");
String keywords = doc.getProperties().getCoreProperties().getKeywords(); String keywords = doc.getProperties().getCoreProperties().getKeywords();
assertEquals("extractor, test, rdf", keywords); assertEquals("extractor, test, rdf", keywords);

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

@ -22,6 +22,8 @@ import java.io.IOException;
import java.io.InputStream; import java.io.InputStream;
import org.apache.poi.POIDataSamples; import org.apache.poi.POIDataSamples;
import org.apache.poi.util.IOUtils;
import org.apache.poi.util.PackageHelper;
import org.apache.poi.xwpf.usermodel.XWPFDocument; import org.apache.poi.xwpf.usermodel.XWPFDocument;
/** /**
@ -29,23 +31,21 @@ import org.apache.poi.xwpf.usermodel.XWPFDocument;
*/ */
public class XWPFTestDataSamples { public class XWPFTestDataSamples {
public static XWPFDocument openSampleDocument(String sampleName) { public static XWPFDocument openSampleDocument(String sampleName) throws IOException {
InputStream is = POIDataSamples.getDocumentInstance().openResourceAsStream(sampleName); InputStream is = POIDataSamples.getDocumentInstance().openResourceAsStream(sampleName);
try { return new XWPFDocument(is);
return new XWPFDocument(is);
} catch (IOException e) {
throw new RuntimeException(e);
}
} }
public static XWPFDocument writeOutAndReadBack(XWPFDocument doc) { public static XWPFDocument writeOutAndReadBack(XWPFDocument doc) throws IOException {
try { ByteArrayOutputStream baos = new ByteArrayOutputStream(4096);
ByteArrayOutputStream baos = new ByteArrayOutputStream(4096); doc.write(baos);
doc.write(baos); ByteArrayInputStream bais = new ByteArrayInputStream(baos.toByteArray());
ByteArrayInputStream bais = new ByteArrayInputStream(baos.toByteArray()); return new XWPFDocument(bais);
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; package org.apache.poi.xwpf.extractor;
import java.io.IOException;
import junit.framework.TestCase; import junit.framework.TestCase;
import org.apache.poi.xwpf.XWPFTestDataSamples; import org.apache.poi.xwpf.XWPFTestDataSamples;
@ -29,8 +31,9 @@ public class TestXWPFWordExtractor extends TestCase {
/** /**
* Get text out of the simple file * Get text out of the simple file
* @throws IOException
*/ */
public void testGetSimpleText() { public void testGetSimpleText() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("sample.docx"); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("sample.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc); XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
@ -58,8 +61,9 @@ public class TestXWPFWordExtractor extends TestCase {
/** /**
* Tests getting the text out of a complex file * 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"); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("IllustrativeCases.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc); XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
@ -91,7 +95,7 @@ public class TestXWPFWordExtractor extends TestCase {
assertEquals(134, ps); assertEquals(134, ps);
} }
public void testGetWithHyperlinks() { public void testGetWithHyperlinks() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("TestDocument.docx"); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("TestDocument.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc); 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"); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("ThreeColHeadFoot.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc); 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"); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("footnotes.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc); 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"); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("table_footnotes.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc); XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
assertTrue(extractor.getText().contains("snoska")); assertTrue(extractor.getText().contains("snoska"));
} }
public void testFormFootnotes() { public void testFormFootnotes() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("form_footnotes.docx"); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("form_footnotes.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc); 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")); 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"); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("endnotes.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc); XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
assertTrue(extractor.getText().contains("XXX")); assertTrue(extractor.getText().contains("XXX"));
} }
public void testInsertedDeletedText() { public void testInsertedDeletedText() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("delins.docx"); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("delins.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc); XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
@ -198,7 +202,7 @@ public class TestXWPFWordExtractor extends TestCase {
assertTrue(extractor.getText().contains("extremely well")); assertTrue(extractor.getText().contains("extremely well"));
} }
public void testParagraphHeader() { public void testParagraphHeader() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("Headers.docx"); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("Headers.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc); XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
@ -210,8 +214,9 @@ public class TestXWPFWordExtractor extends TestCase {
/** /**
* Test that we can open and process .docm * Test that we can open and process .docm
* (macro enabled) docx files (bug #45690) * (macro enabled) docx files (bug #45690)
* @throws IOException
*/ */
public void testDOCMFiles() { public void testDOCMFiles() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("45690.docm"); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("45690.docm");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc); XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
@ -224,8 +229,9 @@ public class TestXWPFWordExtractor extends TestCase {
* Test that we handle things like tabs and * Test that we handle things like tabs and
* carriage returns properly in the text that * carriage returns properly in the text that
* we're extracting (bug #49189) * we're extracting (bug #49189)
* @throws IOException
*/ */
public void testDocTabs() { public void testDocTabs() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("WithTabs.docx"); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("WithTabs.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc); 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 * The output should not contain field codes, e.g. those specified in the
* w:instrText tag (spec sec. 17.16.23) * w:instrText tag (spec sec. 17.16.23)
* @throws IOException
*/ */
public void testNoFieldCodes() { public void testNoFieldCodes() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("FieldCodes.docx"); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("FieldCodes.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc); XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
String text = extractor.getText(); String text = extractor.getText();
@ -254,8 +261,9 @@ public class TestXWPFWordExtractor extends TestCase {
/** /**
* The output should contain the values of simple fields, those specified * The output should contain the values of simple fields, those specified
* with the fldSimple element (spec sec. 17.16.19) * 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"); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("FldSimple.docx");
XWPFWordExtractor extractor = new XWPFWordExtractor(doc); XWPFWordExtractor extractor = new XWPFWordExtractor(doc);
String text = extractor.getText(); String text = extractor.getText();

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

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

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

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

190
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. 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 java.util.List;
import junit.framework.TestCase; 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.exceptions.InvalidFormatException;
import org.apache.poi.openxml4j.opc.OPCPackage; import org.apache.poi.openxml4j.opc.OPCPackage;
import org.apache.poi.openxml4j.opc.PackagePart; import org.apache.poi.openxml4j.opc.PackagePart;
import org.apache.poi.xwpf.usermodel.XWPFDocument; import org.apache.poi.openxml4j.opc.PackagePartName;
import org.apache.poi.xwpf.usermodel.XWPFParagraph; import org.apache.poi.openxml4j.opc.PackageRelationship;
import org.apache.poi.xwpf.usermodel.XWPFPictureData; import org.apache.poi.openxml4j.opc.PackagingURIHelper;
import org.apache.poi.xwpf.usermodel.XWPFRelation; import org.apache.poi.openxml4j.opc.TargetMode;
import org.apache.poi.xwpf.XWPFTestDataSamples;
import org.apache.xmlbeans.XmlCursor; import org.apache.xmlbeans.XmlCursor;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP; import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP;
@ -70,7 +73,7 @@ public final class TestXWPFDocument extends TestCase {
assertNotNull(xml.getStyle()); assertNotNull(xml.getStyle());
} }
public void testMetadataBasics() { public void testMetadataBasics() throws IOException {
XWPFDocument xml = XWPFTestDataSamples.openSampleDocument("sample.docx"); XWPFDocument xml = XWPFTestDataSamples.openSampleDocument("sample.docx");
assertNotNull(xml.getProperties().getCoreProperties()); assertNotNull(xml.getProperties().getCoreProperties());
assertNotNull(xml.getProperties().getExtendedProperties()); assertNotNull(xml.getProperties().getExtendedProperties());
@ -83,7 +86,7 @@ public final class TestXWPFDocument extends TestCase {
assertEquals(null, xml.getProperties().getCoreProperties().getUnderlyingProperties().getSubjectProperty().getValue()); assertEquals(null, xml.getProperties().getCoreProperties().getUnderlyingProperties().getSubjectProperty().getValue());
} }
public void testMetadataComplex() { public void testMetadataComplex() throws IOException {
XWPFDocument xml = XWPFTestDataSamples.openSampleDocument("IllustrativeCases.docx"); XWPFDocument xml = XWPFTestDataSamples.openSampleDocument("IllustrativeCases.docx");
assertNotNull(xml.getProperties().getCoreProperties()); assertNotNull(xml.getProperties().getCoreProperties());
assertNotNull(xml.getProperties().getExtendedProperties()); assertNotNull(xml.getProperties().getExtendedProperties());
@ -103,7 +106,7 @@ public final class TestXWPFDocument extends TestCase {
assertEquals("Apache POI", props.getExtendedProperties().getUnderlyingProperties().getApplication()); assertEquals("Apache POI", props.getExtendedProperties().getUnderlyingProperties().getApplication());
} }
public void testAddParagraph(){ public void testAddParagraph() throws IOException{
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("sample.docx"); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("sample.docx");
assertEquals(3, doc.getParagraphs().size()); assertEquals(3, doc.getParagraphs().size());
@ -123,23 +126,21 @@ public final class TestXWPFDocument extends TestCase {
assertEquals(5, doc.getParagraphs().size()); 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(); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("sample.docx");
try { byte[] jpeg = XWPFTestDataSamples.getImage("nature1.jpg");
int jpegNum = doc.addPicture(jpeg, XWPFDocument.PICTURE_TYPE_JPEG); String relationId = doc.addPictureData(jpeg,XWPFDocument.PICTURE_TYPE_JPEG);
byte[] newJpeg = doc.getAllPictures().get(jpegNum).getData();
assertEquals(newJpeg.length, jpeg.length);
for(int i = 0 ; i < jpeg.length; i++){
assertEquals(newJpeg[i], jpeg[i]);
}
} catch (InvalidFormatException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
public void testRemoveBodyElement() { byte[] newJpeg = ((XWPFPictureData) doc.getRelationById(relationId)).getData();
assertEquals(newJpeg.length,jpeg.length);
for (int i = 0 ; i < jpeg.length ; i++)
{
assertEquals(newJpeg[i],jpeg[i]);
}
}
public void testRemoveBodyElement() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("sample.docx"); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("sample.docx");
assertEquals(3, doc.getParagraphs().size()); assertEquals(3, doc.getParagraphs().size());
assertEquals(3, doc.getBodyElements().size()); assertEquals(3, doc.getBodyElements().size());
@ -200,46 +201,119 @@ public final class TestXWPFDocument extends TestCase {
assertEquals(p3, doc.getParagraphs().get(0)); assertEquals(p3, doc.getParagraphs().get(0));
} }
public void testSettings() throws Exception { public void testRegisterPackagePictureData() throws IOException, InvalidFormatException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("WithGIF.docx"); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("issue_51265_1.docx");
assertEquals(120, doc.getZoomPercent());
assertEquals(false, doc.isEnforcedCommentsProtection());
assertEquals(false, doc.isEnforcedFillingFormsProtection());
assertEquals(false, doc.isEnforcedReadonlyProtection());
assertEquals(false, doc.isEnforcedTrackedChangesProtection());
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! assertFalse(xwpfHeader.getAllPictures().contains(newPicData));
doc.enforceFillingFormsProtection(); assertFalse(doc.getAllPictures().contains(newPicData));
doc.enforceReadonlyProtection(); assertFalse(doc.getAllPackagePictures().contains(newPicData));
doc = XWPFTestDataSamples.writeOutAndReadBack(doc); doc.registerPackagePictureData(newPicData);
assertEquals(124, doc.getZoomPercent()); assertFalse(xwpfHeader.getAllPictures().contains(newPicData));
assertEquals(false, doc.isEnforcedCommentsProtection()); assertFalse(doc.getAllPictures().contains(newPicData));
assertEquals(false, doc.isEnforcedFillingFormsProtection()); assertTrue(doc.getAllPackagePictures().contains(newPicData));
assertEquals(true, doc.isEnforcedReadonlyProtection());
assertEquals(false, doc.isEnforcedTrackedChangesProtection()); doc.getPackage().revert();
} }
public void testGIFSupport() throws Exception { public void testFindPackagePictureData() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("WithGIF.docx"); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("issue_51265_1.docx");
ArrayList<PackagePart> gifParts = doc.getPackage().getPartsByContentType(XWPFRelation.IMAGE_GIF.getContentType()); byte[] nature1 = XWPFTestDataSamples.getImage("nature1.gif");
assertEquals("Expected exactly one GIF part in package.",1,gifParts.size()); XWPFPictureData part = doc.findPackagePictureData(nature1, Document.PICTURE_TYPE_GIF);
PackagePart gifPart = gifParts.get(0); assertNotNull(part);
assertTrue(doc.getAllPictures().contains(part));
assertTrue(doc.getAllPackagePictures().contains(part));
doc.getPackage().revert();
}
List<POIXMLDocumentPart> relations = doc.getRelations(); public void testGetAllPictures() throws IOException {
POIXMLDocumentPart gifDocPart = null; XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("issue_51265_3.docx");
for (POIXMLDocumentPart docPart : relations) List<XWPFPictureData> allPictures = doc.getAllPictures();
{ List<XWPFPictureData> allPackagePictures = doc.getAllPackagePictures();
if (gifPart == docPart.getPackagePart())
{ assertNotNull(allPictures);
assertNull("More than one POIXMLDocumentPart for GIF PackagePart.",gifDocPart); assertEquals(3,allPictures.size());
gifDocPart = docPart; for (XWPFPictureData xwpfPictureData : allPictures) {
} assertTrue(allPackagePictures.contains(xwpfPictureData));
} }
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)); 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 final class TestXWPFHeader extends TestCase {
public void testSimpleHeader() { public void testSimpleHeader() throws IOException {
XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("headerFooter.docx"); XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("headerFooter.docx");
XWPFHeaderFooterPolicy policy = sampleDoc.getHeaderFooterPolicy(); XWPFHeaderFooterPolicy policy = sampleDoc.getHeaderFooterPolicy();
@ -40,7 +40,7 @@ public final class TestXWPFHeader extends TestCase {
assertNotNull(footer); assertNotNull(footer);
} }
public void testImageInHeader() { public void testImageInHeader() throws IOException {
XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("headerPic.docx"); XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("headerPic.docx");
XWPFHeaderFooterPolicy policy = sampleDoc.getHeaderFooterPolicy(); XWPFHeaderFooterPolicy policy = sampleDoc.getHeaderFooterPolicy();
@ -122,7 +122,7 @@ public final class TestXWPFHeader extends TestCase {
assertEquals("Second paragraph for the footer", paras[1].getText()); assertEquals("Second paragraph for the footer", paras[1].getText());
} }
public void testSetWatermark() { public void testSetWatermark() throws IOException {
XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("SampleDoc.docx"); XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("SampleDoc.docx");
// no header is set (yet) // no header is set (yet)
XWPFHeaderFooterPolicy policy = sampleDoc.getHeaderFooterPolicy(); XWPFHeaderFooterPolicy policy = sampleDoc.getHeaderFooterPolicy();
@ -136,4 +136,20 @@ public final class TestXWPFHeader extends TestCase {
assertNotNull(policy.getFirstPageHeader()); assertNotNull(policy.getFirstPageHeader());
assertNotNull(policy.getEvenPageHeader()); 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; package org.apache.poi.xwpf.usermodel;
import java.io.IOException;
import java.math.BigInteger; import java.math.BigInteger;
import junit.framework.TestCase; import junit.framework.TestCase;
@ -25,7 +26,7 @@ import org.apache.poi.xwpf.XWPFTestDataSamples;
public class TestXWPFNumbering extends TestCase { public class TestXWPFNumbering extends TestCase {
public void testCompareAbstractNum(){ public void testCompareAbstractNum() throws IOException{
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("Numbering.docx"); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("Numbering.docx");
XWPFNumbering numbering = doc.getNumbering(); XWPFNumbering numbering = doc.getNumbering();
BigInteger numId = BigInteger.valueOf(1); 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; package org.apache.poi.xwpf.usermodel;
import java.io.IOException;
import java.math.BigInteger; import java.math.BigInteger;
import java.util.List; import java.util.List;
@ -49,8 +50,9 @@ public final class TestXWPFParagraph extends TestCase {
/** /**
* Check that we get the right paragraph from the header * 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"); XWPFDocument xml = XWPFTestDataSamples.openSampleDocument("ThreeColHead.docx");
XWPFHeader hdr = xml.getHeaderFooterPolicy().getDefaultHeader(); 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 * 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"); XWPFDocument xml = XWPFTestDataSamples.openSampleDocument("ThreeColHead.docx");
List<XWPFParagraph> ps = xml.getParagraphs(); List<XWPFParagraph> ps = xml.getParagraphs();
assertEquals(10, ps.size()); assertEquals(10, ps.size());
@ -231,7 +234,7 @@ public final class TestXWPFParagraph extends TestCase {
assertEquals(STOnOff.TRUE, ppr.getPageBreakBefore().getVal()); assertEquals(STOnOff.TRUE, ppr.getPageBreakBefore().getVal());
} }
public void testBookmarks() { public void testBookmarks() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("bookmarks.docx"); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("bookmarks.docx");
XWPFParagraph paragraph = doc.getParagraphs().get(0); XWPFParagraph paragraph = doc.getParagraphs().get(0);
assertEquals("Sample Word Document", paragraph.getText()); assertEquals("Sample Word Document", paragraph.getText());

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

@ -17,6 +17,7 @@
package org.apache.poi.xwpf.usermodel; package org.apache.poi.xwpf.usermodel;
import java.io.IOException;
import java.util.Arrays; import java.util.Arrays;
import java.util.List; import java.util.List;
@ -29,98 +30,103 @@ import org.apache.poi.xwpf.XWPFTestDataSamples;
import org.apache.poi.xwpf.model.XWPFHeaderFooterPolicy; import org.apache.poi.xwpf.model.XWPFHeaderFooterPolicy;
public class TestXWPFPictureData extends TestCase { public class TestXWPFPictureData extends TestCase {
public void testRead(){
XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("VariousPictures.docx");
List<XWPFPictureData> pictures = sampleDoc.getAllPictures();
assertSame(pictures, sampleDoc.getAllPictures());
assertEquals(5, pictures.size()); public void testRead() throws InvalidFormatException, IOException
String[] ext = {"wmf", "png", "emf", "emf", "jpeg"}; {
for (int i = 0; i < pictures.size(); i++) { XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("VariousPictures.docx");
assertEquals(ext[i], pictures.get(i).suggestFileExtension()); List<XWPFPictureData> pictures = sampleDoc.getAllPictures();
}
int num = pictures.size(); assertEquals(5,pictures.size());
String[] ext = {"wmf","png","emf","emf","jpeg"};
byte[] pictureData = {0xA, 0xB, 0XC, 0xD, 0xE, 0xF}; for (int i = 0 ; i < pictures.size() ; i++)
{
int idx; assertEquals(ext[i],pictures.get(i).suggestFileExtension());
try {
idx = sampleDoc.addPicture(pictureData, XWPFDocument.PICTURE_TYPE_JPEG);
assertEquals(num + 1, pictures.size());
//idx is 0-based index in the #pictures array
assertEquals(pictures.size() - 1, idx);
XWPFPictureData pict = pictures.get(idx);
assertEquals("jpeg", pict.suggestFileExtension());
assertTrue(Arrays.equals(pictureData, pict.getData()));
} catch (InvalidFormatException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
public void testPictureInHeader() {
XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("headerPic.docx");
XWPFHeaderFooterPolicy policy = sampleDoc.getHeaderFooterPolicy();
XWPFHeader header = policy.getDefaultHeader();
List<XWPFPictureData> pictures = header.getAllPictures();
assertEquals(1, pictures.size());
} }
public void testNew() throws Exception { int num = pictures.size();
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("EmptyDocumentWithHeaderFooter.docx");
byte[] jpegData = "test jpeg data".getBytes();
byte[] wmfData = "test wmf data".getBytes();
byte[] pngData = "test png data".getBytes();
List<XWPFPictureData> pictures = doc.getAllPictures(); byte[] pictureData = XWPFTestDataSamples.getImage("nature1.jpg");
assertEquals(0, pictures.size());
// Document shouldn't have any image relationships String relationId = sampleDoc.addPictureData(pictureData,XWPFDocument.PICTURE_TYPE_JPEG);
assertEquals(13, doc.getPackagePart().getRelationships().size()); // picture list was updated
for(PackageRelationship rel : doc.getPackagePart().getRelationships()) { assertEquals(num + 1,pictures.size());
if(rel.getRelationshipType().equals(XSSFRelation.IMAGE_JPEG.getRelation())) { XWPFPictureData pict = (XWPFPictureData) sampleDoc.getRelationById(relationId);
fail("Shouldn't have JPEG yet"); assertEquals("jpeg",pict.suggestFileExtension());
} assertTrue(Arrays.equals(pictureData,pict.getData()));
} }
// Add the image public void testPictureInHeader() throws IOException
int jpegIdx; {
XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("headerPic.docx");
XWPFHeaderFooterPolicy policy = sampleDoc.getHeaderFooterPolicy();
jpegIdx = doc.addPicture(jpegData, XWPFDocument.PICTURE_TYPE_JPEG); XWPFHeader header = policy.getDefaultHeader();
assertEquals(1, pictures.size());
assertEquals("jpeg", pictures.get(jpegIdx).suggestFileExtension());
assertTrue(Arrays.equals(jpegData, pictures.get(jpegIdx).getData()));
// Ensure it now has one List<XWPFPictureData> pictures = header.getAllPictures();
assertEquals(14, doc.getPackagePart().getRelationships().size()); assertEquals(1,pictures.size());
PackageRelationship jpegRel = null; }
for(PackageRelationship rel : doc.getPackagePart().getRelationships()) {
if(rel.getRelationshipType().equals(XWPFRelation.IMAGE_JPEG.getRelation())) { public void testNew() throws InvalidFormatException, IOException
if(jpegRel != null) {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("EmptyDocumentWithHeaderFooter.docx");
byte[] jpegData = XWPFTestDataSamples.getImage("nature1.jpg");
byte[] gifData = XWPFTestDataSamples.getImage("nature1.gif");
byte[] pngData = XWPFTestDataSamples.getImage("nature1.png");
List<XWPFPictureData> pictures = doc.getAllPictures();
assertEquals(0,pictures.size());
// Document shouldn't have any image relationships
assertEquals(13,doc.getPackagePart().getRelationships().size());
for (PackageRelationship rel : doc.getPackagePart().getRelationships())
{
if (rel.getRelationshipType().equals(XSSFRelation.IMAGE_JPEG.getRelation()))
{
fail("Shouldn't have JPEG yet");
}
}
// Add the image
String relationId = doc.addPictureData(jpegData,XWPFDocument.PICTURE_TYPE_JPEG);
assertEquals(1,pictures.size());
XWPFPictureData jpgPicData = (XWPFPictureData) doc.getRelationById(relationId);
assertEquals("jpeg",jpgPicData.suggestFileExtension());
assertTrue(Arrays.equals(jpegData,jpgPicData.getData()));
// Ensure it now has one
assertEquals(14,doc.getPackagePart().getRelationships().size());
PackageRelationship jpegRel = null;
for (PackageRelationship rel : doc.getPackagePart().getRelationships())
{
if (rel.getRelationshipType().equals(XWPFRelation.IMAGE_JPEG.getRelation()))
{
if (jpegRel != null)
fail("Found 2 jpegs!"); fail("Found 2 jpegs!");
jpegRel = rel; jpegRel = rel;
} }
} }
assertNotNull("JPEG Relationship not found", jpegRel); assertNotNull("JPEG Relationship not found",jpegRel);
// Check the details // Check the details
assertEquals(XWPFRelation.IMAGE_JPEG.getRelation(), jpegRel.getRelationshipType()); assertEquals(XWPFRelation.IMAGE_JPEG.getRelation(),jpegRel.getRelationshipType());
assertEquals("/word/document.xml", jpegRel.getSource().getPartName().toString()); assertEquals("/word/document.xml",jpegRel.getSource().getPartName().toString());
assertEquals("/word/media/image1.jpeg", jpegRel.getTargetURI().getPath()); assertEquals("/word/media/image1.jpeg",jpegRel.getTargetURI().getPath());
XWPFPictureData pictureDataByID = doc.getPictureDataByID(jpegRel.getId()); XWPFPictureData pictureDataByID = doc.getPictureDataByID(jpegRel.getId());
byte [] newJPEGData = pictureDataByID.getData(); byte[] newJPEGData = pictureDataByID.getData();
assertEquals(newJPEGData.length, jpegData.length); 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]); {
} assertEquals(newJPEGData[i],jpegData[i]);
}
// Save an re-load, check it appears // Save an re-load, check it appears
doc = XWPFTestDataSamples.writeOutAndReadBack(doc); doc = XWPFTestDataSamples.writeOutAndReadBack(doc);
assertEquals(1, doc.getAllPictures().size()); assertEquals(1,doc.getAllPictures().size());
assertEquals(1, doc.getAllPackagePictures().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; package org.apache.poi.xwpf.usermodel;
import java.io.ByteArrayInputStream; import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.math.BigInteger; import java.math.BigInteger;
import java.util.List; import java.util.List;
@ -198,8 +199,9 @@ public class TestXWPFRun extends TestCase {
/** /**
* Test that on an existing document, we do the * Test that on an existing document, we do the
* right thing with it * right thing with it
* @throws IOException
*/ */
public void testExisting() { public void testExisting() throws IOException {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("TestDocument.docx"); XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("TestDocument.docx");
XWPFParagraph p; XWPFParagraph p;
XWPFRun run; XWPFRun run;
@ -330,7 +332,7 @@ public class TestXWPFRun extends TestCase {
assertEquals(null, run.getCTR().getRPr()); assertEquals(null, run.getCTR().getRPr());
} }
public void testPictureInHeader() { public void testPictureInHeader() throws IOException {
XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("headerPic.docx"); XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("headerPic.docx");
XWPFHeaderFooterPolicy policy = sampleDoc.getHeaderFooterPolicy(); 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; package org.apache.poi.xwpf.usermodel;
import java.io.IOException;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
@ -30,7 +31,7 @@ public class TestXWPFStyles extends TestCase {
// super.setUp(); // super.setUp();
// } // }
public void testGetUsedStyles(){ public void testGetUsedStyles() throws IOException{
XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("Styles.docx"); XWPFDocument sampleDoc = XWPFTestDataSamples.openSampleDocument("Styles.docx");
List<XWPFStyle> testUsedStyleList = new ArrayList<XWPFStyle>(); List<XWPFStyle> testUsedStyleList = new ArrayList<XWPFStyle>();
XWPFStyles styles = sampleDoc.getStyles(); 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