de.contecon.picapport.groovy

Class PhotoFileProcessor

java.lang.Object

de.contecon.picapport.groovy.PhotoFileProcessor

All Implemented Interfaces:

IPicApportGroovyAddon

public abstract class PhotoFileProcessor
extends java.lang.Object
implements IPicApportGroovyAddon

Add-ons of type Procedures (pagp) must extend this class to be recognized as a valid Add-on.
Lifecycle:
When a procedure is started for N-selected photos the Methods are called in the following order:

• start is called one time at the beginning of processing the selected photos
• processPhotoFile is called one time for each selected photo
• stop is called one time at the end of processing the selected photos

We recommend that you use the GroovyProceduresTestTool as a template and adapt it to your demands.
Development cycle: Add-ons of type procedure are automatically updated/reloaded:

• When the PicApport Server starts
• Before execution
• When the reloadaddons console command is executed

When during development components of the Webinterface or menues etc. change, to make these changes visible the webinterface has to be reloaded.

14.09.2020

Author:

Eric

Constructor Summary

Constructors

Constructor and Description
PhotoFileProcessor()

Method Summary

Modifier and Type	Method and Description
void	processPhotoFile(IAddonContext addonContext, IAddonExecutionContext addonExecutionContext, IAddonFileToProcess fileToProcess) This method is called one time for each selected photo author Eric 14.09.2020
void	start(IAddonContext addonContext, IAddonExecutionContext addonExecutionContext) This method is called one time at the beginning of processing the selected photos author Eric 14.09.2020
void	stop(IAddonContext addonContext, IAddonExecutionContext addonExecutionContext) This method is called one time at the end of processing the selected photos author Eric 14.09.2020

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.contecon.picapport.groovy.IPicApportGroovyAddon

init

Constructor Detail

PhotoFileProcessor

public PhotoFileProcessor()

Method Detail

start

public void start(IAddonContext addonContext,
                  IAddonExecutionContext addonExecutionContext)

This method is called one time at the beginning of processing the selected photos author Eric 14.09.2020

Parameters:

addonContext - Global utility methods for logging etc....

addonExecutionContext - The executionContext passed,is always the same instance during the lifecycle of the processor. It extends a Map, so it can be used to store any information during the processing of photos.

processPhotoFile

public void processPhotoFile(IAddonContext addonContext,
                             IAddonExecutionContext addonExecutionContext,
                             IAddonFileToProcess fileToProcess)

This method is called one time for each selected photo author Eric 14.09.2020

Parameters:

addonContext - Global utility methods for logging etc....

addonExecutionContext - The executionContext passed,is always the same instance during the lifecycle of the processor. It extends a Map, so it can be used to store any information during the processing of photos.

fileToProcess - Use fileToProcess to access information of the current processed photo like file, or metadata.

stop

public void stop(IAddonContext addonContext,
                 IAddonExecutionContext addonExecutionContext)

This method is called one time at the end of processing the selected photos author Eric 14.09.2020

Parameters:

addonContext - Global utility methods for logging etc....

addonExecutionContext - The executionContext passed,is always the same instance during the lifecycle of the processor. It extends a Map, so it can be used to store any information during the processing of photos.