source: DASISH/t5.6/backend/annotator-backend/trunk/annotator-backend/src/main/java/eu/dasish/annotation/backend/dao/AnnotationDao.java @ 4207

/*
 * Copyright (C) 2013 DASISH
 *
 * This program 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.
 *
 * This program 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
package eu.dasish.annotation.backend.dao;

import eu.dasish.annotation.schema.Annotation;
import eu.dasish.annotation.schema.AnnotationBody;
import eu.dasish.annotation.schema.AnnotationInfo;
import eu.dasish.annotation.schema.Permission;
import java.sql.SQLException;
import java.sql.Timestamp;
import java.util.List;
import java.util.Map;

/**
 * Created on : Jun 27, 2013, 10:34:13 AM
 *
 * @author Peter Withers <peter.withers@mpi.nl>
 */


public interface AnnotationDao extends ResourceDao{
    
    
    /**
     * GETTERS
     */
    
    /**
     * 
     * @param annotationID
     * @return the pair (annotation, owner_id) with empty list of Targets.
     * 
     * (Constructing a complete Annotation object using  "getAnnotationWithoutTargets" and "retrieveTargetIDs" is done in "DaoDispatchter".)
     * 
     */
    public Map<Annotation, Number> getAnnotationWithoutTargetsAndPermissions(Number annotationID);
    
    
     /**
     * 
     * @param annotationIDs: the list of annotationID-s from which the resulting annotations are to be selected.
     * @param text: the text which the resulting annotations' bodies must contain.* @param namespace TODO: do not know what to do with it 
     * @param ownerID: the resulting annotations are owned by the owner "ownerID".
     * @param after: the resulting annotations must have timestamp later than "after".
     * @param before: the resulting annotations must have timestamp earlier than "before".
     * @return the sub-list of internal annotation identifiers from the list "internalIDs" for annotations 
     * -- bodies of which contain the "text", 
     * -- to which inlogged user has "access", 
     * -- owned by "owner", 
     * -- added to the database between "before" and "after" time-dates.
     * 
     */
    public List<Number> getFilteredAnnotationIDs(List<Number> annotationIDs, String text, String namespace, Number ownerID, Timestamp after, Timestamp before);
     
       /**
     * unit test is missing
     * @param annotationIDs
     * @return pair <annotationInfo, owner_id>  for the annotation with the internal annotationID.
     * 
     */
    public Map<AnnotationInfo, Number> getAnnotationInfoWithoutTargets(Number annotationID);    
   
    /**
     * 
     * @param annotationIDs
     * @return list of reTarget references where an i-th reference is constructed from the external identifier of the annotation with the i-th internal identifier from the list.
     */
    public List<String> getAnnotationREFs(List<Number> annotationIDs); 
    
    /**
     * 
     * @param TargetIDs
     * @return the list of annotationdIDs of the annotations which target Targets are from "TargetIDs" list.
     */
    public List<Number> retrieveAnnotationList(List<Number> TargetIDs);
   
    
       /**
     * 
     * @param annotationID
     * @return the list of the internal IDs of all the target Targets of "annotationID".
     */
    public List<Number> retrieveTargetIDs(Number annotationID);   
    
   
       /**
     * 
     * @param annotationID
     * @return all the pairs (user-permission) for "annotationId" from the table annotations_principals permissions.
     */
    public List<Map<Number, String>>  getPermissions(Number annotationID);
    
    /**
     * 
     * @param annotationID
     * @param userID
     * @return permission of the userID w.r.t. annotationID, or null if the permission is not given
     */ 
    public Permission  getPermission(Number annotationID, Number userID);
    
    public List<Number> getAnnotationIDsForUserWithPermission(Number userID, String[] permissionStrings);
    
    
    /**
     * 
     * @param annotationID
     * @return true if "annotationID" is mentioned in at least one of the joint tables:
     * "annotations_targets", "annotations_principals_permissions", "notebook_annotations".
     * Otherwise return "false".
     */
    public boolean annotationIsInUse(Number annotationID);
    
    /**
     * ADDERS 
     */
    
    /**
     * 
     * @param annotationID
     * @param targetID
     * @return # updated rows in the joint table "annotations_target_Targets".
     * @throws SQLException 
     * Connects the annotation to its target Target by adding the pair (annotationID, TargetID) to the joint table.
     */ 
    public int addAnnotationTarget(Number annotationID, Number targetID);
    
   
    /**
     * 
     * @param annotationID
     * @param userID
     * @param permission
     * @return # rows added to the table "annotations_principals_permissions"
     * Sets the "permission" for the "userID" w.r.t. the annotation with "annotationID".
     */
    public int addAnnotationPrincipalPermission(Number annotationID, Number userID, Permission permission);
    
    
  
     /**
     * 
     * @param annotation: the object to be added to the table "annotation".
     * @return  the internal ID of the added annotation, if it is added, or null otherwise.
     **/
    
    public Number addAnnotation(Annotation annotation, Number ownerID);
 
     
    /////// UPDATERS //////////////////
    
   
    public int updateAnnotationBody(Number annotationID, String text, String mimeType, Boolean isXml);
    
   
    
    /**
     * 
     * @param annotation
     * @param ownerID
     * @return # of updated rows in "annotation" table after updating the annotation. Should return 1 if update  happens
     * @throws SQLException 
     */
    public int updateAnnotation(Annotation annotation, Number ownerID);
    
    
     /**
     * 
     * @param annotationID
     * @param userID
     * @param permission
     * @return # rows updated to the table "annotations_principals_permissions"
     * Sets the "permission" for the "userID" w.r.t. the annotation with "annotationID".
     */
    public int updateAnnotationPrincipalPermission(Number annotationID, Number userID, Permission permission);
    
    
    
    
   /**
    * DELETERS 
    */
    
    /**
     * 
     * @param annotationId
     * @return # rows in the table "annotation". It should be "1" if the annotation with "annotationID" is successfully deleted, and "0" otherwise.
     */
    
    
   
    public int deleteAnnotation(Number annotationId);
    
    /**
     * 
     * @param annotationId
     * @return # removed rows in the table "annotations_target_Targets". 
     */
    
    public int deleteAllAnnotationTarget(Number annotationID);
    
   
   /**
    * 
    * @param annotationID
    * @return # removed rows in the table "annotations_principals_permissions".
    * @throws SQLException 
    */
    public int deleteAnnotationPrincipalPermissions(Number annotationID);
    
    /*
     * HELPERS 
     */
    
    public String[] retrieveBodyComponents(AnnotationBody annotationBody);

}