database.java

dump3 morpheus 0.2.9 src

/**
 * DuMP3 version morpheus_0.2.9 - a duplicate/similar file finder in Java<BR>
 * Copyright 2005 Alexander Gr&auml;sser<BR>
 * All Rights Reserved, http://dump3.sourceforge.net/<BR>
 * <BR>
 * This file is part of DuMP3.<BR>
 * <BR>
 * DuMP3 is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option) any later version.<BR>
 * <BR>
 * DuMP3 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE. See the GNU General Public License for more details.<BR>
 * <BR>
 * You should have received a copy of the GNU General Public License along with DuMP3; if not, write to the Free Software Foundation, Inc., 51 Franklin St,
 * Fifth Floor, Boston, MA 02110-1301 USA
 */
package net.za.grasser.duplicate.persist;

import net.za.grasser.duplicate.file.FingerprintFile;

/**
 * This class defines the databse instance
 * 
 * @author <a href="http://sourceforge.net/sendmessage.php?touser=733840">pyropunk at sourceforge dot net</a>
 * @version $Revision: 1.3 $
 */
public interface Database {
  /**
   * This method connects to the database.
   * 
   * @return boolean
   */
  public abstract boolean connect();

  /**
   * This method closes the database
   */
  public abstract void close();

  /**
   * Retrieve the details for a <code>FingerprintFile</code>.
   * 
   * @param pFf a FingerprintFile
   * @return FingerprintFile
   */
  public abstract boolean get(final FingerprintFile pFf);

  /**
   * Store all details for a <code>FingerprintFile</code>.
   * 
   * @param pFf a FingerprintFile
   */
  public abstract void put(final FingerprintFile pFf);
}