1 /******************************************************************************
2 * PicImporter.java - Interface to the Picture Importer
3 *
4 * PicMan - The BuckoSoft Picture Manager in Java
5 * Copyright(c) 2005 - Dick Balaska
6 *
7 */
8 package com.buckosoft.PicMan.business;
9
10 import java.io.File;
11 import java.util.List;
12
13 import org.dom4j.Document;
14
15 /** Interface to the Picture Importer
16 * @author Dick Balaska
17 * @since 2008/01/30
18 */
19 public interface PicImporter {
20
21 /** Scan the camera's file system and return a list of Files that need importing
22 * @return A List of <code>File</code>s of jpgs
23 */
24 List<File> getPicNamesToImport();
25
26 /** Import a single pic from the "camera" to the the pictures file system.
27 * Note that you still have to "scan for virgins" after the import.
28 * @param rid The rootId
29 * @param odir The output directory "2008/20080126"
30 * @param iname The input filename "100_0877.JPG"
31 * @param oname The output pic name "b2008012660"
32 * @return An {@link com.buckosoft.PicMan.dom.ImportPicsDom} status document describing the status of the import
33 */
34 Document importPic(int rid, String odir, String iname, String oname);
35
36 /** Get some info about how this new import pic relates to our library
37 * @param fname The name of the import file to examine
38 * @param customDate If the user set a custom date for this pic. null if undefined.
39 * @return An {@link com.buckosoft.PicMan.dom.ImportAnalyzeDom} status document describing stuff about this pic
40 */
41 Document analyzePic(String fname, String customDate);
42 }