de.contecon.picapport.groovy

Interface IAddonFileToProcess

public interface IAddonFileToProcess

This class provides methods to obtain Information about the currently processed photo file and some utility functions for the file processing.
14.09.2020

Author:

Eric

Method Summary

Modifier and Type	Method and Description
void	addAddonMetadata(IAddonContext addonContext, java.lang.String uniqueId, org.json.JSONObject json) Utility method to add Add-on specific JSON metadata to the currently processed file author Eric 15.09.2020
void	addAddonMetadata(IAddonContext addonContext, java.lang.String uniqueId, java.lang.String metaData) Utility method to add Add-on specific JSON metadata to the currently processed file author Eric 15.09.2020
org.json.JSONObject	getAddonMetadataAsJSON(java.lang.String uniqueId) author Eric 15.09.2020
java.lang.String	getAddonMetadataAsString(java.lang.String uniqueId) author Eric 15.09.2020
java.io.File	getFileWithJpgImage() author Eric 14.09.2020
java.lang.Object	getFirstMetadataValue(java.lang.String directory, java.lang.String key) Access Metadata author Eric 14.09.2020
com.drew.metadata.Metadata	getMetadata() author Eric 14.09.2020
java.io.File	getOriginalFile() author Eric 14.09.2020
IPhotoMetaData	getPhotoMetadata() Access Metadata author Eric 14.09.2020
int	getSequenceNumber() author Eric 14.09.2020
java.lang.String	getUserId() author Eric 14.09.2020
java.lang.String	getXmpMetaAsXMLString() Access metadata author Eric 14.09.2020
boolean	hasAddonMetadata(java.lang.String uniqueId) author Eric 15.09.2020
boolean	isCreatedByPlugin() author Eric 14.09.2020
void	lockExtraFile(java.io.File file) If the procedure creates new Files thes files should be locked before access to avoid possible conflicts with concurrently running procedures.
void	removeAddonMetadata(IAddonContext addonContext, java.lang.String uniqueId) Utility method to remove Add-on specific metadata from the currently processed file author Eric 15.09.2020
void	writeScaledJpgWithoutMetadata(java.io.OutputStream os, int cx, int cy, float quality) Helper Method to create a .jpg image of any size from the currently processed file.

Method Detail

getUserId

java.lang.String getUserId()

author Eric 14.09.2020

Returns:

UserId of user who has started this procedure

getOriginalFile

java.io.File getOriginalFile()

author Eric 14.09.2020

Returns:

the original file of the currently processed photo (e.g. a video file etc.)

getFileWithJpgImage

java.io.File getFileWithJpgImage()

author Eric 14.09.2020

Returns:

The file with the jpg image (the shadow file if the image was created from a plug-in)

isCreatedByPlugin

boolean isCreatedByPlugin()

author Eric 14.09.2020

Returns:

true if the image file was created from a plug-in

getMetadata

com.drew.metadata.Metadata getMetadata()

author Eric 14.09.2020

Returns:

see drewnoakes metadata-extractor for a description of Metadata

getSequenceNumber

int getSequenceNumber()

author Eric 14.09.2020

Returns:

Picapport internal sequence number of current photo in the current view(query)

getXmpMetaAsXMLString

java.lang.String getXmpMetaAsXMLString()
                                throws java.lang.Exception

Access metadata
author Eric 14.09.2020

Returns:

The XMP metadata String of this photo or null if it does not exist

Throws:

java.lang.Exception - in case of an error

getPhotoMetadata

IPhotoMetaData getPhotoMetadata()
                         throws java.lang.Exception

Access Metadata
author Eric 14.09.2020

Returns:

IPhotoMetaData provides access to common metadata of the currently processed photo

Throws:

java.lang.Exception - in case of an error

getFirstMetadataValue

java.lang.Object getFirstMetadataValue(java.lang.String directory,
                                       java.lang.String key)

Access Metadata
author Eric 14.09.2020

Parameters:

directory - see drewnoakes metadata-extractor for a description of directories

key - see drewnoakes metadata-extractor for a description of keys

Returns:

Metadata found or nul if it does not exist

writeScaledJpgWithoutMetadata

void writeScaledJpgWithoutMetadata(java.io.OutputStream os,
                                   int cx,
                                   int cy,
                                   float quality)
                            throws java.io.IOException,
                                   java.lang.Exception

Helper Method to create a .jpg image of any size from the currently processed file. The aspect ratio is maintained.
author Eric 15.09.2020

Parameters:

os - OutputStream where the image will be written to

cx - maximum width

cy - maximum heigth

quality - Quality between 0.0 and 1.0(best)

Throws:

java.io.IOException - If an IO error occurs

java.lang.Exception - If An error occurs

lockExtraFile

void lockExtraFile(java.io.File file)
            throws java.lang.Exception

If the procedure creates new Files thes files should be locked before access to avoid possible conflicts with concurrently running procedures.
author Eric 15.09.2020

Parameters:

file - File that should be locked

Throws:

java.lang.Exception - If an error occurs

addAddonMetadata

void addAddonMetadata(IAddonContext addonContext,
                      java.lang.String uniqueId,
                      org.json.JSONObject json)
               throws java.lang.Exception

Utility method to add Add-on specific JSON metadata to the currently processed file
author Eric 15.09.2020

Parameters:

addonContext - The current context

uniqueId - To avoid name conflicts with other add-ons we recommend to use e.g. a url like myaddonname.de

json - JSON Object to store

Throws:

java.lang.Exception - If an error occurs

addAddonMetadata

void addAddonMetadata(IAddonContext addonContext,
                      java.lang.String uniqueId,
                      java.lang.String metaData)
               throws java.lang.Exception

Utility method to add Add-on specific JSON metadata to the currently processed file
author Eric 15.09.2020

Parameters:

addonContext - The current context

uniqueId - To avoid name conflicts with other add-ons we recommend to use e.g. a url like myaddonname.de

metaData - teststring to store

Throws:

java.lang.Exception - If an error occurs

removeAddonMetadata

void removeAddonMetadata(IAddonContext addonContext,
                         java.lang.String uniqueId)
                  throws java.lang.Exception

Utility method to remove Add-on specific metadata from the currently processed file
author Eric 15.09.2020

Parameters:

addonContext - The current context

uniqueId - To avoid name conflicts with other add-ons we recommend to use e.g. a url like myaddonname.de

Throws:

java.lang.Exception - If an error occurs

hasAddonMetadata

boolean hasAddonMetadata(java.lang.String uniqueId)
                  throws java.lang.Exception

author Eric 15.09.2020

Parameters:

uniqueId - Add-on specific unique id

Returns:

true id Add-on data exits for uniqueId

Throws:

java.lang.Exception - Exception If an error occurs

getAddonMetadataAsString

java.lang.String getAddonMetadataAsString(java.lang.String uniqueId)
                                   throws java.lang.Exception

author Eric 15.09.2020

Parameters:

uniqueId - Add-on specific unique id

Returns:

currently attached metadata textstring for uniqueId or null

Throws:

java.lang.Exception - If an error occurs

getAddonMetadataAsJSON

org.json.JSONObject getAddonMetadataAsJSON(java.lang.String uniqueId)
                                    throws java.lang.Exception

author Eric 15.09.2020

Parameters:

uniqueId - Add-on specific unique id

Returns:

currently attached metadata JSON for uniqueId or null

Throws:

java.lang.Exception - If an error occurs