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

  * PicImporter.java - Interface to the Picture Importer

  * 

  * PicMan - The BuckoSoft Picture Manager in Java

  * Copyright(c) 2005 - Dick Balaska

  * 

  */

 package com.buckosoft.PicMan.business;

 import java.io.File;

 import java.util.List;

 import org.dom4j.Document;

 /** Interface to the Picture Importer

  * @author Dick Balaska

  * @since 2008/01/30

  */

 public interface PicImporter {

         /** Scan the camera's file system and return a list of Files that need importing

          * @return A List of <code>File</code>s of jpgs

          */

         List<File>        getPicNamesToImport();

         /** Import a single pic from the "camera" to the the pictures file system.

          * Note that you still have to "scan for virgins" after the import.

          * @param rid The rootId 

          * @param odir The output directory "2008/20080126"

          * @param iname The input filename "100_0877.JPG"

          * @param oname The output pic name "b2008012660"

          * @return An {@link com.buckosoft.PicMan.dom.ImportPicsDom} status document describing the status of the import

          */

         Document        importPic(int rid, String odir, String iname, String oname);

         /** Get some info about how this new import pic relates to our library

          * @param fname The name of the import file to examine

          * @param customDate If the user set a custom date for this pic. null if undefined.

          * @return An {@link com.buckosoft.PicMan.dom.ImportAnalyzeDom} status document describing stuff about this pic

          */

         Document        analyzePic(String fname, String customDate);

 }