/*

  * Copyright 2005-2007 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.kew.docsearch;

 import java.sql.Date;

 import java.sql.ResultSet;

 import java.sql.SQLException;

 import java.sql.Timestamp;

 import java.text.DateFormat;

 import java.text.ParseException;

 import java.text.SimpleDateFormat;

 import java.util.Calendar;

 import javax.persistence.CascadeType;

 import javax.persistence.Column;

 import javax.persistence.Entity;

 import javax.persistence.FetchType;

 import javax.persistence.Id;

 import javax.persistence.JoinColumn;

 import javax.persistence.ManyToOne;

 import javax.persistence.NamedQueries;

 import javax.persistence.NamedQuery;

 import javax.persistence.PrePersist;

 import javax.persistence.Table;

 import javax.persistence.Transient;

 import org.apache.commons.lang.StringUtils;

 import org.kuali.rice.core.jdbc.SqlBuilder;

 import org.kuali.rice.core.jpa.annotations.Sequence;

 import org.kuali.rice.core.util.OrmUtils;

 import org.kuali.rice.core.util.RiceConstants;

 import org.kuali.rice.kew.bo.WorkflowPersistable;

 import org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue;

 import org.kuali.rice.kew.service.KEWServiceLocator;

 import org.kuali.rice.kew.util.Utilities;

 import org.kuali.rice.kns.service.KNSServiceLocator;

 /**

  *

  * @author Kuali Rice Team (rice.collab@kuali.org)

  */

 @Entity

 @Table(name="KREW_DOC_HDR_EXT_DT_T")

 @Sequence(name="KREW_SRCH_ATTR_S",property="searchableAttributeValueId")

 @NamedQueries({

         @NamedQuery(name="SearchableAttributeDateTimeValue.FindByRouteHeaderId", query="select s from SearchableAttributeDateTimeValue as s where s.routeHeaderId = :routeHeaderId"),

         @NamedQuery(name="SearchableAttributeDateTimeValue.FindByKey", query="select s from SearchableAttributeDateTimeValue as s where s.routeHeaderId = :routeHeaderId and s.searchableAttributeKey = :searchableAttributeKey")

 })

 public class SearchableAttributeDateTimeValue implements WorkflowPersistable, SearchableAttributeValue {

     private static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(SearchableAttributeDateTimeValue.class);

     private static final long serialVersionUID = 3045621112943214772L;

     private static final String ATTRIBUTE_DATABASE_TABLE_NAME = "KREW_DOC_HDR_EXT_DT_T";

     private static final boolean DEFAULT_WILDCARD_ALLOWANCE_POLICY = false;

     private static final boolean ALLOWS_RANGE_SEARCH = true;

     private static final boolean ALLOWS_CASE_INSENSITIVE_SEARCH = false;

     private static final String ATTRIBUTE_XML_REPRESENTATION = SearchableAttribute.DATA_TYPE_DATE;

     @Id

         @Column(name="DOC_HDR_EXT_DT_ID")

         private Long searchableAttributeValueId;

     @Column(name="KEY_CD")

         private String searchableAttributeKey;

         @Column(name="VAL")

         private Timestamp searchableAttributeValue;

     @Transient

     protected String ojbConcreteClass; // attribute needed for OJB polymorphism - do not alter!

     @Column(name="DOC_HDR_ID")

         private Long routeHeaderId;

     @ManyToOne(fetch=FetchType.EAGER, cascade={CascadeType.PERSIST})

         @JoinColumn(name="DOC_HDR_ID", insertable=false, updatable=false)

         private DocumentRouteHeaderValue routeHeader;

     /**

      * Default constructor.

      */

     public SearchableAttributeDateTimeValue() {

         super();

         this.ojbConcreteClass = this.getClass().getName();

     }

     /* (non-Javadoc)

      * @see org.kuali.rice.kew.docsearch.SearchableAttributeValue#setupAttributeValue(java.lang.String)

      */

     public void setupAttributeValue(String value) {

         this.setSearchableAttributeValue(convertStringToTimestamp(value));

     }

     private Timestamp convertStringToTimestamp(String value) {

         if (Utilities.isEmpty(value)) {

             return null;

         } else {

             Timestamp t;

             try {

                     t = KNSServiceLocator.getDateTimeService().convertToSqlTimestamp(value);

             } catch (ParseException e) {

                     t = null;

             }

             if (t == null) {

                 String errorMsg = "Error converting timestamp value '" + value + "' to valid timestamp object.";

                 LOG.error("setupAttributeValue() " + errorMsg);

                 throw new RuntimeException(errorMsg);

             }

             return t;

         }

     }

         /* (non-Javadoc)

          * @see org.kuali.rice.kew.docsearch.SearchableAttributeValue#setupAttributeValue(java.sql.ResultSet, java.lang.String)

          */

         public void setupAttributeValue(ResultSet resultSet, String columnName) throws SQLException {

                 Calendar c = Calendar.getInstance();

                 c.clear(Calendar.HOUR);

                 c.clear(Calendar.MINUTE);

                 c.clear(Calendar.SECOND);

                 c.clear(Calendar.MILLISECOND);

                 this.setSearchableAttributeValue(resultSet.getTimestamp(columnName, c));

         }

         /* (non-Javadoc)

          * @see org.kuali.rice.kew.docsearch.SearchableAttributeValue#getSearchableAttributeDisplayValue()

          */

     public String getSearchableAttributeDisplayValue() {

         return formatAttributeValue(null);

     }

     private String formatAttributeValue(String formatPattern) {

         DateFormat df = getDateFormatToUse(formatPattern);

         return df.format(new Date(getSearchableAttributeValue().getTime()));

     }

     private DateFormat getDateFormatToUse(String parameterFormatPattern) {

         if (StringUtils.isNotBlank(parameterFormatPattern)) {

             return new SimpleDateFormat(parameterFormatPattern);

         }

         return RiceConstants.getDefaultDateFormat();

     }

         /* (non-Javadoc)

          * @see org.kuali.rice.kew.docsearch.SearchableAttributeValue#getAttributeDataType()

          */

         public String getAttributeDataType() {

                 return ATTRIBUTE_XML_REPRESENTATION;

         }

         /* (non-Javadoc)

          * @see org.kuali.rice.kew.docsearch.SearchableAttributeValue#getAttributeTableName()

          */

         public String getAttributeTableName() {

                 return ATTRIBUTE_DATABASE_TABLE_NAME;

         }

     /* (non-Javadoc)

          * @see org.kuali.rice.kew.docsearch.SearchableAttributeValue#allowsWildcardsByDefault()

          */

         public boolean allowsWildcards() {

                 return DEFAULT_WILDCARD_ALLOWANCE_POLICY;

         }

     /* (non-Javadoc)

          * @see org.kuali.rice.kew.docsearch.SearchableAttributeValue#allowsCaseInsensitivity()

          */

         public boolean allowsCaseInsensitivity() {

                 return ALLOWS_CASE_INSENSITIVE_SEARCH;

         }

         /* (non-Javadoc)

          * @see org.kuali.rice.kew.docsearch.SearchableAttributeValue#allowsRangeSearches()

          */

         public boolean allowsRangeSearches() {

                 return ALLOWS_RANGE_SEARCH;

         }

         /* (non-Javadoc)

          * @see org.kuali.rice.kew.docsearch.SearchableAttributeValue#isPassesDefaultValidation()

          */

     public boolean isPassesDefaultValidation(String valueEntered) {

             return new SqlBuilder().isValidDate(valueEntered);

         //return (DocSearchUtils.getEntryFormattedDate(valueEntered) != null);

     }

     /* (non-Javadoc)

      * @see org.kuali.rice.kew.docsearch.SearchableAttributeValue#isRangeValid(java.lang.String, java.lang.String)

      */

     public Boolean isRangeValid(String lowerValue, String upperValue) {

         if (allowsRangeSearches()) {

             Timestamp lowerTime = convertStringToTimestamp(lowerValue);

             Timestamp upperTime = convertStringToTimestamp(upperValue);

             if ( (lowerTime != null) && (upperTime != null) ) {

                 return (lowerTime.compareTo(upperTime) <= 0);

             }

             return true;

         }

         return null;

     }

         public String getOjbConcreteClass() {

         return ojbConcreteClass;

     }

     public void setOjbConcreteClass(String ojbConcreteClass) {

         this.ojbConcreteClass = ojbConcreteClass;

     }

     public DocumentRouteHeaderValue getRouteHeader() {

         return routeHeader;

     }

     public void setRouteHeader(DocumentRouteHeaderValue routeHeader) {

         this.routeHeader = routeHeader;

     }

     public Long getRouteHeaderId() {

         return routeHeaderId;

     }

     public void setRouteHeaderId(Long routeHeaderId) {

         this.routeHeaderId = routeHeaderId;

     }

     public String getSearchableAttributeKey() {

         return searchableAttributeKey;

     }

     public void setSearchableAttributeKey(String searchableAttributeKey) {

         this.searchableAttributeKey = searchableAttributeKey;

     }

     public Timestamp getSearchableAttributeValue() {

         return searchableAttributeValue;

     }

     public void setSearchableAttributeValue(Timestamp searchableAttributeValue) {

         this.searchableAttributeValue = searchableAttributeValue;

     }

     public Long getSearchableAttributeValueId() {

         return searchableAttributeValueId;

     }

     public void setSearchableAttributeValueId(Long searchableAttributeValueId) {

         this.searchableAttributeValueId = searchableAttributeValueId;

     }

     /* (non-Javadoc)

      * @see org.kuali.rice.kew.WorkflowPersistable#copy(boolean)

      */

     public Object copy(boolean preserveKeys) {

         return null;

     }

         @PrePersist

         public void beforeInsert(){

                 OrmUtils.populateAutoIncValue(this, KEWServiceLocator.getEntityManagerFactory().createEntityManager());

         }

 }