org.apache.poi.xwpf.usermodel

Class XWPFPictureData

java.lang.Object

org.apache.poi.POIXMLDocumentPart

org.apache.poi.xwpf.usermodel.XWPFPictureData

public class XWPFPictureData
extends POIXMLDocumentPart

Author:

Philipp Epp

Field Summary

Fields

Modifier and Type	Field and Description
protected static POIXMLRelation[]	RELATIONS Relationships for each known picture type

Fields inherited from class org.apache.poi.POIXMLDocumentPart

DEFAULT_XML_OPTIONS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XWPFPictureData() Create a new XWPFGraphicData node
	XWPFPictureData(PackagePart part, PackageRelationship rel) Construct XWPFPictureData from a package part

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Long	getChecksum()
byte[]	getData() Gets the picture data as a byte array.
String	getFileName() Returns the file name of the image, eg image7.jpg .
int	getPictureType() Return an integer constant that specifies type of this picture
int	hashCode()
protected void	onDocumentRead() Fired when a package part is read
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.
String	suggestFileExtension() Suggests a file extension for this image.

Methods inherited from class org.apache.poi.POIXMLDocumentPart

addRelation, commit, createRelationship, createRelationship, createRelationship, getPackagePart, getPackageRelationship, getParent, getRelationById, getRelationId, getRelations, getTargetPart, onDocumentCreate, onDocumentRemove, onSave, read, rebase, removeRelation, removeRelation, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

RELATIONS

protected static final POIXMLRelation[] RELATIONS

Relationships for each known picture type

Constructor Detail

XWPFPictureData

protected XWPFPictureData()

Create a new XWPFGraphicData node

XWPFPictureData

public XWPFPictureData(PackagePart part,
               PackageRelationship rel)

Construct XWPFPictureData from a package part

Parameters:

part - the package part holding the drawing data,

rel - the package relationship holding this drawing, the relationship type must be http://schemas.openxmlformats.org/officeDocument/2006/relationships/image

Method Detail

onDocumentRead

protected void onDocumentRead()
                       throws IOException

Description copied from class: POIXMLDocumentPart

Fired when a package part is read

Overrides:

onDocumentRead in class POIXMLDocumentPart

Throws:

IOException

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();

Returns:

the Picture data.

getFileName

public String getFileName()

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

suggestFileExtension

public String suggestFileExtension()

Suggests a file extension for this image.

Returns:

the file extension.

getPictureType

public int getPictureType()

Return an integer constant that specifies type of this picture

Returns:

an integer constant that specifies type of this picture

See Also:

Document.PICTURE_TYPE_EMF, Document.PICTURE_TYPE_WMF, Document.PICTURE_TYPE_PICT, Document.PICTURE_TYPE_JPEG, Document.PICTURE_TYPE_PNG, Document.PICTURE_TYPE_DIB

getChecksum

public Long getChecksum()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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