Interface AlbumEngine

All Known Implementing Classes:

AlbumBean

public interface AlbumEngine

Interface for AlbumBean, providing necessary functionality for running AlbumBean integrated into a web application

Since:

8.4

See Also:

• Main

Method Summary

Modifier and Type	Method	Description
void	addAlbumBeanListener(AlbumBeanListener l)
String	getDirectory()
String	getOutputDirectory()
String	getSkin()
Map	getSkinVariables()
String	getStyle()
Map	getUserVariables()
boolean	isAppendImages()
MakeResult	makeAlbum()	Generate a web album.
void	removeAlbumBeanListener(AlbumBeanListener l)
void	setAppendImages(boolean appendImages)	Control if all image files are to be rescaled or only new files.Setting appendImages causes image reprocessing only if images are missing
void	setDirectory(String newDirectory)	Set image directory.
void	setLimit(int limit)	Limit number of album objects that are to be processed 0 = unlimited Use of this method by 3:rd party developers is discouraged
void	setOutputDirectory(String newOutputDirectory)
void	setProperties(Properties props)	Convenience method that calls the relevant setter methods on this bean depending on the passed properties.
void	setSkin(String newSkin)
void	setSkinVariables(Map newSkinVariables)
void	setStyle(String newStyle)
void	setUserVariables(Map newUserVariables)
MakeResult	smartMakeAlbum()	Make album but let jAlbum decide whether to make all or changes

Method Details

addAlbumBeanListener

void addAlbumBeanListener(AlbumBeanListener l)

removeAlbumBeanListener

void removeAlbumBeanListener(AlbumBeanListener l)

setSkin

void setSkin(String newSkin)

getSkin

String getSkin()

setStyle

void setStyle(String newStyle)

getStyle

String getStyle()

setSkinVariables

void setSkinVariables(Map newSkinVariables)

getSkinVariables

Map getSkinVariables()

setUserVariables

void setUserVariables(Map newUserVariables)

getUserVariables

Map getUserVariables()

setProperties

void setProperties(Properties props)

Convenience method that calls the relevant setter methods on this bean depending on the passed properties. Skin and user variables, prefixed with skin. and user. will be installed as skin- and user variables

Since:

8.4

setDirectory

void setDirectory(String newDirectory)

Set image directory. Mandatory to call before calling makeAlbum() Fires directory PropertyChangeEvent since 8.4

Parameters:

newDirectory -

getDirectory

String getDirectory()

setOutputDirectory

void setOutputDirectory(String newOutputDirectory)

getOutputDirectory

String getOutputDirectory()

setAppendImages

void setAppendImages(boolean appendImages)

Control if all image files are to be rescaled or only new files.Setting appendImages causes image reprocessing only if images are missing

Parameters:

appendImages -

isAppendImages

boolean isAppendImages()

setLimit

void setLimit(int limit)

Limit number of album objects that are to be processed 0 = unlimited Use of this method by 3:rd party developers is discouraged

Since:

8.3

makeAlbum

MakeResult makeAlbum()
              throws IllegalArgumentException,
IOException,
OperationAbortedException,
ElementException,
ScriptException

Generate a web album. Before calling makeAlbum() you must always call setDirectory() and either call setOutputDirectory() to set an output directory or call setSameDirectory(true);

Returns:

Throws:

IOException

ElementException

IllegalArgumentException

OperationAbortedException

ScriptException

smartMakeAlbum

MakeResult smartMakeAlbum()
                   throws IllegalArgumentException,
IOException,
OperationAbortedException,
ElementException,
ScriptException

Make album but let jAlbum decide whether to make all or changes

Returns:

Throws:

IOException

ElementException

IllegalArgumentException

OperationAbortedException

ScriptException