com.buckosoft.PicMan.business.mosaic

Class MosaicEngine

java.lang.Object

com.buckosoft.PicMan.business.mosaic.MosaicEngine

Direct Known Subclasses:

FirstRibbon, FourthRibbon, HSVRibbon, SampleMaker, SecondRibbon, ThirdRibbon, VectorRibbon

public class MosaicEngine
extends java.lang.Object

Base class for the mosaic engines

Since:

2007/12/23

Author:

Dick Balaska

See Also:

MosaicEngine.java, com.buckosoft.PicMan.business.mosaic.engine

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MosaicEngine.ConfigItem Support for runtime MosaicEngine configuration.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.awt.image.BufferedImage	bi
protected java.util.HashMap<java.lang.String,java.lang.Object>	buildParameters
protected java.util.LinkedList<java.lang.String>	configList The names of the configured parameters, so we can pull them in a reasonable order for display.
protected java.util.HashMap<java.lang.String,MosaicEngine.ConfigItem>	configMap A hash of all of the configured parameters
protected DatabaseFacade	dbf
protected static boolean	DEBUG
protected JobLogEntry	jobLogEntry
protected java.util.Date	lastMosaicUpdate
protected Pic	masterPic
protected int	mid
protected Mosaic	mosaic
protected Set	mosaicSet
protected PicManFacade	pmf
protected int	tileHeight

Constructor Summary

Constructors

Constructor and Description
MosaicEngine() Default constructor Base class constructor.

Method Summary

Modifier and Type	Method and Description
protected boolean	_build()
protected void	addConfig(java.lang.String name, java.lang.String description, int type, double value)
protected void	addConfig(java.lang.String name, java.lang.String description, int type, int value)
boolean	build() Build the Mosaic.
java.util.HashMap<java.lang.String,MosaicEngine.ConfigItem>	getConfigMap() A map of the available ConfigItems for an engine.
java.lang.String	getDurationAsString() Fetch how long this Engine has been running.
java.awt.image.BufferedImage	getImage() Fetch the image that we built / are building.
java.lang.String	getInfo() Get the engine's semi-static build info.
java.util.Date	getLastMosaicUpdate()
java.lang.String	getMasterPicName() Get the name of the master pic that we are building from.
java.lang.String	getName() Get the name of the Mosaic that we are building.
java.lang.String	getOutputFileName() Get the name of the output file that will be written.
java.lang.String	getStatus() Get the engine's build status.
int	getTileHeight() Get the Tile Height / thumbnail height to be used to build this Mosaic.
void	outputMosaicFile(boolean makeBackup) Write the built image to the jpg specified in outPic
void	setDEBUG(boolean debugFlag) Enable logger output on this module
protected void	setLastMosaicUpdate()
void	setMosaic(Mosaic mosaic) Set the Mosaic that we are going to build.
void	setPicMan(PicManFacade pmf) Set the reference to the PicMan API.
void	setTileHeight(int tileHeight)

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

protected static boolean DEBUG

pmf

protected PicManFacade pmf

dbf

protected DatabaseFacade dbf

mosaic

protected Mosaic mosaic

masterPic

protected Pic masterPic

mid

protected int mid

bi

protected java.awt.image.BufferedImage bi

tileHeight

protected int tileHeight

lastMosaicUpdate

protected java.util.Date lastMosaicUpdate

mosaicSet

protected Set mosaicSet

jobLogEntry

protected JobLogEntry jobLogEntry

configMap

protected java.util.HashMap<java.lang.String,MosaicEngine.ConfigItem> configMap

A hash of all of the configured parameters

configList

protected java.util.LinkedList<java.lang.String> configList

The names of the configured parameters, so we can pull them in a reasonable order for display.

buildParameters

protected java.util.HashMap<java.lang.String,java.lang.Object> buildParameters

Constructor Detail

MosaicEngine

public MosaicEngine()

Default constructor Base class constructor. Place your engine config attributes in your constructor.

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.

getLastMosaicUpdate

public java.util.Date getLastMosaicUpdate()

Returns:

the lastMosaicUpdate

setLastMosaicUpdate

protected void setLastMosaicUpdate()

getTileHeight

public int getTileHeight()

Get the Tile Height / thumbnail height to be used to build this Mosaic. This assumes an engine deals in tileHeights, which is true for now.

Returns:

the tileHeight

setTileHeight

public void setTileHeight(int tileHeight)

Parameters:

tileHeight - the tileHeight to set

getImage

public java.awt.image.BufferedImage getImage()

Fetch the image that we built / are building.

Returns:

the bufferedImage

getName

public java.lang.String getName()

Get the name of the Mosaic that we are building.

Returns:

The Mosaic name from the Mosaic.

getMasterPicName

public java.lang.String getMasterPicName()

Get the name of the master pic that we are building from.

Returns:

The name of the master pic.

getOutputFileName

public java.lang.String getOutputFileName()

Get the name of the output file that will be written.

Returns:

The User specified output file. i.e. "C:\myMosaics\Mosaic1.jpg"

getDurationAsString

public java.lang.String getDurationAsString()

Fetch how long this Engine has been running.

Returns:

Something like "1:23:45"

setMosaic

public void setMosaic(Mosaic mosaic)

Set the Mosaic that we are going to build.

Parameters:

mosaic - The Mosaic parameters as specified by the User.

outputMosaicFile

public void outputMosaicFile(boolean makeBackup)

Write the built image to the jpg specified in outPic

Parameters:

makeBackup - Maintain a set of backups of the output mosaic.

build

public boolean build()
              throws java.lang.Exception

Build the Mosaic.

Returns:

true if there is more work to do.

Throws:

java.lang.Exception - Something went wrong.

_build

protected boolean _build()
                  throws java.lang.Exception

Throws:

java.lang.Exception

getStatus

public java.lang.String getStatus()

Get the engine's build status. This should be overridden by the actual engine.

Returns:

i.e. SecondRibbon returns "Calc: pass=13 p=901"

getInfo

public java.lang.String getInfo()

Get the engine's semi-static build info. This should be overridden by the actual engine.

Returns:

i.e. SecondRibbon returns "tileRows=154 maxCol=2048 pics=5820"

addConfig

protected void addConfig(java.lang.String name,
                         java.lang.String description,
                         int type,
                         int value)

addConfig

protected void addConfig(java.lang.String name,
                         java.lang.String description,
                         int type,
                         double value)

getConfigMap

public java.util.HashMap<java.lang.String,MosaicEngine.ConfigItem> getConfigMap()

A map of the available ConfigItems for an engine.

Returns:

The map of ConfigItems for this engine keyed by the item name.