se.datadosen.jalbum
Interface AlbumEngine

All Known Implementing Classes:

AlbumBean

public interface AlbumEngine

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

Since:

8.4

See Also:

se.datadosen.jalbum.Main.getEngine

Method Summary

void	addAlbumBeanListener(AlbumBeanListener l)
java.lang.String	getDirectory()
java.lang.String	getOutputDirectory()
java.lang.String	getSkin()
java.util.Map	getSkinVariables()
java.lang.String	getStyle()
java.util.Map	getUserVariables()
boolean	isAppendImages()
void	makeAlbum() Generate a web album.
void	removeAlbumBeanListener(AlbumBeanListener l)
void	setAppendImages(boolean newAppendImages) Control if all image files are to be rescaled or only new files.
void	setDirectory(java.lang.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(java.lang.String newOutputDirectory)
void	setProperties(java.util.Properties props) Convenience method that calls the relevant setter methods on this bean depending on the passed properties.
void	setSkin(java.lang.String newSkin)
void	setSkinVariables(java.util.Map newSkinVariables)
void	setStyle(java.lang.String newStyle)
void	setUserVariables(java.util.Map newUserVariables)
void	smartMakeAlbum() Make album but let Jalbum decide whether to make all or changes

Method Detail

addAlbumBeanListener

void addAlbumBeanListener(AlbumBeanListener l)

removeAlbumBeanListener

void removeAlbumBeanListener(AlbumBeanListener l)

setSkin

void setSkin(java.lang.String newSkin)

getSkin

java.lang.String getSkin()

setStyle

void setStyle(java.lang.String newStyle)

getStyle

java.lang.String getStyle()

setSkinVariables

void setSkinVariables(java.util.Map newSkinVariables)

getSkinVariables

java.util.Map getSkinVariables()

setUserVariables

void setUserVariables(java.util.Map newUserVariables)

getUserVariables

java.util.Map getUserVariables()

setProperties

void setProperties(java.util.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(java.lang.String newDirectory)

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

Parameters:

newDirectory -

getDirectory

java.lang.String getDirectory()

setOutputDirectory

void setOutputDirectory(java.lang.String newOutputDirectory)

getOutputDirectory

java.lang.String getOutputDirectory()

setAppendImages

void setAppendImages(boolean newAppendImages)

Control if all image files are to be rescaled or only new files. Setting appendImages to true corresponds to "Make changes" Setting appendImages to false corresponds to "Make all" button.

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

void makeAlbum()
               throws java.lang.IllegalArgumentException,
                      java.io.IOException,
                      OperationAbortedException,
                      ElementException

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);

Throws:

java.lang.IllegalArgumentException

java.io.IOException

OperationAbortedException

ElementException

smartMakeAlbum

void smartMakeAlbum()
                    throws java.lang.IllegalArgumentException,
                           java.io.IOException,
                           OperationAbortedException,
                           ElementException

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

Throws:

java.lang.IllegalArgumentException

java.io.IOException

OperationAbortedException

ElementException