/******************************************************************************

  * PicManFacade.java - Primary business interface

  * 

  * PicMan - The BuckoSoft Picture Manager in Java

  * Copyright(c) 2005 - Dick Balaska

  * 

  */

 package com.buckosoft.PicMan.business;

 import java.awt.Dimension;

 import java.util.LinkedList;

 import java.util.List;

 import com.buckosoft.PicMan.business.common.PicManCommonFacade;

 import com.buckosoft.PicMan.business.mosaic.MosaicMan;

 import com.buckosoft.PicMan.db.DatabaseFacade;

 import com.buckosoft.PicMan.domain.Chain;

 import com.buckosoft.PicMan.domain.Filter;

 import com.buckosoft.PicMan.domain.JobLogEntry;

 import com.buckosoft.PicMan.domain.Pic;

 import com.buckosoft.PicMan.domain.Set;

 import com.buckosoft.PicMan.domain.SetSize;

 import com.buckosoft.PicMan.domain.Thumbnail;

 import com.buckosoft.PicMan.image.PicReader;

 import com.buckosoft.PicMan.image.ThumbCache;

 /**

  * PicMan primary business interface.

  * @author Dick Balaska

  * @since 2005/07/25

  * @see <a href="http://cvs.buckosoft.com/Projects/java/PicMan/PicMan/src/com/buckosoft/PicMan/business/PicManFacade.java">PicManFacade.java</a>

  */

 public interface PicManFacade extends PicManCommonFacade {

         /** Get a reference to the Database

          * @return The one and only PicMan Database

          */

         public        DatabaseFacade getDB();

         ///////////////////////////////////////////////////////////////////////////

         ///////////////////////////////////////////////////////////////////////////

         /* PicReader */

         /** Get a reference to the PicReader

          * @return The one and only PicReader

          */

         PicReader        getPicReader();

         /** Read the file for this pic to figure out his size

          * @param pic The Pic to read

          * @return width/height as a {@link java.awt.Dimension}.  (-1,-1) = error.

          */

         Dimension determinePicSize(Pic pic);

         ///////////////////////////////////////////////////////////////////////////

         ///////////////////////////////////////////////////////////////////////////

         /* ThumbNail cache */

         /** Get a reference to the ThumbCache Manager

          * @return The one and only ThumbCache

          */

         ThumbCache        getThumbCache();

         void                setupThumbCache();

         ///////////////////////////////////////////////////////////////////////////

         ///////////////////////////////////////////////////////////////////////////

         /* Mosaic ThumbNail cache */

         /** Initialize the mosaic thumb cache for this set at this height

          * @param sid The SetID that MosaicMan is using

          * @param height The height of the thumbnails

          */

         void setupMosaicThumbCache(int sid, int height);

         /** Done with the mosaic cache, release it's resources.

          */

         void releaseMosaicThumbCache();

         ///////////////////////////////////////////////////////////////////////////

         ///////////////////////////////////////////////////////////////////////////

         /* Web output */

         /** Return the sets/sizes as an HTML table

          * @param setSizeList The sets/sizes to include in the table

          * @param showUnused Show or hide the unused Sets

          * @return A big honking string

          */

         String                getSetSizeWebTable(List<SetSize> setSizeList, boolean showUnused);

         /** Return a String of {tr}{td} checkboxes for this chain.

          * This horrible function is still used in 2011 in Chain Editing.

          * @param chain Chain to filter the checkboxes on.  If null, then output all checkboxes

          * @return A big String

          */

         String                getSetSizeCheckboxesHtml(Chain chain);

         //List<String>        getFilterColumnsAsHtml();

         /** Create a String that represents the Sets and values for this pic. <br>

          * \r\n represents newline<br>

          * A Sample output is:

          * <pre>   mlbG:6,6,6,6,0 mlb:6 Trains:6

          *   Springfield</pre>

          * @param picName

          * @return A string showing the Sets and values for this pic.

          */

         String                getFilterAsString(String picName);

         ///////////////////////////////////////////////////////////////////////////

         ///////////////////////////////////////////////////////////////////////////

         /* Contact manager */

         /** Get a reference to the instantiated <code>BatchManager</code>.

          * @return The BatchManager

          */

         BatchManager        getBatchManager();

 //        void                        runBatchManager() throws Exception;

         /** Return a one or two word status for the engine.

          * @return Most of the time, this will be "Idle".

          */

         String                        engineRunningShortStatus();

         /** Set the Cron string used to clock the engine.&nbsp;<FONT COLOR=RED>DDS</FONT>

          * @param expression The cron expression

          * @see org.springframework.scheduling.quartz.CronTriggerBean

          */

         void                setEngineCronExpression(String expression);

         /** Get a Thumbnail from this pic at this size

          * @param pic The Pic to read

          * @param height How tall to make the image

          * @return A Thumbnail or null if we can't make it

          */

         Thumbnail        getThumbNail(Pic pic, int height);

         /** Get a Thumbnail from this pic at this size

          * @param pic The Pic to read

          * @param height How tall to make the image

          * @param label Any text (like the rating) to draw in the lower left corner of the graphic

          * @return A Thumbnail or null if we can't make it

          */

         Thumbnail        getThumbNail(Pic pic, int height, String label);

         /** Get a Thumbnail from this pic at this size.

          * This is a little different than {@link #getThumbNail(Pic, int)} in that it uses the Mosaic ThumbCache,

          * which has slightly different rules.<br/>

          * The Mosaic {@link com.buckosoft.PicMan.image.ThumbCache} operates thusly:

          * If a Thumbnail is requested and it doesn't exist, it is built at the MosaicThumbHeight. Then the size requested is

          * derived from that and returned.

          * @param pic The Pic to read

          * @param height How tall to make the image

          * @return A Thumbnail or null if we can't make it

          */

         Thumbnail        getMosaicThumbNail(Pic pic, int height);

         Thumbnail        getTestMosaicThumbNail(Pic pic, int height, int depth);

         /** Fetch a reference to the Mosaic Manager

          * @return The one and only MosaicMan

          */

         MosaicMan getMosaicMan();

         /** Given a List of Sets, return a copy of a filter with the values 0'd out 

          * except for the Sets listed.

          * @param sets A list of sets

          * @param filter The filter to mask

          * @return The new Filter

          */

         Filter                getMaskedFilter(List<Set> sets, Filter filter);

         SyncManager_Old getSyncManager();

         /** Return a reference to The PosterManager

          * @return The one and only PosterManager

          */

         PosterManager        getPosterManager();

         ///////////////////////////////////////////////////////////////////////////

         ///////////////////////////////////////////////////////////////////////////

         /* Pic Importer Manager */

         /** Get a reference to the PicImporter

          * @return The PicImporter

          */

         PicImporter        getPicImporter();

         /** Get the number of files in a directory

          * @param rid The rootid to look under

          * @param dir The subdirectory i.e. "2008/20080609"

          * @return The number of files

          */

         int getFilesInDirCount(int rid, String dir);

         /** Fetch a <code>List</code> of dirs in this directory.

          * Note: This does not do database lookups; rather, it reads the actual directory structure.  

          * Perhaps this is not a good thing as the rest of the system deals with the database.

          * However, there are no real facilities for walking directories in the database.

          * @param rid The root id to look under

          * @param subDir Any subdirectory to check

          * @return A list of nodes that are directories.

          */

         List<String> getDirsInDir(int rid, String subDir);

         ///////////////////////////////////////////////////////////////////////////

         ///////////////////////////////////////////////////////////////////////////

         /* Job Log Manager */

         /** Return a reference to the Job Log

          * @return the jobLog

          */

         LinkedList<JobLogEntry> getJobLog();

         /** Get the maximum displayed job log lines in the home page.

          * @return the Count

          */

         int        getJobLogMaxCount();

         /** Add an entry to the Job Log

          * @param jle The JobLogEntry to add.

          */

         void addJobToLog(JobLogEntry jle);

         ///////////////////////////////////////////////////////////////////////////

         ///////////////////////////////////////////////////////////////////////////

         /* System Config */

         /** Does the User have the batch engine turned on?  Should we do work?

          * @return true = ok to do work.

          */

         boolean                isEngineOn();

 }