de.contecon.picapport.groovy

Class PathFilter

java.lang.Object

de.contecon.picapport.groovy.PathFilter

All Implemented Interfaces:

IPicApportGroovyAddon

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

Add-ons of type crawler filter (pagc) must extend this class to be recognized as a valid Add-on.
We recommend that you use the PrivateFileFilter as a template and adapt it to your demands.
Development cycle: Add-ons of type crawler filter are automatically updated/reloaded:

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

11.09.2020

Author:

Eric

Constructor Summary

Constructors

Constructor and Description
PathFilter()

Method Summary

Modifier and Type	Method and Description
void	beforeDirectoryScan(IAddonContext addonContext, java.io.File directory) This method is called immediately before a directory will be scanned for photos.
boolean	shouldAddDirectory(IAddonContext addonContext, java.io.File directory) Override this method to control whether a directory should be searched for photos or not author Eric 01.04.2020
boolean	shouldAddFile(IAddonContext addonContext, java.io.File file) Override this method to control whether a file should be included in the PicApport database or not.

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

PathFilter

public PathFilter()

Method Detail

beforeDirectoryScan

public void beforeDirectoryScan(IAddonContext addonContext,
                                java.io.File directory)

This method is called immediately before a directory will be scanned for photos. It may be used to add dynamic data (e.G. download from a Webserver) to the diectory before it will be scanned author Eric 01.04.2020

Parameters:

addonContext - Add-on context

directory - Directory

shouldAddDirectory

public boolean shouldAddDirectory(IAddonContext addonContext,
                                  java.io.File directory)

Override this method to control whether a directory should be searched for photos or not author Eric 01.04.2020

Parameters:

addonContext - Add-on context

directory - Directory

Returns:

true if directory should be processed by PicApport

shouldAddFile

public boolean shouldAddFile(IAddonContext addonContext,
                             java.io.File file)

Override this method to control whether a file should be included in the PicApport database or not. author Eric 01.04.2020

Parameters:

addonContext - Add-on context

file - The file that should be checked

Returns:

true if file should be added to PicApport