org.apache.poi.xslf.usermodel.XSLFPictureData Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of poi-ooxml Show documentation
Show all versions of poi-ooxml Show documentation
Apache POI - Java API To Access Microsoft Format Files
/*
* ====================================================================
* 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.xslf.usermodel;
import java.awt.Dimension;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import org.apache.poi.ooxml.POIXMLDocumentPart;
import org.apache.poi.ooxml.POIXMLException;
import org.apache.poi.openxml4j.opc.PackagePart;
import org.apache.poi.sl.image.ImageHeaderBitmap;
import org.apache.poi.sl.image.ImageHeaderEMF;
import org.apache.poi.sl.image.ImageHeaderPICT;
import org.apache.poi.sl.image.ImageHeaderWMF;
import org.apache.poi.sl.usermodel.PictureData;
import org.apache.poi.util.Beta;
import org.apache.poi.util.IOUtils;
import org.apache.poi.util.LittleEndian;
import org.apache.poi.util.LittleEndianConsts;
import org.apache.poi.util.Units;
/**
* Instantiates sub-classes of POIXMLDocumentPart depending on their relationship type
*/
@Beta
public final class XSLFPictureData extends POIXMLDocumentPart implements PictureData {
private Long checksum;
// original image dimensions (for formats supported by BufferedImage)
private Dimension origSize;
private int index = -1;
/**
* Create a new XSLFGraphicData node
*/
protected XSLFPictureData() {
super();
}
/**
* Construct XSLFPictureData from a package part
*
* @param part the package part holding the drawing data
*
* @since POI 3.14-Beta1
*/
public XSLFPictureData(PackagePart part) {
super(part);
}
/**
* An InputStream to read the picture data directly
* from the underlying package part
*
* @return InputStream
*/
public InputStream getInputStream() throws IOException {
return getPackagePart().getInputStream();
}
/**
* Gets the picture data as a byte array.
*
* You can grab the picture data directly from the underlying package part with the {@link #getInputStream()} method
*
* @return the Picture data.
*/
public byte[] getData() {
try {
return IOUtils.toByteArray(getInputStream());
} catch (IOException e) {
throw new POIXMLException(e);
}
}
/**
* Returns the file name of the image, eg image7.jpg . The original filename
* isn't always available, but if it can be found it's likely to be in the
* CTDrawing
*/
public String getFileName() {
String name = getPackagePart().getPartName().getName();
return name.substring(name.lastIndexOf('/') + 1);
}
/**
* Suggests a file extension for this image.
*
* @return the file extension.
*/
public String suggestFileExtension() {
return getPackagePart().getPartName().getExtension();
}
@Override
public byte[] getChecksum() {
cacheProperties();
byte cs[] = new byte[LittleEndianConsts.LONG_SIZE];
LittleEndian.putLong(cs,0,checksum);
return cs;
}
@Override
public Dimension getImageDimension() {
cacheProperties();
return origSize;
}
@Override
public Dimension getImageDimensionInPixels() {
Dimension dim = getImageDimension();
return new Dimension(
Units.pointsToPixel(dim.getWidth()),
Units.pointsToPixel(dim.getHeight())
);
}
/**
* Determine and cache image properties
*/
protected void cacheProperties() {
if (origSize == null || checksum == null) {
byte data[] = getData();
checksum = IOUtils.calculateChecksum(data);
PictureType pt = getType();
if (pt == null) {
origSize = new Dimension(1,1);
return;
}
switch (pt) {
case EMF:
origSize = new ImageHeaderEMF(data, 0).getSize();
break;
case WMF:
// wmf files in pptx usually have their placeable header
// stripped away, so this returns only the dummy size
origSize = new ImageHeaderWMF(data, 0).getSize();
break;
case PICT:
origSize = new ImageHeaderPICT(data, 0).getSize();
break;
default:
origSize = new ImageHeaderBitmap(data, 0).getSize();
break;
}
}
}
/**
* *PictureData objects store the actual content in the part directly without keeping a
* copy like all others therefore we need to handle them differently.
*/
@Override
protected void prepareForCommit() {
// do not clear the part here
}
@Override
public String getContentType() {
return getPackagePart().getContentType();
}
public void setData(byte[] data) throws IOException {
OutputStream os = getPackagePart().getOutputStream();
os.write(data);
os.close();
// recalculate now since we already have the data bytes available anyhow
checksum = IOUtils.calculateChecksum(data);
origSize = null; // need to recalculate image size
}
@Override
public PictureType getType() {
String ct = getContentType();
if (XSLFRelation.IMAGE_EMF.getContentType().equals(ct)) {
return PictureType.EMF;
} else if (XSLFRelation.IMAGE_WMF.getContentType().equals(ct)) {
return PictureType.WMF;
} else if (XSLFRelation.IMAGE_PICT.getContentType().equals(ct)) {
return PictureType.PICT;
} else if (XSLFRelation.IMAGE_JPEG.getContentType().equals(ct)) {
return PictureType.JPEG;
} else if (XSLFRelation.IMAGE_PNG.getContentType().equals(ct)) {
return PictureType.PNG;
} else if (XSLFRelation.IMAGE_DIB.getContentType().equals(ct)) {
return PictureType.DIB;
} else if (XSLFRelation.IMAGE_GIF.getContentType().equals(ct)) {
return PictureType.GIF;
} else if (XSLFRelation.IMAGE_EPS.getContentType().equals(ct)) {
return PictureType.EPS;
} else if (XSLFRelation.IMAGE_BMP.getContentType().equals(ct)) {
return PictureType.BMP;
} else if (XSLFRelation.IMAGE_WPG.getContentType().equals(ct)) {
return PictureType.WPG;
} else if (XSLFRelation.IMAGE_WDP.getContentType().equals(ct)) {
return PictureType.WDP;
} else if (XSLFRelation.IMAGE_TIFF.getContentType().equals(ct)) {
return PictureType.TIFF;
} else {
return null;
}
}
/* package */ static XSLFRelation getRelationForType(PictureType pt) {
switch (pt) {
case EMF: return XSLFRelation.IMAGE_EMF;
case WMF: return XSLFRelation.IMAGE_WMF;
case PICT: return XSLFRelation.IMAGE_PICT;
case JPEG: return XSLFRelation.IMAGE_JPEG;
case PNG: return XSLFRelation.IMAGE_PNG;
case DIB: return XSLFRelation.IMAGE_DIB;
case GIF: return XSLFRelation.IMAGE_GIF;
case EPS: return XSLFRelation.IMAGE_EPS;
case BMP: return XSLFRelation.IMAGE_BMP;
case WPG: return XSLFRelation.IMAGE_WPG;
case WDP: return XSLFRelation.IMAGE_WDP;
case TIFF: return XSLFRelation.IMAGE_TIFF;
default: return null;
}
}
/**
* @return the 0-based index of this pictures within the picture parts
*/
public int getIndex() {
return index;
}
/**
* @param index sets the 0-based index of this pictures within the picture parts
*/
public void setIndex(int index) {
this.index = index;
}
}