/**
    * Copyright 2005-2013 The Kuali Foundation
    *
    * Licensed under the Educational Community License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    * http://www.opensource.org/licenses/ecl2.php
    *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.kuali.rice.krad.dao.impl;
  
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.List;
  
  import org.apache.log4j.Logger;
  import org.apache.ojb.broker.query.Criteria;
  import org.apache.ojb.broker.query.Query;
  import org.apache.ojb.broker.query.QueryByCriteria;
  import org.apache.ojb.broker.query.QueryFactory;
  import org.kuali.rice.core.framework.persistence.ojb.dao.PlatformAwareDaoBaseOjb;
  import org.kuali.rice.krad.bo.Attachment;
  import org.kuali.rice.krad.bo.Note;
  import org.kuali.rice.krad.dao.NoteDao;
  import org.springframework.dao.DataAccessException;
  
  /**
   * This class is the OJB implementation of the NoteDao interface.
   *
   * @author Kuali Rice Team (rice.collab@kuali.org)
   */
  public class NoteDaoOjb extends PlatformAwareDaoBaseOjb implements NoteDao {
      private static Logger LOG = Logger.getLogger(NoteDaoOjb.class);
  
      /**
       * Default constructor.
       */
      public NoteDaoOjb() {
          super();
      }
  
      /**
       * Saves a note to the DB using OJB.
       *
       * @param line
       */
      public void save(Note note) throws DataAccessException {
          // Add this check for KRAD to avoid saving the empty Attachments
          // TODO : look into avoiding the default empty attachments being added to the note
          if (note.getAttachment() != null && note.getAttachment().getAttachmentFileName() == null) {
              note.setAttachment(null);
          }
          //workaround in case sequence is empty  I shouldn't need this but ojb seems to work weird with this case
          if (note != null && note.getNoteIdentifier() == null && note.getAttachment() != null) {
              Attachment attachment = note.getAttachment();
              note.setAttachment(null);
              //store without attachment
              getPersistenceBrokerTemplate().store(note);
              attachment.setNoteIdentifier(note.getNoteIdentifier());
              //put attachment back
              note.setAttachment(attachment);
          }
          getPersistenceBrokerTemplate().store(note);
      }
  
      /**
       * Deletes a note from the DB using OJB.
       */
      public void deleteNote(Note note) throws DataAccessException {
          getPersistenceBrokerTemplate().delete(note.getAttachment());
          note.setAttachment(null);
          getPersistenceBrokerTemplate().delete(note);
          
      }
  
      /**
       * Retrieves document associated with a given object using OJB.
       *
       * @param id
       * @return
       */
      public List<Note> findByremoteObjectId(String remoteObjectId) {
          Criteria criteria = new Criteria();
          //TODO: Notes - Chris move remoteObjectId string to constants
          criteria.addEqualTo("RMT_OBJ_ID", remoteObjectId);
  
          QueryByCriteria query = QueryFactory.newQuery(Note.class, criteria);
          //while this is currently called every time these methods could be changed to allow
          //custom sorting by BO see discussion on Notes confluence page
          defaultOrderBy(query);
          Collection<Note> notes = findCollection(query);
  
          return new ArrayList<Note>(notes);
     }
     
     public Note getNoteByNoteId(Long noteId) {
         Criteria crit = new Criteria();
         crit.addEqualTo("noteIdentifier", noteId);
         return (Note) this.getPersistenceBrokerTemplate().getObjectByQuery(new QueryByCriteria(Note.class, crit));          
     }
 
     /**
      * This method defines the default sort for notes
      * @param query
      */
     private void defaultOrderBy(QueryByCriteria query) {
         //TODO: Notes - Chris move remoteObjectId string to constants
         query.addOrderBy("notePostedTimestamp", true);
     }
 
 
     /**
      * Retrieve a Collection of note instances found by a query.
      *
      * @param query
      * @return
      */
     @SuppressWarnings("unchecked")
     private Collection<Note> findCollection(Query query) throws DataAccessException {
         return getPersistenceBrokerTemplate().getCollectionByQuery(query);
     }
 }