Package org.apache.poi.xssf.usermodel

Class XSSFPictureData

java.lang.Object

org.apache.poi.ooxml.POIXMLDocumentPart

org.apache.poi.xssf.usermodel.XSSFPictureData

All Implemented Interfaces:

PictureData

public class XSSFPictureData
extends POIXMLDocumentPart
implements PictureData

Raw picture data, normally attached to a SpreadsheetML Drawing. As a rule, pictures are stored in the /xl/media/ part of a SpreadsheetML package.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

POIXMLDocumentPart.RelationPart

Field Summary

Fields

Modifier and Type	Field	Description
protected static final POIXMLRelation[]	RELATIONS	Deprecated. the field will be removed

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XSSFPictureData()	Create a new XSSFPictureData node
protected	XSSFPictureData(PackagePart part)	Construct XSSFPictureData from a package part

Method Summary

Modifier and Type	Method	Description
byte[]	getData()	Gets the picture data as a byte array.
static int	getMaxImageSize()
String	getMimeType()	Returns the mime type for the image
int	getPictureType()
protected void	prepareForCommit()	*PictureData objects store the actual content in the part directly without keeping a copy like all others therefore we need to handle them differently.
static void	setMaxImageSize(int length)
String	suggestFileExtension()	Suggests a file extension for this image.

Methods inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

_invokeOnDocumentRead, addRelation, commit, createHyperlink, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getReferenceRelationship, getReferenceRelationships, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, getTargetPart, isCommitted, onDocumentCreate, onDocumentRead, onDocumentRemove, onSave, read, rebase, removeReferenceRelationship, removeRelation, removeRelation, removeRelation, setCommitted, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

RELATIONS

@Deprecated
@Removal(version="7.0.0")
protected static final POIXMLRelation[] RELATIONS

Deprecated.

the field will be removed

Relationships for each known picture type

Changing this array has no effect, as POI uses its own copy.

Constructor Details

XSSFPictureData

protected XSSFPictureData()

Create a new XSSFPictureData node

See Also:

• XSSFWorkbook.addPicture(byte[], int)

XSSFPictureData

protected XSSFPictureData(PackagePart part)

Construct XSSFPictureData from a package part

Parameters:

part - the package part holding the drawing data,

Since:

3.14-Beta1

Method Details

setMaxImageSize

public static void setMaxImageSize(int length)

Parameters:

length - the max image size allowed for XSSF pictures

getMaxImageSize

public static int getMaxImageSize()

Returns:

the max image size allowed for XSSF pictures

getData

public byte[] getData()

Gets the picture data as a byte array.

Note, that this call might be expensive since all the picture data is copied into a temporary byte array. You can grab the picture data directly from the underlying package part as follows:
InputStream is = getPackagePart().getInputStream();

Specified by:

getData in interface PictureData

Returns:

the picture data.

suggestFileExtension

public String suggestFileExtension()

Description copied from interface: PictureData

Suggests a file extension for this image.

Specified by:

suggestFileExtension in interface PictureData

Returns:

the file extension, without a leading .. Never null, but will be empty if the extension is unknown or if the file backing these data does not have an extension.

getPictureType

public int getPictureType()

Specified by:

getPictureType in interface PictureData

Returns:

the POI internal image type, 0 if unknown image type

See Also:

• Workbook.PICTURE_TYPE_DIB
• Workbook.PICTURE_TYPE_EMF
• Workbook.PICTURE_TYPE_JPEG
• Workbook.PICTURE_TYPE_PICT
• Workbook.PICTURE_TYPE_PNG
• Workbook.PICTURE_TYPE_WMF

getMimeType

public String getMimeType()

Description copied from interface: PictureData

Returns the mime type for the image

Specified by:

getMimeType in interface PictureData

prepareForCommit

protected void prepareForCommit()

*PictureData objects store the actual content in the part directly without keeping a copy like all others therefore we need to handle them differently.

Overrides:

prepareForCommit in class POIXMLDocumentPart