/*

  * 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.ResultSet;

 import java.sql.SQLException;

 import java.util.Map;

 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.kuali.rice.core.jpa.annotations.Sequence;

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

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

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

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

 /**

  *

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

  */

 @Entity

 @Table(name="KREW_DOC_HDR_EXT_T")

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

 @NamedQueries({

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

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

 })

 public class SearchableAttributeStringValue implements WorkflowPersistable, SearchableAttributeValue {

     private static final long serialVersionUID = 8696089933682052078L;

     private static final String ATTRIBUTE_DATABASE_TABLE_NAME = "KREW_DOC_HDR_EXT_T";

     private static final boolean DEFAULT_WILDCARD_ALLOWANCE_POLICY = true;

     private static final boolean ALLOWS_RANGE_SEARCH = true;

     private static final boolean ALLOWS_CASE_INSENSITIVE_SEARCH = true;

     private static final String ATTRIBUTE_XML_REPRESENTATION = SearchableAttribute.DATA_TYPE_STRING;

     private static final int STRING_MAX_LENGTH = 2000; // should match table creation

     @Id

         @Column(name="DOC_HDR_EXT_ID")

         private Long searchableAttributeValueId;

     @Column(name="KEY_CD")

         private String searchableAttributeKey;

     @Column(name="VAL")

         private String 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 SearchableAttributeStringValue() {

             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(value);

     }

         /* (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 {

                 this.setSearchableAttributeValue(resultSet.getString(columnName));

         }

         /* (non-Javadoc)

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

          */

     public String getSearchableAttributeDisplayValue() {

         return getSearchableAttributeValue();

     }

         /* (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;

         }

         /**

          * @return true if the {@code valueEntered} parameter is not null and is equal to or

          * less than the specified max length defined by {@link #STRING_MAX_LENGTH}

          *

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

          */

         public boolean isPassesDefaultValidation(String valueEntered) {

             if (valueEntered != null && (valueEntered.length() > STRING_MAX_LENGTH)) {

                 return false;

             }

                 return true;

         }

     /* (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()) {

             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 String getSearchableAttributeValue() {

                 return searchableAttributeValue;

         }

         public void setSearchableAttributeValue(String 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());

         }

 }