org.docx4j.model.images

Class AbstractConversionImageHandler

java.lang.Object

org.docx4j.model.images.AbstractConversionImageHandler

All Implemented Interfaces:

ConversionImageHandler

Direct Known Subclasses:

FileConversionImageHandler

public abstract class AbstractConversionImageHandler
extends java.lang.Object
implements ConversionImageHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	handledImagesMap
protected java.lang.String	imageDirPath
protected boolean	includeUUID
protected static org.slf4j.Logger	log
protected java.lang.String	uuid

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConversionImageHandler(java.lang.String imageDirPath, boolean includeUUID) Creates an AbstractConversionImageHandler

Method Summary

Modifier and Type	Method and Description
void	clear() If the instance is reused, it should be cleared first
protected java.lang.String	createEncodedImage(BinaryPart binaryPart, byte[] bytes)
protected java.lang.String	createKey(Relationship relationship, BinaryPart part)
protected abstract java.lang.String	createStoredImage(BinaryPart binaryPart, byte[] bytes)
protected java.lang.String	doHandleImage(AbstractWordXmlPicture picture, Relationship relationship, BinaryPart part)
protected byte[]	getImageData(BinaryPart binaryPart) Get the image data of the buffer
protected java.lang.String	getImageName(BinaryPart binaryPart) Get the image base name
protected java.lang.String	handleExternalImage(AbstractWordXmlPicture picture, Relationship relationship, BinaryPart part)
java.lang.String	handleImage(AbstractWordXmlPicture picture, Relationship relationship, BinaryPart part)
protected java.lang.String	handleInternalImage(AbstractWordXmlPicture picture, Relationship relationship, BinaryPart binaryPart)
protected boolean	isInternalImage(AbstractWordXmlPicture picture, Relationship relationship, BinaryPart part)
protected java.lang.String	setupImageName(BinaryPart binaryPart)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.slf4j.Logger log

uuid

protected java.lang.String uuid

handledImagesMap

protected java.util.Map<java.lang.String,java.lang.String> handledImagesMap

imageDirPath

protected java.lang.String imageDirPath

includeUUID

protected boolean includeUUID

Constructor Detail

AbstractConversionImageHandler

protected AbstractConversionImageHandler(java.lang.String imageDirPath,
                                         boolean includeUUID)

Creates an AbstractConversionImageHandler

Parameters:

imageDirPath, - the path, where the images will be stored

includeUUID, - should the image names be prefixed with an UUID to differentiate different runs

Method Detail

handleImage

public java.lang.String handleImage(AbstractWordXmlPicture picture,
                                    Relationship relationship,
                                    BinaryPart part)
                             throws Docx4JException

Specified by:

handleImage in interface ConversionImageHandler

relationship - of the image

part - of the image, if it is an internal image, otherwise null

Returns:

uri for the image we've saved, or null

Throws:

Docx4JException - this exception will be logged, but not propagated

createKey

protected java.lang.String createKey(Relationship relationship,
                                     BinaryPart part)

doHandleImage

protected java.lang.String doHandleImage(AbstractWordXmlPicture picture,
                                         Relationship relationship,
                                         BinaryPart part)
                                  throws Docx4JException

Throws:

Docx4JException

isInternalImage

protected boolean isInternalImage(AbstractWordXmlPicture picture,
                                  Relationship relationship,
                                  BinaryPart part)
                           throws Docx4JException

Throws:

Docx4JException

handleInternalImage

protected java.lang.String handleInternalImage(AbstractWordXmlPicture picture,
                                               Relationship relationship,
                                               BinaryPart binaryPart)
                                        throws Docx4JException

Parameters:

picture -

relationship -

binaryPart -

Returns:

uri for the image we've saved, or null

Throws:

Docx4JException

createStoredImage

protected abstract java.lang.String createStoredImage(BinaryPart binaryPart,
                                                      byte[] bytes)
                                               throws Docx4JException

Throws:

Docx4JException

createEncodedImage

protected java.lang.String createEncodedImage(BinaryPart binaryPart,
                                              byte[] bytes)
                                       throws Docx4JException

Throws:

Docx4JException

setupImageName

protected java.lang.String setupImageName(BinaryPart binaryPart)

getImageName

protected java.lang.String getImageName(BinaryPart binaryPart)

Get the image base name

Parameters:

binaryPart -

Returns:

getImageData

protected byte[] getImageData(BinaryPart binaryPart)

Get the image data of the buffer

Parameters:

binaryPart -

Returns:

handleExternalImage

protected java.lang.String handleExternalImage(AbstractWordXmlPicture picture,
                                               Relationship relationship,
                                               BinaryPart part)

Parameters:

picture -

relationship -

part - (is always null)

Returns:

uri for the image we've saved, or null

clear

public void clear()

If the instance is reused, it should be cleared first