moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

Fix inconsistent whitespace and indents

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1749530 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Nick Burch 2016-06-21 14:34:12 +00:00
parent 631ca92c16
commit 4eb8175d88
3 changed files with 508 additions and 509 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

690
src/ooxml/java/org/apache/poi/POIXMLProperties.java
View File

@ -45,114 +45,114 @@ import org.openxmlformats.schemas.officeDocument.x2006.customProperties.CTProper
* as well Thumbnails. * as well Thumbnails.
*/ */
public class POIXMLProperties { public class POIXMLProperties {
private OPCPackage pkg; private OPCPackage pkg;
private CoreProperties core; private CoreProperties core;
private ExtendedProperties ext; private ExtendedProperties ext;
private CustomProperties cust; private CustomProperties cust;
private PackagePart extPart; private PackagePart extPart;
private PackagePart custPart; private PackagePart custPart;
private static final org.openxmlformats.schemas.officeDocument.x2006.extendedProperties.PropertiesDocument NEW_EXT_INSTANCE; private static final org.openxmlformats.schemas.officeDocument.x2006.extendedProperties.PropertiesDocument NEW_EXT_INSTANCE;
private static final org.openxmlformats.schemas.officeDocument.x2006.customProperties.PropertiesDocument NEW_CUST_INSTANCE; private static final org.openxmlformats.schemas.officeDocument.x2006.customProperties.PropertiesDocument NEW_CUST_INSTANCE;
static { static {
NEW_EXT_INSTANCE = org.openxmlformats.schemas.officeDocument.x2006.extendedProperties.PropertiesDocument.Factory.newInstance(); NEW_EXT_INSTANCE = org.openxmlformats.schemas.officeDocument.x2006.extendedProperties.PropertiesDocument.Factory.newInstance();
NEW_EXT_INSTANCE.addNewProperties(); NEW_EXT_INSTANCE.addNewProperties();
NEW_CUST_INSTANCE = org.openxmlformats.schemas.officeDocument.x2006.customProperties.PropertiesDocument.Factory.newInstance(); NEW_CUST_INSTANCE = org.openxmlformats.schemas.officeDocument.x2006.customProperties.PropertiesDocument.Factory.newInstance();
NEW_CUST_INSTANCE.addNewProperties(); NEW_CUST_INSTANCE.addNewProperties();
} }
public POIXMLProperties(OPCPackage docPackage) throws IOException, OpenXML4JException, XmlException { public POIXMLProperties(OPCPackage docPackage) throws IOException, OpenXML4JException, XmlException {
this.pkg = docPackage; this.pkg = docPackage;
// Core properties // Core properties
core = new CoreProperties((PackagePropertiesPart)pkg.getPackageProperties() ); core = new CoreProperties((PackagePropertiesPart)pkg.getPackageProperties() );
// Extended properties // Extended properties
PackageRelationshipCollection extRel = PackageRelationshipCollection extRel =
pkg.getRelationshipsByType(PackageRelationshipTypes.EXTENDED_PROPERTIES); pkg.getRelationshipsByType(PackageRelationshipTypes.EXTENDED_PROPERTIES);
if(extRel.size() == 1) { if(extRel.size() == 1) {
extPart = pkg.getPart( extRel.getRelationship(0)); extPart = pkg.getPart( extRel.getRelationship(0));
org.openxmlformats.schemas.officeDocument.x2006.extendedProperties.PropertiesDocument props = org.openxmlformats.schemas.officeDocument.x2006.extendedProperties.PropertiesDocument.Factory.parse( org.openxmlformats.schemas.officeDocument.x2006.extendedProperties.PropertiesDocument props = org.openxmlformats.schemas.officeDocument.x2006.extendedProperties.PropertiesDocument.Factory.parse(
extPart.getInputStream(), DEFAULT_XML_OPTIONS extPart.getInputStream(), DEFAULT_XML_OPTIONS
); );
ext = new ExtendedProperties(props); ext = new ExtendedProperties(props);
} else { } else {
extPart = null; extPart = null;
ext = new ExtendedProperties((org.openxmlformats.schemas.officeDocument.x2006.extendedProperties.PropertiesDocument)NEW_EXT_INSTANCE.copy()); ext = new ExtendedProperties((org.openxmlformats.schemas.officeDocument.x2006.extendedProperties.PropertiesDocument)NEW_EXT_INSTANCE.copy());
} }
// Custom properties // Custom properties
PackageRelationshipCollection custRel = PackageRelationshipCollection custRel =
pkg.getRelationshipsByType(PackageRelationshipTypes.CUSTOM_PROPERTIES); pkg.getRelationshipsByType(PackageRelationshipTypes.CUSTOM_PROPERTIES);
if(custRel.size() == 1) { if(custRel.size() == 1) {
custPart = pkg.getPart( custRel.getRelationship(0)); custPart = pkg.getPart( custRel.getRelationship(0));
org.openxmlformats.schemas.officeDocument.x2006.customProperties.PropertiesDocument props = org.openxmlformats.schemas.officeDocument.x2006.customProperties.PropertiesDocument.Factory.parse( org.openxmlformats.schemas.officeDocument.x2006.customProperties.PropertiesDocument props = org.openxmlformats.schemas.officeDocument.x2006.customProperties.PropertiesDocument.Factory.parse(
custPart.getInputStream(), DEFAULT_XML_OPTIONS custPart.getInputStream(), DEFAULT_XML_OPTIONS
); );
cust = new CustomProperties(props); cust = new CustomProperties(props);
} else { } else {
custPart = null; custPart = null;
cust = new CustomProperties((org.openxmlformats.schemas.officeDocument.x2006.customProperties.PropertiesDocument)NEW_CUST_INSTANCE.copy()); cust = new CustomProperties((org.openxmlformats.schemas.officeDocument.x2006.customProperties.PropertiesDocument)NEW_CUST_INSTANCE.copy());
} }
} }
/** /**
* Returns the core document properties * Returns the core document properties
* *
* @return the core document properties * @return the core document properties
*/ */
public CoreProperties getCoreProperties() { public CoreProperties getCoreProperties() {
return core; return core;
} }
/** /**
* Returns the extended document properties * Returns the extended document properties
* *
* @return the extended document properties * @return the extended document properties
*/ */
public ExtendedProperties getExtendedProperties() { public ExtendedProperties getExtendedProperties() {
return ext; return ext;
} }
/** /**
* Returns the custom document properties * Returns the custom document properties
* *
* @return the custom document properties * @return the custom document properties
*/ */
public CustomProperties getCustomProperties() { public CustomProperties getCustomProperties() {
return cust; return cust;
} }
/** /**
* Returns the {@link PackagePart} for the Document * Returns the {@link PackagePart} for the Document
* Thumbnail, or <code>null</code> if there isn't one * Thumbnail, or <code>null</code> if there isn't one
* *
* @return The Document Thumbnail part or null * @return The Document Thumbnail part or null
*/ */
protected PackagePart getThumbnailPart() { protected PackagePart getThumbnailPart() {
PackageRelationshipCollection rels = PackageRelationshipCollection rels =
pkg.getRelationshipsByType(PackageRelationshipTypes.THUMBNAIL); pkg.getRelationshipsByType(PackageRelationshipTypes.THUMBNAIL);
if(rels.size() == 1) { if(rels.size() == 1) {
return pkg.getPart(rels.getRelationship(0)); return pkg.getPart(rels.getRelationship(0));
} }
return null; return null;
} }
/** /**
* Returns the name of the Document thumbnail, eg * Returns the name of the Document thumbnail, eg
* <code>thumbnail.jpeg</code>, or <code>null</code> if there * <code>thumbnail.jpeg</code>, or <code>null</code> if there
* isn't one. * isn't one.
* *
* @return The thumbnail filename, or null * @return The thumbnail filename, or null
*/ */
public String getThumbnailFilename() { public String getThumbnailFilename() {
PackagePart tPart = getThumbnailPart(); PackagePart tPart = getThumbnailPart();
if (tPart == null) return null; if (tPart == null) return null;
String name = tPart.getPartName().getName(); String name = tPart.getPartName().getName();
return name.substring(name.lastIndexOf('/')); return name.substring(name.lastIndexOf('/'));
} }
/** /**
* Returns the Document thumbnail image data, or * Returns the Document thumbnail image data, or
* <code>null</code> if there isn't one. * <code>null</code> if there isn't one.
@ -164,15 +164,15 @@ public class POIXMLProperties {
if (tPart == null) return null; if (tPart == null) return null;
return tPart.getInputStream(); return tPart.getInputStream();
} }
/** /**
* Sets the Thumbnail for the document, replacing any existing * Sets the Thumbnail for the document, replacing any existing
* one. * one.
* *
* @param name The filename for the thumbnail image, eg <code>thumbnail.jpg</code> * @param name The filename for the thumbnail image, eg <code>thumbnail.jpg</code>
* @param imageData The inputstream to read the thumbnail image from * @param imageData The inputstream to read the thumbnail image from
*/ */
public void setThumbnail(String filename, InputStream imageData) throws IOException { public void setThumbnail(String filename, InputStream imageData) throws IOException {
PackagePart tPart = getThumbnailPart(); PackagePart tPart = getThumbnailPart();
if (tPart == null) { if (tPart == null) {
// New thumbnail // New thumbnail
@ -182,173 +182,173 @@ public class POIXMLProperties {
String newType = ContentTypes.getContentTypeFromFileExtension(filename); String newType = ContentTypes.getContentTypeFromFileExtension(filename);
if (! newType.equals(tPart.getContentType())) { if (! newType.equals(tPart.getContentType())) {
throw new IllegalArgumentException("Can't set a Thumbnail of type " + throw new IllegalArgumentException("Can't set a Thumbnail of type " +
newType + " when existing one is of a different type " + newType + " when existing one is of a different type " +
tPart.getContentType()); tPart.getContentType());
} }
StreamHelper.copyStream(imageData, tPart.getOutputStream()); StreamHelper.copyStream(imageData, tPart.getOutputStream());
} }
} }
/** /**
* Commit changes to the underlying OPC package * Commit changes to the underlying OPC package
* *
* @throws IOException if the properties can't be saved * @throws IOException if the properties can't be saved
* @throws POIXMLException if the properties are erroneous * @throws POIXMLException if the properties are erroneous
*/ */
public void commit() throws IOException{ public void commit() throws IOException{
if(extPart == null && !NEW_EXT_INSTANCE.toString().equals(ext.props.toString())){ if(extPart == null && !NEW_EXT_INSTANCE.toString().equals(ext.props.toString())){
try { try {
PackagePartName prtname = PackagingURIHelper.createPartName("/docProps/app.xml"); PackagePartName prtname = PackagingURIHelper.createPartName("/docProps/app.xml");
pkg.addRelationship(prtname, TargetMode.INTERNAL, "http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties"); pkg.addRelationship(prtname, TargetMode.INTERNAL, "http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties");
extPart = pkg.createPart(prtname, "application/vnd.openxmlformats-officedocument.extended-properties+xml"); extPart = pkg.createPart(prtname, "application/vnd.openxmlformats-officedocument.extended-properties+xml");
} catch (InvalidFormatException e){ } catch (InvalidFormatException e){
throw new POIXMLException(e); throw new POIXMLException(e);
} }
} }
if(custPart == null && !NEW_CUST_INSTANCE.toString().equals(cust.props.toString())){ if(custPart == null && !NEW_CUST_INSTANCE.toString().equals(cust.props.toString())){
try { try {
PackagePartName prtname = PackagingURIHelper.createPartName("/docProps/custom.xml"); PackagePartName prtname = PackagingURIHelper.createPartName("/docProps/custom.xml");
pkg.addRelationship(prtname, TargetMode.INTERNAL, "http://schemas.openxmlformats.org/officeDocument/2006/relationships/custom-properties"); pkg.addRelationship(prtname, TargetMode.INTERNAL, "http://schemas.openxmlformats.org/officeDocument/2006/relationships/custom-properties");
custPart = pkg.createPart(prtname, "application/vnd.openxmlformats-officedocument.custom-properties+xml"); custPart = pkg.createPart(prtname, "application/vnd.openxmlformats-officedocument.custom-properties+xml");
} catch (InvalidFormatException e){ } catch (InvalidFormatException e){
throw new POIXMLException(e); throw new POIXMLException(e);
} }
} }
if(extPart != null){ if(extPart != null){
OutputStream out = extPart.getOutputStream(); OutputStream out = extPart.getOutputStream();
if (extPart.getSize() > 0) { if (extPart.getSize() > 0) {
extPart.clear(); extPart.clear();
} }
ext.props.save(out, DEFAULT_XML_OPTIONS); ext.props.save(out, DEFAULT_XML_OPTIONS);
out.close(); out.close();
} }
if(custPart != null){ if(custPart != null){
OutputStream out = custPart.getOutputStream(); OutputStream out = custPart.getOutputStream();
cust.props.save(out, DEFAULT_XML_OPTIONS); cust.props.save(out, DEFAULT_XML_OPTIONS);
out.close(); out.close();
} }
} }
/** /**
* The core document properties * The core document properties
*/ */
public static class CoreProperties { public static class CoreProperties {
private PackagePropertiesPart part; private PackagePropertiesPart part;
private CoreProperties(PackagePropertiesPart part) { private CoreProperties(PackagePropertiesPart part) {
this.part = part; this.part = part;
} }
public String getCategory() { public String getCategory() {
return part.getCategoryProperty().getValue(); return part.getCategoryProperty().getValue();
} }
public void setCategory(String category) { public void setCategory(String category) {
part.setCategoryProperty(category); part.setCategoryProperty(category);
} }
public String getContentStatus() { public String getContentStatus() {
return part.getContentStatusProperty().getValue(); return part.getContentStatusProperty().getValue();
} }
public void setContentStatus(String contentStatus) { public void setContentStatus(String contentStatus) {
part.setContentStatusProperty(contentStatus); part.setContentStatusProperty(contentStatus);
} }
public String getContentType() { public String getContentType() {
return part.getContentTypeProperty().getValue(); return part.getContentTypeProperty().getValue();
} }
public void setContentType(String contentType) { public void setContentType(String contentType) {
part.setContentTypeProperty(contentType); part.setContentTypeProperty(contentType);
} }
public Date getCreated() { public Date getCreated() {
return part.getCreatedProperty().getValue(); return part.getCreatedProperty().getValue();
} }
public void setCreated(Nullable<Date> date) { public void setCreated(Nullable<Date> date) {
part.setCreatedProperty(date); part.setCreatedProperty(date);
} }
public void setCreated(String date) { public void setCreated(String date) {
part.setCreatedProperty(date); part.setCreatedProperty(date);
} }
public String getCreator() { public String getCreator() {
return part.getCreatorProperty().getValue(); return part.getCreatorProperty().getValue();
} }
public void setCreator(String creator) { public void setCreator(String creator) {
part.setCreatorProperty(creator); part.setCreatorProperty(creator);
} }
public String getDescription() { public String getDescription() {
return part.getDescriptionProperty().getValue(); return part.getDescriptionProperty().getValue();
} }
public void setDescription(String description) { public void setDescription(String description) {
part.setDescriptionProperty(description); part.setDescriptionProperty(description);
} }
public String getIdentifier() { public String getIdentifier() {
return part.getIdentifierProperty().getValue(); return part.getIdentifierProperty().getValue();
} }
public void setIdentifier(String identifier) { public void setIdentifier(String identifier) {
part.setIdentifierProperty(identifier); part.setIdentifierProperty(identifier);
} }
public String getKeywords() { public String getKeywords() {
return part.getKeywordsProperty().getValue(); return part.getKeywordsProperty().getValue();
} }
public void setKeywords(String keywords) { public void setKeywords(String keywords) {
part.setKeywordsProperty(keywords); part.setKeywordsProperty(keywords);
} }
public Date getLastPrinted() { public Date getLastPrinted() {
return part.getLastPrintedProperty().getValue(); return part.getLastPrintedProperty().getValue();
} }
public void setLastPrinted(Nullable<Date> date) { public void setLastPrinted(Nullable<Date> date) {
part.setLastPrintedProperty(date); part.setLastPrintedProperty(date);
} }
public void setLastPrinted(String date) { public void setLastPrinted(String date) {
part.setLastPrintedProperty(date); part.setLastPrintedProperty(date);
} }
public Date getModified() { public Date getModified() {
return part.getModifiedProperty().getValue(); return part.getModifiedProperty().getValue();
} }
public void setModified(Nullable<Date> date) { public void setModified(Nullable<Date> date) {
part.setModifiedProperty(date); part.setModifiedProperty(date);
} }
public void setModified(String date) { public void setModified(String date) {
part.setModifiedProperty(date); part.setModifiedProperty(date);
} }
public String getSubject() { public String getSubject() {
return part.getSubjectProperty().getValue(); return part.getSubjectProperty().getValue();
} }
public void setSubjectProperty(String subject) { public void setSubjectProperty(String subject) {
part.setSubjectProperty(subject); part.setSubjectProperty(subject);
} }
public void setTitle(String title) { public void setTitle(String title) {
part.setTitleProperty(title); part.setTitleProperty(title);
} }
public String getTitle() { public String getTitle() {
return part.getTitleProperty().getValue(); return part.getTitleProperty().getValue();
} }
public String getRevision() { public String getRevision() {
return part.getRevisionProperty().getValue(); return part.getRevisionProperty().getValue();
} }
public void setRevision(String revision) { public void setRevision(String revision) {
try { try {
Long.valueOf(revision); Long.valueOf(revision);
part.setRevisionProperty(revision); part.setRevisionProperty(revision);
} }
catch (NumberFormatException e) {} catch (NumberFormatException e) {}
} }
public PackagePropertiesPart getUnderlyingProperties() { public PackagePropertiesPart getUnderlyingProperties() {
return part; return part;
} }
} }
/** /**
* Extended document properties * Extended document properties
*/ */
public static class ExtendedProperties { public static class ExtendedProperties {
private org.openxmlformats.schemas.officeDocument.x2006.extendedProperties.PropertiesDocument props; private org.openxmlformats.schemas.officeDocument.x2006.extendedProperties.PropertiesDocument props;
private ExtendedProperties(org.openxmlformats.schemas.officeDocument.x2006.extendedProperties.PropertiesDocument props) { private ExtendedProperties(org.openxmlformats.schemas.officeDocument.x2006.extendedProperties.PropertiesDocument props) {
this.props = props; this.props = props;
} }
public org.openxmlformats.schemas.officeDocument.x2006.extendedProperties.CTProperties getUnderlyingProperties() {
return props.getProperties();
}
public org.openxmlformats.schemas.officeDocument.x2006.extendedProperties.CTProperties getUnderlyingProperties() {
return props.getProperties();
}
public String getTemplate() { public String getTemplate() {
if (props.getProperties().isSetTemplate()) { if (props.getProperties().isSetTemplate()) {
return props.getProperties().getTemplate(); return props.getProperties().getTemplate();
@ -459,113 +459,113 @@ public class POIXMLProperties {
} }
return null; return null;
} }
} }
/** /**
* Custom document properties * Custom document properties
*/ */
public static class CustomProperties { public static class CustomProperties {
/** /**
* Each custom property element contains an fmtid attribute * Each custom property element contains an fmtid attribute
* with the same GUID value ({D5CDD505-2E9C-101B-9397-08002B2CF9AE}). * with the same GUID value ({D5CDD505-2E9C-101B-9397-08002B2CF9AE}).
*/ */
public static final String FORMAT_ID = "{D5CDD505-2E9C-101B-9397-08002B2CF9AE}"; public static final String FORMAT_ID = "{D5CDD505-2E9C-101B-9397-08002B2CF9AE}";
private org.openxmlformats.schemas.officeDocument.x2006.customProperties.PropertiesDocument props; private org.openxmlformats.schemas.officeDocument.x2006.customProperties.PropertiesDocument props;
private CustomProperties(org.openxmlformats.schemas.officeDocument.x2006.customProperties.PropertiesDocument props) { private CustomProperties(org.openxmlformats.schemas.officeDocument.x2006.customProperties.PropertiesDocument props) {
this.props = props; this.props = props;
} }
public org.openxmlformats.schemas.officeDocument.x2006.customProperties.CTProperties getUnderlyingProperties() { public org.openxmlformats.schemas.officeDocument.x2006.customProperties.CTProperties getUnderlyingProperties() {
return props.getProperties(); return props.getProperties();
} }
/** /**
* Add a new property * Add a new property
* *
* @param name the property name * @param name the property name
* @throws IllegalArgumentException if a property with this name already exists * @throws IllegalArgumentException if a property with this name already exists
*/ */
private CTProperty add(String name) { private CTProperty add(String name) {
if(contains(name)) { if(contains(name)) {
throw new IllegalArgumentException("A property with this name " + throw new IllegalArgumentException("A property with this name " +
"already exists in the custom properties"); "already exists in the custom properties");
} }
CTProperty p = props.getProperties().addNewProperty(); CTProperty p = props.getProperties().addNewProperty();
int pid = nextPid(); int pid = nextPid();
p.setPid(pid); p.setPid(pid);
p.setFmtid(FORMAT_ID); p.setFmtid(FORMAT_ID);
p.setName(name); p.setName(name);
return p; return p;
} }
/** /**
* Add a new string property * Add a new string property
* *
* @param name the property name
* @param value the property value
*
* @throws IllegalArgumentException if a property with this name already exists
*/
public void addProperty(String name, String value){
CTProperty p = add(name);
p.setLpwstr(value);
}
/**
* Add a new double property
*
* @param name the property name * @param name the property name
* @param value the property value * @param value the property value
* *
* @throws IllegalArgumentException if a property with this name already exists * @throws IllegalArgumentException if a property with this name already exists
*/ */
public void addProperty(String name, double value){ public void addProperty(String name, String value){
CTProperty p = add(name); CTProperty p = add(name);
p.setR8(value); p.setLpwstr(value);
} }
/** /**
* Add a new integer property * Add a new double property
* *
* @param name the property name * @param name the property name
* @param value the property value * @param value the property value
* *
* @throws IllegalArgumentException if a property with this name already exists * @throws IllegalArgumentException if a property with this name already exists
*/ */
public void addProperty(String name, int value){ public void addProperty(String name, double value){
CTProperty p = add(name); CTProperty p = add(name);
p.setI4(value); p.setR8(value);
} }
/** /**
* Add a new boolean property * Add a new integer property
* *
* @param name the property name * @param name the property name
* @param value the property value * @param value the property value
* *
* @throws IllegalArgumentException if a property with this name already exists * @throws IllegalArgumentException if a property with this name already exists
*/ */
public void addProperty(String name, boolean value){ public void addProperty(String name, int value){
CTProperty p = add(name); CTProperty p = add(name);
p.setBool(value); p.setI4(value);
} }
/** /**
* Generate next id that uniquely relates a custom property * Add a new boolean property
* *
* @return next property id starting with 2 * @param name the property name
*/ * @param value the property value
*
* @throws IllegalArgumentException if a property with this name already exists
*/
public void addProperty(String name, boolean value){
CTProperty p = add(name);
p.setBool(value);
}
/**
* Generate next id that uniquely relates a custom property
*
* @return next property id starting with 2
*/
protected int nextPid() { protected int nextPid() {
int propid = 1; int propid = 1;
for(CTProperty p : props.getProperties().getPropertyArray()){ for(CTProperty p : props.getProperties().getPropertyArray()){
if(p.getPid() > propid) propid = p.getPid(); if(p.getPid() > propid) propid = p.getPid();
} }
return propid + 1; return propid + 1;
} }
/** /**
* Check if a property with this name already exists in the collection of custom properties * Check if a property with this name already exists in the collection of custom properties
* *
* @param name the name to check * @param name the name to check
@ -577,7 +577,7 @@ public class POIXMLProperties {
} }
return false; return false;
} }
/** /**
* Retrieve the custom property with this name, or null if none exists. * Retrieve the custom property with this name, or null if none exists.
* *

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

@ -461,32 +461,32 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
this.contentTypeManager.clearAll(); this.contentTypeManager.clearAll();
} }
/** /**
* Close the package WITHOUT saving its content. Reinitialize this package * Close the package WITHOUT saving its content. Reinitialize this package
* and cancel all changes done to it. * and cancel all changes done to it.
*/ */
public void revert() { public void revert() {
revertImpl(); revertImpl();
} }
/** /**
* Add a thumbnail to the package. This method is provided to make easier * Add a thumbnail to the package. This method is provided to make easier
* the addition of a thumbnail in a package. You can do the same work by * the addition of a thumbnail in a package. You can do the same work by
* using the traditionnal relationship and part mechanism. * using the traditionnal relationship and part mechanism.
* *
* @param path The full path to the image file. * @param path The full path to the image file.
*/ */
public void addThumbnail(String path) throws IOException { public void addThumbnail(String path) throws IOException {
// Check parameter // Check parameter
if (path == null || path.isEmpty()) { if (path == null || path.isEmpty()) {
throw new IllegalArgumentException("path"); throw new IllegalArgumentException("path");
} }
String name = path.substring(path.lastIndexOf(File.separatorChar) + 1); String name = path.substring(path.lastIndexOf(File.separatorChar) + 1);
FileInputStream is = new FileInputStream(path); FileInputStream is = new FileInputStream(path);
addThumbnail(name, is); addThumbnail(name, is);
is.close(); is.close();
} }
/** /**
* Add a thumbnail to the package. This method is provided to make easier * Add a thumbnail to the package. This method is provided to make easier
* the addition of a thumbnail in a package. You can do the same work by * the addition of a thumbnail in a package. You can do the same work by
@ -495,60 +495,60 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
* @param path The full path to the image file. * @param path The full path to the image file.
*/ */
public void addThumbnail(String filename, InputStream data) throws IOException { public void addThumbnail(String filename, InputStream data) throws IOException {
// Check parameter // Check parameter
if (filename == null || filename.isEmpty()) { if (filename == null || filename.isEmpty()) {
throw new IllegalArgumentException("filename"); throw new IllegalArgumentException("filename");
} }
// Create the thumbnail part name // Create the thumbnail part name
String contentType = ContentTypes String contentType = ContentTypes
.getContentTypeFromFileExtension(filename); .getContentTypeFromFileExtension(filename);
PackagePartName thumbnailPartName = null; PackagePartName thumbnailPartName = null;
try { try {
thumbnailPartName = PackagingURIHelper.createPartName("/docProps/" thumbnailPartName = PackagingURIHelper.createPartName("/docProps/"
+ filename); + filename);
} catch (InvalidFormatException e) { } catch (InvalidFormatException e) {
String partName = "/docProps/thumbnail" + String partName = "/docProps/thumbnail" +
filename.substring(filename.lastIndexOf(".") + 1); filename.substring(filename.lastIndexOf(".") + 1);
try { try {
thumbnailPartName = PackagingURIHelper.createPartName(partName); thumbnailPartName = PackagingURIHelper.createPartName(partName);
} catch (InvalidFormatException e2) { } catch (InvalidFormatException e2) {
throw new InvalidOperationException( throw new InvalidOperationException(
"Can't add a thumbnail file named '" + filename + "'", e2); "Can't add a thumbnail file named '" + filename + "'", e2);
} }
} }
// Check if part already exist // Check if part already exist
if (this.getPart(thumbnailPartName) != null) if (this.getPart(thumbnailPartName) != null)
throw new InvalidOperationException( throw new InvalidOperationException(
"You already add a thumbnail named '" + filename + "'"); "You already add a thumbnail named '" + filename + "'");
// Add the thumbnail part to this package. // Add the thumbnail part to this package.
PackagePart thumbnailPart = this.createPart(thumbnailPartName, PackagePart thumbnailPart = this.createPart(thumbnailPartName,
contentType, false); contentType, false);
// Add the relationship between the package and the thumbnail part // Add the relationship between the package and the thumbnail part
this.addRelationship(thumbnailPartName, TargetMode.INTERNAL, this.addRelationship(thumbnailPartName, TargetMode.INTERNAL,
PackageRelationshipTypes.THUMBNAIL); PackageRelationshipTypes.THUMBNAIL);
// Copy file data to the newly created part // Copy file data to the newly created part
StreamHelper.copyStream(data, thumbnailPart.getOutputStream()); StreamHelper.copyStream(data, thumbnailPart.getOutputStream());
} }
/** /**
* Throws an exception if the package access mode is in read only mode * Throws an exception if the package access mode is in read only mode
* (PackageAccess.Read). * (PackageAccess.Read).
* *
* @throws InvalidOperationException * @throws InvalidOperationException
* Throws if a writing operation is done on a read only package. * Throws if a writing operation is done on a read only package.
* @see org.apache.poi.openxml4j.opc.PackageAccess * @see org.apache.poi.openxml4j.opc.PackageAccess
*/ */
void throwExceptionIfReadOnly() throws InvalidOperationException { void throwExceptionIfReadOnly() throws InvalidOperationException {
if (packageAccess == PackageAccess.READ) { if (packageAccess == PackageAccess.READ) {
throw new InvalidOperationException( throw new InvalidOperationException(
"Operation not allowed, document open in read only mode!"); "Operation not allowed, document open in read only mode!");
} }
} }
/** /**
* Throws an exception if the package access mode is in write only mode * Throws an exception if the package access mode is in write only mode

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

@ -45,74 +45,74 @@ import org.junit.Test;
public final class TestPOIXMLProperties { public final class TestPOIXMLProperties {
private XWPFDocument sampleDoc; private XWPFDocument sampleDoc;
private XWPFDocument sampleNoThumb; private XWPFDocument sampleNoThumb;
private POIXMLProperties _props; private POIXMLProperties _props;
private CoreProperties _coreProperties; private CoreProperties _coreProperties;
@Before @Before
public void setUp() throws IOException { public void setUp() throws IOException {
sampleDoc = XWPFTestDataSamples.openSampleDocument("documentProperties.docx"); sampleDoc = XWPFTestDataSamples.openSampleDocument("documentProperties.docx");
sampleNoThumb = XWPFTestDataSamples.openSampleDocument("SampleDoc.docx"); sampleNoThumb = XWPFTestDataSamples.openSampleDocument("SampleDoc.docx");
assertNotNull(sampleDoc); assertNotNull(sampleDoc);
assertNotNull(sampleNoThumb); assertNotNull(sampleNoThumb);
_props = sampleDoc.getProperties(); _props = sampleDoc.getProperties();
_coreProperties = _props.getCoreProperties(); _coreProperties = _props.getCoreProperties();
assertNotNull(_props); assertNotNull(_props);
} }
@After
public void closeResources() throws Exception {
sampleDoc.close();
sampleNoThumb.close();
}
@Test @After
public void testWorkbookExtendedProperties() throws Exception { public void closeResources() throws Exception {
XSSFWorkbook workbook = new XSSFWorkbook(); sampleDoc.close();
POIXMLProperties props = workbook.getProperties(); sampleNoThumb.close();
assertNotNull(props); }
org.apache.poi.POIXMLProperties.ExtendedProperties properties = @Test
props.getExtendedProperties(); public void testWorkbookExtendedProperties() throws Exception {
XSSFWorkbook workbook = new XSSFWorkbook();
POIXMLProperties props = workbook.getProperties();
assertNotNull(props);
org.openxmlformats.schemas.officeDocument.x2006.extendedProperties.CTProperties org.apache.poi.POIXMLProperties.ExtendedProperties properties =
ctProps = properties.getUnderlyingProperties(); props.getExtendedProperties();
org.openxmlformats.schemas.officeDocument.x2006.extendedProperties.CTProperties
ctProps = properties.getUnderlyingProperties();
String appVersion = "3.5 beta"; String appVersion = "3.5 beta";
String application = "POI"; String application = "POI";
ctProps.setApplication(application); ctProps.setApplication(application);
ctProps.setAppVersion(appVersion); ctProps.setAppVersion(appVersion);
XSSFWorkbook newWorkbook = XSSFWorkbook newWorkbook =
XSSFTestDataSamples.writeOutAndReadBack(workbook); XSSFTestDataSamples.writeOutAndReadBack(workbook);
workbook.close(); workbook.close();
assertTrue(workbook != newWorkbook); assertTrue(workbook != newWorkbook);
POIXMLProperties newProps = newWorkbook.getProperties(); POIXMLProperties newProps = newWorkbook.getProperties();
assertNotNull(newProps); assertNotNull(newProps);
org.apache.poi.POIXMLProperties.ExtendedProperties newProperties = org.apache.poi.POIXMLProperties.ExtendedProperties newProperties =
newProps.getExtendedProperties(); newProps.getExtendedProperties();
assertEquals(application, newProperties.getApplication()); assertEquals(application, newProperties.getApplication());
assertEquals(appVersion, newProperties.getAppVersion()); assertEquals(appVersion, newProperties.getAppVersion());
org.openxmlformats.schemas.officeDocument.x2006.extendedProperties.CTProperties
newCtProps = newProperties.getUnderlyingProperties();
assertEquals(application, newCtProps.getApplication()); org.openxmlformats.schemas.officeDocument.x2006.extendedProperties.CTProperties
assertEquals(appVersion, newCtProps.getAppVersion()); newCtProps = newProperties.getUnderlyingProperties();
newWorkbook.close(); assertEquals(application, newCtProps.getApplication());
} assertEquals(appVersion, newCtProps.getAppVersion());
newWorkbook.close();
}
/** /**
* Test usermodel API for setting custom properties * Test usermodel API for setting custom properties
*/ */
@Test @Test
public void testCustomProperties() throws Exception { public void testCustomProperties() throws Exception {
POIXMLDocument wb1 = new XSSFWorkbook(); POIXMLDocument wb1 = new XSSFWorkbook();
POIXMLProperties.CustomProperties customProps = wb1.getProperties().getCustomProperties(); POIXMLProperties.CustomProperties customProps = wb1.getProperties().getCustomProperties();
@ -162,27 +162,27 @@ public final class TestPOIXMLProperties {
wb2.close(); wb2.close();
} }
@Test @Test
public void testDocumentProperties() { public void testDocumentProperties() {
String category = _coreProperties.getCategory(); String category = _coreProperties.getCategory();
assertEquals("test", category); assertEquals("test", category);
String contentStatus = "Draft"; String contentStatus = "Draft";
_coreProperties.setContentStatus(contentStatus); _coreProperties.setContentStatus(contentStatus);
assertEquals("Draft", contentStatus); assertEquals("Draft", contentStatus);
Date created = _coreProperties.getCreated(); Date created = _coreProperties.getCreated();
// the original file contains a following value: 2009-07-20T13:12:00Z // the original file contains a following value: 2009-07-20T13:12:00Z
assertTrue(dateTimeEqualToUTCString(created, "2009-07-20T13:12:00Z")); assertTrue(dateTimeEqualToUTCString(created, "2009-07-20T13:12:00Z"));
String creator = _coreProperties.getCreator(); String creator = _coreProperties.getCreator();
assertEquals("Paolo Mottadelli", creator); assertEquals("Paolo Mottadelli", creator);
String subject = _coreProperties.getSubject(); String subject = _coreProperties.getSubject();
assertEquals("Greetings", subject); assertEquals("Greetings", subject);
String title = _coreProperties.getTitle(); String title = _coreProperties.getTitle();
assertEquals("Hello World", title); assertEquals("Hello World", title);
} }
@Test @Test
public void testTransitiveSetters() throws IOException { public void testTransitiveSetters() throws IOException {
XWPFDocument doc = new XWPFDocument(); XWPFDocument doc = new XWPFDocument();
CoreProperties cp = doc.getProperties().getCoreProperties(); CoreProperties cp = doc.getProperties().getCoreProperties();
@ -198,60 +198,59 @@ public final class TestPOIXMLProperties {
doc2.close(); doc2.close();
} }
@Test @Test
public void testGetSetRevision() { public void testGetSetRevision() {
String revision = _coreProperties.getRevision(); String revision = _coreProperties.getRevision();
assertTrue("Revision number is 1", Integer.parseInt(revision) > 1); assertTrue("Revision number is 1", Integer.parseInt(revision) > 1);
_coreProperties.setRevision("20"); _coreProperties.setRevision("20");
assertEquals("20", _coreProperties.getRevision()); assertEquals("20", _coreProperties.getRevision());
_coreProperties.setRevision("20xx"); _coreProperties.setRevision("20xx");
assertEquals("20", _coreProperties.getRevision()); assertEquals("20", _coreProperties.getRevision());
} }
public static boolean dateTimeEqualToUTCString(Date dateTime, String utcString) { public static boolean dateTimeEqualToUTCString(Date dateTime, String utcString) {
Calendar utcCalendar = LocaleUtil.getLocaleCalendar(LocaleUtil.TIMEZONE_UTC); Calendar utcCalendar = LocaleUtil.getLocaleCalendar(LocaleUtil.TIMEZONE_UTC);
utcCalendar.setTimeInMillis(dateTime.getTime()); utcCalendar.setTimeInMillis(dateTime.getTime());
String dateTimeUtcString = utcCalendar.get(Calendar.YEAR) + "-" + String dateTimeUtcString = utcCalendar.get(Calendar.YEAR) + "-" +
zeroPad((utcCalendar.get(Calendar.MONTH)+1)) + "-" + zeroPad((utcCalendar.get(Calendar.MONTH)+1)) + "-" +
zeroPad(utcCalendar.get(Calendar.DAY_OF_MONTH)) + "T" + zeroPad(utcCalendar.get(Calendar.DAY_OF_MONTH)) + "T" +
zeroPad(utcCalendar.get(Calendar.HOUR_OF_DAY)) + ":" + zeroPad(utcCalendar.get(Calendar.HOUR_OF_DAY)) + ":" +
zeroPad(utcCalendar.get(Calendar.MINUTE)) + ":" + zeroPad(utcCalendar.get(Calendar.MINUTE)) + ":" +
zeroPad(utcCalendar.get(Calendar.SECOND)) + "Z"; zeroPad(utcCalendar.get(Calendar.SECOND)) + "Z";
return utcString.equals(dateTimeUtcString); return utcString.equals(dateTimeUtcString);
} }
public void testThumbnails() throws Exception { public void testThumbnails() throws Exception {
POIXMLProperties noThumbProps = sampleNoThumb.getProperties(); POIXMLProperties noThumbProps = sampleNoThumb.getProperties();
assertNotNull(_props.getThumbnailPart()); assertNotNull(_props.getThumbnailPart());
assertNull(noThumbProps.getThumbnailPart()); assertNull(noThumbProps.getThumbnailPart());
assertNotNull(_props.getThumbnailFilename()); assertNotNull(_props.getThumbnailFilename());
assertNull(noThumbProps.getThumbnailFilename()); assertNull(noThumbProps.getThumbnailFilename());
assertNotNull(_props.getThumbnailImage()); assertNotNull(_props.getThumbnailImage());
assertNull(noThumbProps.getThumbnailImage()); assertNull(noThumbProps.getThumbnailImage());
assertEquals("thumbnail.jpeg", _props.getThumbnailFilename()); assertEquals("thumbnail.jpeg", _props.getThumbnailFilename());
// Adding / changing // Adding / changing
noThumbProps.setThumbnail("Testing.png", new ByteArrayInputStream(new byte[1])); noThumbProps.setThumbnail("Testing.png", new ByteArrayInputStream(new byte[1]));
assertNotNull(noThumbProps.getThumbnailPart()); assertNotNull(noThumbProps.getThumbnailPart());
assertEquals("Testing.png", noThumbProps.getThumbnailFilename()); assertEquals("Testing.png", noThumbProps.getThumbnailFilename());
assertNotNull(noThumbProps.getThumbnailImage()); assertNotNull(noThumbProps.getThumbnailImage());
assertEquals(1, noThumbProps.getThumbnailImage().available()); assertEquals(1, noThumbProps.getThumbnailImage().available());
noThumbProps.setThumbnail("Testing2.png", new ByteArrayInputStream(new byte[2])); noThumbProps.setThumbnail("Testing2.png", new ByteArrayInputStream(new byte[2]));
assertNotNull(noThumbProps.getThumbnailPart()); assertNotNull(noThumbProps.getThumbnailPart());
assertEquals("Testing.png", noThumbProps.getThumbnailFilename()); assertEquals("Testing.png", noThumbProps.getThumbnailFilename());
assertNotNull(noThumbProps.getThumbnailImage()); assertNotNull(noThumbProps.getThumbnailImage());
assertEquals(2, noThumbProps.getThumbnailImage().available()); assertEquals(2, noThumbProps.getThumbnailImage().available());
} }
private static String zeroPad(long i) { private static String zeroPad(long i) {
if (i >= 0 && i <=9) { if (i >= 0 && i <=9) {
return "0" + i; return "0" + i;
} else { } else {