com.buckosoft.PicMan.business.mosaic

Class MosaicMan

java.lang.Object

com.buckosoft.PicMan.business.mosaic.MosaicMan

public class MosaicMan
extends java.lang.Object

Manage mosaic building activities

Since:

2007/12/01

Version:

$Revision: 1.3 $
$Date: 2014/06/21 04:35:32 $

Author:

Dick Balaska

See Also:

MosaicMan.java

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	logger

Constructor Summary

Constructors

Constructor and Description
MosaicMan()

Method Summary

Modifier and Type	Method and Description
int	emptyMosaicQueue() Remove any and all jobs from the Mosaic queue
MosaicEngine	getMosaicEngine() If Mosaic is running, return a reference to the running engine.
MosaicManDevelopment	getMosaicManDevelopment() Fetch a reference to the MosaicManDevelopment
java.util.List<java.lang.String>	getMosaicQueueListString() Return a List of the names of Mosaic jobs queued to be run.
boolean	hasWorkToDo() Is there work to be done? i.e.
boolean	isBuilding() Are we running the builder?
void	outputMosaicFile() Write the (possibly partially completed) mosaic output jpeg
void	queueForBuilding(Mosaic mosaic) Queue this Mosaic for building.
boolean	runBuilder() Build the first mosaic in the list.
void	setDEBUG(boolean debugFlag) Enable logger output on this module
void	setDEBUGEngine(boolean debugFlag) Enable logger output on any MosaicEngine spawned.
void	setPicMan(PicManFacade pmf) Set the reference to the PicMan API.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

MosaicMan

public MosaicMan()

Method Detail

setPicMan

public void setPicMan(PicManFacade pmf)

Set the reference to the PicMan API.

Parameters:

pmf - The PicManFacade

setDEBUG

public void setDEBUG(boolean debugFlag)

Enable logger output on this module

Parameters:

debugFlag - true == turn on debugging.

setDEBUGEngine

public void setDEBUGEngine(boolean debugFlag)

Enable logger output on any MosaicEngine spawned.

Parameters:

debugFlag - true == turn on debugging.

getMosaicManDevelopment

public MosaicManDevelopment getMosaicManDevelopment()

Fetch a reference to the MosaicManDevelopment

Returns:

the mosaicManDevelopment

getMosaicEngine

public MosaicEngine getMosaicEngine()

If Mosaic is running, return a reference to the running engine.

Returns:

the mosaicEngine

isBuilding

public boolean isBuilding()

Are we running the builder?

Returns:

the building

hasWorkToDo

public boolean hasWorkToDo()

Is there work to be done? i.e. should we run the builder?

Returns:

true if there are Mosaics queued to be built

getMosaicQueueListString

public java.util.List<java.lang.String> getMosaicQueueListString()

Return a List of the names of Mosaic jobs queued to be run.

Returns:

The list of Mosaic Names

queueForBuilding

public void queueForBuilding(Mosaic mosaic)

Queue this Mosaic for building.

Parameters:

mosaic - The Mosaic that the User wants built

emptyMosaicQueue

public int emptyMosaicQueue()

Remove any and all jobs from the Mosaic queue

Returns:

The number of jobs removed

runBuilder

public boolean runBuilder()
                   throws java.lang.Exception

Build the first mosaic in the list.
Returns after the first mosaic is built. BatchManager will come around again on it's next iteration if there is more work to do.

Returns:

true if there is more work to do on this mosaic.

Throws:

java.lang.Exception - Something went wrong.

outputMosaicFile

public void outputMosaicFile()

Write the (possibly partially completed) mosaic output jpeg