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

  * DatabaseFacade.java - API into the PicMan database

  * 

  * PicMan - The BuckoSoft Picture Manager in Java

  * Copyright(c) 2005 - Dick Balaska

  * 

  */

 package com.buckosoft.PicMan.db;

 import java.util.Calendar;

 import java.util.Date;

 import java.util.HashMap;

 import java.util.List;

 import org.springframework.dao.DataAccessException;

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

 import com.buckosoft.PicMan.db.logic.MetaSetFilter;

 import com.buckosoft.PicMan.domain.Chain;

 import com.buckosoft.PicMan.domain.Contact;

 import com.buckosoft.PicMan.domain.Filter;

 import com.buckosoft.PicMan.domain.FilterMicroSet;

 import com.buckosoft.PicMan.domain.MetaSet;

 import com.buckosoft.PicMan.domain.Mosaic;

 import com.buckosoft.PicMan.domain.MosaicBatch;

 import com.buckosoft.PicMan.domain.MosaicTile;

 import com.buckosoft.PicMan.domain.Pic;

 import com.buckosoft.PicMan.domain.Poster;

 import com.buckosoft.PicMan.domain.Root;

 import com.buckosoft.PicMan.domain.Set;

 import com.buckosoft.PicMan.domain.SetSize;

 import com.buckosoft.PicMan.domain.SyncClient;

 import com.buckosoft.PicMan.domain.SyncServer;

 import com.buckosoft.PicMan.domain.System;

 import com.buckosoft.PicMan.domain.User;

 import com.buckosoft.PicMan.domain.Virgin;

 import com.buckosoft.PicMan.domain.mosaic.MosaicVector;

 /** API into the PicMan database

  * @author Dick Balaska

  * @since 2006/07/17

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

  * @see <div><a href="http://cvs.buckosoft.com/Projects/PicMan/PicMan/src/JOCLPoolingDriver.jocl">JOCLPoolingDriver.jocl</a> Configuration file for the database</div>

  */

 public interface DatabaseFacade {

         /** Enable logger output on the database

          * @param debugFlag true == turn on debugging.

          */

         public void setDEBUG(boolean debugFlag);

         /** Set the callback to the partial main business facade.

          * We are interested in the error handler.

          * @param picManCommonFacade Where the error handler lives.

          */

         void setPicManCommonFacade(PicManCommonFacade picManCommonFacade);

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

         /* Contacts */

         /** Fetch the {@link com.buckosoft.PicMan.domain.Contact} that was built with these parameters.

          * This does not return an image, just all of the parameters needed to recreate the image.

          * Such as which Thumbnail appeared at each coordinates.

          * @param cid The {@link com.buckosoft.PicMan.domain.Chain} ID

          * @param name The qualified name of this contact.  i.e. "Gail-100-02"

          * @return The Contact

          */

         Contact                getContact(int cid, String name);

         /** Fetch the {@link com.buckosoft.PicMan.domain.Contact} that was built with these parameters.

          * This does not return an image, just all of the parameters needed to recreate the image.

          * Such as which Thumbnail appeared at each coordinates.

          * @param cid The {@link com.buckosoft.PicMan.domain.Chain} ID

          * @param setName The name of the {@link com.buckosoft.PicMan.domain.Set} that was used

          * @param size The Thumbnail size

          * @param index Which of this series of contacts

          * @return The Contact

          */

         Contact                getContact(int cid, String setName, int size, int index);

         /** Add this {@link com.buckosoft.PicMan.domain.Contact} to the database.

          * @param c The Contact

          */

         void                addContact(Contact c);

         /** Fetch the newest {@link com.buckosoft.PicMan.domain.Contact} made.  Basically this tells us

          * the last time Contacts were made.

          * @return The newest Contact in the database.

          */

         Contact                getNewestContact();

         /** Return the oldest contact in each set/size in a map

          * k = SetName i.e. "G-100" / v = Date

          * @param chain Which {@link com.buckosoft.PicMan.domain.Chain} to process 

          * @return the map

          */

         HashMap<String, Date>                getContactOldestMap(Chain chain);

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

         /* Chain management */

         /** Get a List of all of the {@link com.buckosoft.PicMan.domain.Chain}s in the database.

          * @return The List

          */

         List<Chain>        getChains();

         /** Return the number of {@link com.buckosoft.PicMan.domain.Chain}s in the Database.

          * @return The Count

          * @throws DataAccessException It broke.

          */

         int                getChainCount();

         /** Fetch a {@link com.buckosoft.PicMan.domain.Chain} based on its name.

          * @param chainName The name to query.

          * @return The chain or <code>null</code> if not found.

          */

         Chain        getChain(String chainName);

         /** Fetch a {@link com.buckosoft.PicMan.domain.Chain} based on its Chain ID.

          * @param cid The Chain ID to query.

          * @return The chain or <code>null</code> if not found.

          */

         Chain        getChain(int cid);

         /** Delete this {@link com.buckosoft.PicMan.domain.Chain} from the Database.

          * @param chain The Chain to delete.

          */

         void        deleteChain(Chain chain);

         /** Store this {@link com.buckosoft.PicMan.domain.Chain} in the Database.

          * @param chain The Chain to write.

          */

         void        storeChain(Chain chain);

         /** Return a list of Sets in a {@link com.buckosoft.PicMan.domain.Chain}

          * @param cid The Chain to query

          * @return A List of Set

          */

         public List<Set>        getSetsInChain(int cid);

         /** Return a list of SetSize for this set that are in this {@link com.buckosoft.PicMan.domain.Chain}

          * @param cid The chain id

          * @param sid The {@link com.buckosoft.PicMan.domain.Set} id

          * @return A list of SetSizes

          */

         List<SetSize>        getSetSizesInChain(int cid, int sid);

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

         /* Filter management */

         /** Get the number of {@link com.buckosoft.PicMan.domain.Filter}s in the database.

          * @return the count.

          */

         int                                getFilterCount();

         /** Get a list of the {@link com.buckosoft.PicMan.domain.Filter} column names from the database.

          * @return The List.

          */

         List<String>        getFilterColumns();

         /** Get a list of all of the {@link com.buckosoft.PicMan.domain.Filter}s in the database.

          * @return The List.

          */

         List<Filter>        getFilters();

         /** Get a list of all of the {@link com.buckosoft.PicMan.domain.Filter}s for this set/size.

          * @param setName The name of the Set to query.

          * @param size The thumbnail size to query.

          * @return A List of the <code>Filter</code>s that match this query

          */

         List<Filter>        getFiltersBySet(String setName, int size);

         /** Get a List of the Pic Names of the {@link com.buckosoft.PicMan.domain.Filter}s that match this query.

          * @param setName The name of the Set to query

          * @param size The thumbnail size to query

          * @return A List of the Pic Names that match this query

          */ 

         List<String>        getPicNamesBySet(String setName, int size);

         /** Get a List of the Pic Names of the {@link com.buckosoft.PicMan.domain.Filter}s that match this query.

          * @param set The Set to query

          * @param size The thumbnail size to query

          * @return A List of the Pic Names that match this query

          */

         List<String>        getPicNamesBySet(Set set, int size);

         /** Get a List of the Pic Names of the {@link com.buckosoft.PicMan.domain.Filter}s that match this query.

          * @param set The MetaSet to query

          * @param size The thumbnail size to query

          * @param rateOp An index into the MetaSet rateOps table.  i.e. NONE, =, !=, <, >.

          * @param rateVal The value to apply with the rateOp against this set

          * @return A List of the Pic Names that match this query

          */

         List<String>        getPicNamesBySet(MetaSet set, int size, int rateOp, int rateVal);

         /** Get a List of the Pic Names of the {@link com.buckosoft.PicMan.domain.Filter}s that match this valued query.

          * This allows to say "mlb < 5".

          * @param set The Set to query.

          * @param size The thumbnail size to query.

          * @param rateOp An index into the MetaSet rateOps table.  i.e. NONE, =, !=, <, >.

          * @param rateVal The value to apply with the rateOp against this set

          * @return A List of the Pic Names that match this query.

          */ 

         List<String>        getPicNamesBySet(Set set, int size, int rateOp, int rateVal);

         /** Get a List of the Pic Names of the {@link com.buckosoft.PicMan.domain.Filter}s that match this valued query.

          * This allows to say "mlb < 5".

          * @param setName The name of the Set to query.

          * @param size The thumbnail size to query.

          * @return A List of the Pic Names that match this query.

          */ 

         List<String>        getPicNamesBySet(String setName, int size, int rateOp, int rateVal);

         /** Get a List of the Pic Names that pass this function filter.

          * See {@link Set} for the list of valid function numbers.

          * @param func The Function number to run.

          * @param size The thumb size to run this filter on.

          * @param rateOp An index into the MetaSet rateOps table.  i.e. NONE, =, !=, <, >.

          * @param operand A generic operand for the func.  i.e. date (-2) takes a date here "2009-07-25"

          * @return A List of the Pic Names that match this query.

          */

         List<String>        getPicNamesByFunc(int func, int size, int rateOp, String operand);

         /** Return a hash of the newest filter for each set/size.

          * k = Set i.e. "G_100" / v = Date 

          * @return The Hash

          */

         HashMap<String, Date>        getSetTimestamps();

         /** Add a {@link com.buckosoft.PicMan.domain.Filter} to the database, overwriting any existing filter for this pic.

          * @param filter The new (or used) Filter.

          */

         void        addFilter(Filter filter);

         /** Get the {@link com.buckosoft.PicMan.domain.Filter} for the pic named.

          * @param picName The name of the Pic.

          * @return the Filter

          */

         Filter        getFilter(String picName);

         /** Get the {@link com.buckosoft.PicMan.domain.FilterMicroSet} for this pic in this set.

          * @param pid The pid the Pic.

          * @param sid The sid of the set to query.

          * @return The <code>FilterMicroSet</code> or null if not found.

          */

         FilterMicroSet        getPicFromFilterMicroSet(int pid, int sid);

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

         /* MetaSet management */

         /** Get the {@link com.buckosoft.PicMan.domain.MetaSet} that matches this Set ID.

          * @param sid The SetID to query.

          * @return The MetaSet

          */

         MetaSet        getMetaSet(int sid);

         /** Store this {@link com.buckosoft.PicMan.domain.MetaSet} to the database.

          * @param mset The MetaSet to write.

          */

         void                        storeMetaSet(MetaSet mset);

         /** Get a List of Column names for the {@link com.buckosoft.PicMan.domain.MetaSet}s.

          * @return a List of "columns" for the known metasets

          */

         List<String>        getMetaSetColumns();

         /** Fetch a reference to the MetaSet filter processor.

          * @return A reference to the database's MetaSet filter processor.

          */

         MetaSetFilter        getMetaSetFilter();

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

         /* Mosaic management */

         /** Get a List of all of the {@link com.buckosoft.PicMan.domain.Mosaic}s in the database.

          * @return The List of Mosaics

          */

         List<Mosaic>        getMosaics();

         /** Get a {@link com.buckosoft.PicMan.domain.Mosaic} from the database based on this Mosaic ID.

          * @param mid The Mosaic ID to query.

          * @return The Mosaic that matches this mid, or null if not found.

          */

         Mosaic                        getMosaic(int mid);

         /** Find the {@link com.buckosoft.PicMan.domain.Mosaic} in the database that matches these parameters.

          * @param masterPic

          * @param engine

          * @param sid

          * @param tileHeight

          * @return The mosaic that matches these parameters, or null if not found.

          */

         Mosaic                        getMosaic(String masterPic, String engine, int sid, int tileHeight);

         /** Return the number of tiles we have stored for this {@link com.buckosoft.PicMan.domain.Mosaic}

          * @param mid The mosaicId

          * @return The count

          */

         int                                getMosaicTileCount(int mid);

         /** Delete the {@link com.buckosoft.PicMan.domain.Mosaic} from the database that has this Mosaic ID.

          * @param mid The Mosaic ID to delete.

          */ 

         void                        deleteMosaic(int mid);

         /** Store this {@link com.buckosoft.PicMan.domain.Mosaic} in the database.

          * @param mosaic The Mosaic to store.

          */

         void                        storeMosaic(Mosaic mosaic);

         /** Get a List of {@link com.buckosoft.PicMan.domain.MosaicBatch}es in the database.

          * @return The List of MosaicBatches

          */

         List<MosaicBatch>        getMosaicBatches();

         /** Get the MosaicBatch that matches this mbid

          * @param mbid The MosaicBatch id to query.

          * @return The MosaicBatch that matches or null if not found.

          */

         MosaicBatch                getMosaicBatch(int mbid);

         /** Store this {@link com.buckosoft.PicMan.domain.MosaicBatch}es in the database.

          * @param mbatch The MosaicBatch to store

          */

         void                        storeMosaicBatch(MosaicBatch mbatch);

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

         /* MosaicTile management */

         /** Fetch the already built {@link com.buckosoft.PicMan.domain.MosaicTile}s for this Mosaic

          * @param mid The MosaicID to fetch

          * @return A List of MosaicTiles

          */

         List<MosaicTile>        getMosaicTiles(int mid);

         /** Delete the {@link com.buckosoft.PicMan.domain.MosaicTile}s for the Mosaic specified by this Mosaic ID.

          * @param mid The Mosaic ID to delete.

          */

         void                                deleteMosaicTiles(int mid);

         /** Store this {@link com.buckosoft.PicMan.domain.MosaicTile} in the database.

          * @param tile The MosaicTile to store.

          */

         void                                storeMosaicTile(MosaicTile tile);

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

         /* MosaicVector management */

         /** Store this {@link com.buckosoft.PicMan.domain.mosaic.MosaicVector} in the database.

          * @param mv The MosaicVector to store.

          */

         void updateMosaicVectors(MosaicVector mv);

         /** Get the List of {@link com.buckosoft.PicMan.domain.mosaic.MosaicVector}s that matches this picList, which probably came from a mosaic Set.

          * @param picList The List of Pics to query

          * @return The matching List of <code>MosaicVector</code>s.  The List may be empty, but not null.

          */

         List<MosaicVector>        getMosaicVectors(List<Pic> picList);

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

         /* Poster management */

         /** Get a List of all of the {@link com.buckosoft.PicMan.domain.Mosaic}s in the database.

          * @return The List of Mosaics

          */

         List<Poster>        getPosters();

         /** Get a {@link com.buckosoft.PicMan.domain.Poster} from the database based on this Poster ID.

          * @param pid The Poster ID to query.

          * @return The Poster that matches this pid, or null if not found.

          */

         Poster                        getPoster(int pid);

         /** Delete the {@link com.buckosoft.PicMan.domain.Poster} from the database that has this Poster ID.

          * @param pid The Poster ID to delete.

          */ 

         void                        deletePoster(int pid);

         /** Store this {@link com.buckosoft.PicMan.domain.Poster} in the database.

          * @param poster The Poster to store.

          */

         void                        storePoster(Poster poster);

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

         /* Pic management */

         /** Add this {@link com.buckosoft.PicMan.domain.Pic} to the database.

          * @param pic The Pic to add.  pid is assumed to be 0.

          */

         void                addPic(Pic pic);

         /** Update this {@link com.buckosoft.PicMan.domain.Pic} in the database.

          * Pic is assumed to exist and pid must not be 0.

          * @param pic The Pic to update.

          */

         void                updatePic(Pic pic);

         /** Get a {@link com.buckosoft.PicMan.domain.Pic} who's name matches this picName.

          * @param picName The name of the <code>Pic</code> to query.

          * @return The Pic that matches this picName or <code>null</code>.

          */

         Pic                        getPic(String picName);

         /** Get a {@link com.buckosoft.PicMan.domain.Pic} who's pid matches this one.

          * @param pid The pid to query

          * @return The Pic that matches this pid, or null if not found.

          */

         Pic                        getPic(int pid);

         /** Get the newest pic in the database.

          * @return The Pic with the newest Timestamp

          */

         Pic                        getNewestPic();

         /** Return a random pic from the database

          * @return Any pic from the database

          */

         Pic                        getRandomPic();

         /** Return a list of Pics that have this md5Sum

          * @param md5sum

          * @return The list, may be empty

          */

         List<Pic>        getPicsByMD5Sum(long md5sum);

         /** Return a random pic from the database destined to be a thumbnail on the home page

          * @param user The {@link User} who is requesting the Pic

          * @return The name of any pic from the database that matches the User's preference

          */

         String                getRandomHomePagePicName(User user);

         /** Get a HashMap of all of the {@link com.buckosoft.PicMan.domain.Pic} names in the database.

          * @return The map

          */

         HashMap<String, Date>                getPicsMap();

         /** Get a List of all of the {@link com.buckosoft.PicMan.domain.Pic}s in the database that match this name.  Wildcards are supported.

          * @param picName The name (or partial name) of the pics to fetch.

          * @return A List of <code>Pic</code>s.

          */

         List<Pic>        getPics(String picName);

         /** Get a List of all of the Pics.

          * @return A List of Pic

          */

         List<Pic>        getPics();

         /** Get a list of {@link com.buckosoft.PicMan.domain.Pic}s for this set at this size.

          * @param set The set to use as a filter

          * @param size The size to use as a filter

          * @return A List of Pic

          */

         List<Pic>        getPics(Set set, int size);

         /** Get a list of {@link com.buckosoft.PicMan.domain.Pic}s that are in this subdirectory.

          * @param rid Root id to search under

          * @param dirName The directory, i.e. "2002/20021225"

          * @return A List of Pic

          */

         List<Pic>        getPicsInDir(int rid, String dirName);

         /** Get a list of Pics that are newer than this date

          * @param calendar The timestamp to compare against

          * @return The List of Pics

          */

         List<Pic>        getPicsNewerThan(Calendar calendar);

         /** Determine the highest numbered thumb cache subdirectory used.

          * @return the highest number, or 0 if no thumbs are cached.

          */

         int                getPicMaxThumbCacheDirUsed();

         /** Determine the number of cached thumbs in this cache directory. <br>

          * Note that this doesn't actually check if the thumbs exist, only if they have a database entry.

          * @param cacheDir The directory to check

          * @return The Count

          */

         int                getPicThumbCacheFillCount(int cacheDir);

         /** Get the rating for this pic intersected by this set at this size

          * @param picName The name of the Pic whose rating we want

          * @param set The set to do the rating check against.  

          *                 If a pic is Audrey-7 and we want Carl, then this is probably not one we want. 

          * @param size The size of the pic we care about

          * @return The rate of the pic.  This is a double because we could get (6+7)/2 for a rate.

          */

         double        getPicRate(String picName, Set set, int size);

         /** Get the rating for this pic intersected by this MetaSet at this size

          * @param picName The Pic whose rating we want

          * @param metaSet The metaSet to do the rating check against.

          * @param size The size of the pic we care about

          * @return The rate of the pic.  This is a double because we could get (6+7)/2 for a rate.

          */

         double        getPicRate(String picName, MetaSet metaSet, int size);

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

         /* Roots management */

         /** Get a List of all of the {@link com.buckosoft.PicMan.domain.Root}s

          * @return A List of all of the Roots in the database

          */

         List<Root>                getRoots();

         /** Get the number of {@link com.buckosoft.PicMan.domain.Root}s in the database

          * @return The number of <code>Root</code>s

          */

         int                                getRootCount();

         /** Fetch a {@link com.buckosoft.PicMan.domain.Root}

          * @param rid The rootId to match

          * @return The Root

          */

         Root                        getRoot(int rid);

         /** Fetch a {@link com.buckosoft.PicMan.domain.Root}

          * @param name The Name of the Root to fetch

          * @return The Root

          */

         Root                        getRoot(String name);

         /** Set the {@link com.buckosoft.PicMan.domain.Root}s in the Database to be this List.

          * I'm not sure why you'd want to do this, and it is unused, but here it is.

          * @param roots A List of {@link com.buckosoft.PicMan.domain.Root}s

          */

         void                        setRoots(List<Root> roots);

         /** Add this {@link com.buckosoft.PicMan.domain.Root} to the Database.

          * the Root ID must be 0.

          * @param root The Root to add.

          * @throws Exception Can't do it.

          */

         void                        addRoot(Root root) throws Exception;

         /** Delete this {@link com.buckosoft.PicMan.domain.Root} from the database.

          * @param root The Root to delete.

          * @throws Exception Can't do it.

          */

         void                        deleteRoot(Root root) throws Exception;

         /** Store this existing {@link com.buckosoft.PicMan.domain.Root} in the database.

          * The Root ID must <b>NOT</b> be 0.

          * @param root The existing Root to update.

          */

         void                        storeRoot(Root root);

         /** Get a List of Inactive {@link com.buckosoft.PicMan.domain.Root}s.

          * Inactive <code>Root</code>s will not be scanned for new pics, or included in Sets queries.

          * @return A List of Roots that the User has disabled.

          */

         List<Root>                getInactiveRoots();

         /** Get a List of active {@link com.buckosoft.PicMan.domain.Root}s.

          * @return A List of Roots

          */

         List<Root>                getActiveRoots();

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

         /* Set management */

         /** Get a List of all of the {@link com.buckosoft.PicMan.domain.Set}s in the database.

          * <b>Note:</b> The Sets are cached in memory.  An external app writing to the database will not

          * be reflected in this running instance.

          * @return The List of {@link com.buckosoft.PicMan.domain.Set}s

          */

         List<Set>                getSets();

         /** Get a cloned List of all of the {@link com.buckosoft.PicMan.domain.Set}s in the database.

          * This is useful for when you want to prune the list without altering the sets cache.

          * @return The List of {@link com.buckosoft.PicMan.domain.Set}s

          */

         List<Set>                getSetsClone();

         /** Return the number of {@link com.buckosoft.PicMan.domain.Set}s in the Database.

          * @return The Number of {@link com.buckosoft.PicMan.domain.Set}s

          */

         int                                getSetCount();

         /** Get the {@link com.buckosoft.PicMan.domain.Set} that matches this Set ID

          * @param sid The SetID to query

          * @return The Set that was found or null if no match was made.

          */

         Set                                getSet(int sid);

         /** Get the {@link com.buckosoft.PicMan.domain.Set} that matches this Set ID

          * @param setName The name of the Set to query

          * @return The Set that was found or null if no match was made.

          */

         Set                                getSet(String setName);

         /** Set the {@link com.buckosoft.PicMan.domain.Set}s in the Database to be this List.

          * I'm not sure why you'd want to do this, and it is unused, but here it is.

          * @param sets A List of {@link com.buckosoft.PicMan.domain.Set}s

          */

         void                        setSets(List<Set> sets);

         /** Add this new {@link com.buckosoft.PicMan.domain.Set} to the database.

          * The Set ID (sid) is assumed to be 0.

          * @param set The Set to add

          * @throws Exception Can't do it

          */

         void                        addSet(Set set) throws Exception;

         /** Delete this {@link com.buckosoft.PicMan.domain.Set} from the database.

          * This is a very bad thing, as new Set IDs are derived from the number of Sets.

          * @param set The Set to delete.

          * @throws Exception Can't do it.

          */

         void                        deleteSet(Set set) throws Exception;

         /** Update this existing {@link com.buckosoft.PicMan.domain.Set} in the database.

          * @param set The Set to update

          */

         void                        storeSet(Set set);

         /** Rename this Set.  Includes changing references from the old setname to the new one.

          * @param oldName What is this set called?

          * @param newName What do we want it to be called?

          */

         void                        renameSet(String oldName, String newName);

         /** Get a List of inactive {@link com.buckosoft.PicMan.domain.Set}s

          * @return The List of {@link com.buckosoft.PicMan.domain.Set}s that the User has marked as inactive.

          */

         List<Set>                getInactiveSets();

         /** Get a List of active {@link com.buckosoft.PicMan.domain.Set}s

          * @return The List of {@link com.buckosoft.PicMan.domain.Set}s that are NOT marked inactive.

          */

         List<Set>                getActiveSets();

         /** Get an array of the number of thumbnail sizes.

          * Through the years, i have settled on 75,100,150,200,300 as the sizes that i play with and

          * these numbers are hardcoded in here.

          * @return An array of the sizes

          */

         int[]                        getSizeArray();

         /** Get the array of Thumbnail Sizes as a List of Integers.

          * The {@link com.buckosoft.PicMan.domain.Filter}s are keyed to the sizes.

          * A {@link com.buckosoft.PicMan.domain.Thumbnail} that looks OK as a 75, might not be worthy of a 300.

          * @return A List of Integers

          * @see #getSizeArray()

          */

         List<Integer>        getSizes();

         /** Return the number of sizes that we deal with.

          * @return That would be the number 5.

          */ 

         int                                getSizeCount();

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

         /* System */

         /** Fetch a reference to the {@link com.buckosoft.PicMan.domain.System} configuration.

          * <b>Note:</b> This is a cached object and changes made outside of this application will not be picked up.

          * @return The cached {@link com.buckosoft.PicMan.domain.System}.

          */

         System                        getSystem();

         /** Flush the {@link com.buckosoft.PicMan.domain.System} configuration back to the database.

          * @param system The System to write.

          */

         void                        saveSystem(System system);

         /** Get the user's preferred {@link com.buckosoft.PicMan.domain.Thumbnail} height used when running the editors.

          * @return The height of the Thumnails (I like 140 pixels).

          */

         int                                getThumbHeight();

         /** Return a list of file name extensions that denote pics that we are interested in. <br>

          * Originally, i expected to use <code>.png</code> in here, but basically i've settled on <code>.jpg</code>. <br>

          * This is actually convienent, because if there is a pic i want to ignore, i rename it to <code>.jpeg</code>.

          * @return A List of Extensions, typically just "jpg".

          */

         List<String>        getPicExtensions();

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

         /* Users */

         /** Get the {@link com.buckosoft.PicMan.domain.User} who has this userid.

          * @param userid The userid to query.

          * @return A PicMan User.

          */

         User        getUser(int userid) throws DataAccessException;

         /** Store this {@link com.buckosoft.PicMan.domain.User} in the database.  Does not affect the BSAccount settings of this User.

          * @param user The User to save.

          */

         void        storeUser(User user);

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

         /* Utilities */

         /** Make a uuid String based on a setName and a size

          * @param setName The name of the Set

          * @param size The size

          * @return The uuid String. i.e. "G_075"

          */

         String                getUuid(String setName, int size);

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

         /* Virgin management */

         /** Return the number of {@link com.buckosoft.PicMan.domain.Virgin}s in the database.

          * @return The count.

          */

         int                                getVirginCount();

         /** Get a List of all of the {@link com.buckosoft.PicMan.domain.Virgin}s in the database.

          * @return The List

          */

         List<Virgin>        getVirgins();

         /** Get a List of all of the {@link com.buckosoft.PicMan.domain.Virgin}s in the database up to max number. <br>

          * This is useful for the "process up to 5 virgins" page.

          * @param max The Maximum number of <code>Virgin</code>s to put in the List

          * @return The List.

          */

         List<Virgin>        getVirgins(int max);

         /** Is this picName a {@link com.buckosoft.PicMan.domain.Virgin}?

          * @param picName The name of the {@link com.buckosoft.PicMan.domain.Pic} to query

          * @return true if this picName is in the {@link com.buckosoft.PicMan.domain.Virgin}s table.

          */

         boolean        isVirgin(String picName);

         /** Add this Pic name as a {@link com.buckosoft.PicMan.domain.Virgin} in the database.

          * @param picName The name of the Pic to add.

          */

         void        addVirgin(String picName);

         /** Delete this Pic name from the {@link com.buckosoft.PicMan.domain.Virgin}s table.  This Pic is no longer a <code>Virgin</code>.

          * @param picName The name of the {@link com.buckosoft.PicMan.domain.Pic} to remove.

          */

         void        deleteVirgin(String picName);

         /** Get the last time this client sync'd.

          * @param host The host to fetch

          * @return The date/time of sync or null if never synced. 

          */

         Date        getClientSyncTimestamp(String host);

         /** Set the last time this client sync'd to now.

          * @param host The host to fetch

          */

         void        setClientSyncTimestamp(String host);

         void updateSetTimestamp(String setSize);

         void                                storeSyncClient(SyncClient syncClient);

         List<SyncClient>        getSyncClients();

         void                                storeSyncServer(SyncServer syncServer);

         List<SyncServer>        getSyncServers();

         /** Set the user who is accessing the database.

          * @param dbUser The database user

          */

         void        setDbUser(String dbUser);

         /** Get the user who is accessing the database.  This is realy a status field, as nothing outside of here accesses the database.

          * @return Usually "picman" or "picman_dev"

          */

         String        getDbUser();

         /** Set the database url.

          * @param dbUrl The dbUrl to set.

          */

         void        setDbUrl(String dbUrl);

         /** Get the url that is accessing the database.  This is realy a status field, as nothing outside of here accesses the database.

          * @return jdbc:mysql://localhost:3306/{something}

          */

         String        getDbUrl();

 }