001/**
002 * Copyright 2005-2015 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.kew.docsearch;
017
018import org.kuali.rice.kew.api.KewApiConstants;
019import org.kuali.rice.kew.api.document.attribute.DocumentAttributeDecimal;
020import org.kuali.rice.kew.api.document.attribute.DocumentAttributeFactory;
021
022import javax.persistence.AttributeOverride;
023import javax.persistence.AttributeOverrides;
024import javax.persistence.Column;
025import javax.persistence.Entity;
026import javax.persistence.Inheritance;
027import javax.persistence.InheritanceType;
028import javax.persistence.NamedQueries;
029import javax.persistence.NamedQuery;
030import javax.persistence.Table;
031import java.io.Serializable;
032import java.math.BigDecimal;
033import java.sql.ResultSet;
034import java.sql.SQLException;
035import java.text.DecimalFormat;
036import java.text.NumberFormat;
037import java.util.regex.Pattern;
038
039/**
040 *
041 * @author Kuali Rice Team (rice.collab@kuali.org)
042 */
043@Entity
044@Inheritance(strategy= InheritanceType.TABLE_PER_CLASS)
045@Table(name="KREW_DOC_HDR_EXT_FLT_T")
046@NamedQueries({
047        @NamedQuery(name="SearchableAttributeFloatValue.FindByDocumentId", query="select s from "
048            + "SearchableAttributeFloatValue as s where s.documentId = :documentId"),
049        @NamedQuery(name="SearchableAttributeFloatValue.FindByKey", query="select s from "
050            + "SearchableAttributeFloatValue as s where s.documentId = :documentId and "
051            + "s.searchableAttributeKey = :searchableAttributeKey")
052})
053@AttributeOverrides({
054        @AttributeOverride(name="searchableAttributeValueId", column=@Column(name="DOC_HDR_EXT_FLT_ID"))
055})
056public class SearchableAttributeFloatValue extends SearchableAttributeNumericBase implements SearchableAttributeValue, Serializable {
057
058    private static final long serialVersionUID = -6682101853805320760L;
059
060    private static final String ATTRIBUTE_DATABASE_TABLE_NAME = "KREW_DOC_HDR_EXT_FLT_T";
061    private static final boolean DEFAULT_WILDCARD_ALLOWANCE_POLICY = false;
062    private static final boolean ALLOWS_RANGE_SEARCH = true;
063    private static final boolean ALLOWS_CASE_INSENSITIVE_SEARCH = false;
064    private static final String ATTRIBUTE_XML_REPRESENTATION = KewApiConstants.SearchableAttributeConstants.DATA_TYPE_FLOAT;
065    private static final String DEFAULT_FORMAT_PATTERN = "";
066
067    private static final String DEFAULT_VALIDATION_REGEX_EXPRESSION = "[-+]?[0-9]*\\.?[0-9]+";
068    private static final Pattern defaultValidationPattern = Pattern.compile(DEFAULT_VALIDATION_REGEX_EXPRESSION);
069
070    @Column(name="VAL")
071        private BigDecimal searchableAttributeValue;
072
073    /**
074     * Default constructor.
075     */
076    public SearchableAttributeFloatValue() {
077        super();
078        this.ojbConcreteClass = this.getClass().getName();
079    }
080
081    @Override
082    public void setupAttributeValue(String value) {
083        this.setSearchableAttributeValue(convertStringToBigDecimal(value));
084    }
085
086    private BigDecimal convertStringToBigDecimal(String value) {
087        if (org.apache.commons.lang.StringUtils.isEmpty(value)) {
088            return null;
089        } else {
090            return new BigDecimal(value);
091        }
092    }
093
094    @Override
095        public void setupAttributeValue(ResultSet resultSet, String columnName) throws SQLException {
096                this.setSearchableAttributeValue(resultSet.getBigDecimal(columnName));
097        }
098
099    @Override
100    public String getSearchableAttributeDisplayValue() {
101            NumberFormat format = DecimalFormat.getInstance();
102            ((DecimalFormat)format).toPattern();
103            ((DecimalFormat)format).applyPattern(DEFAULT_FORMAT_PATTERN);
104            return format.format(getSearchableAttributeValue().doubleValue());
105        }
106
107    @Override
108        public String getAttributeDataType() {
109                return ATTRIBUTE_XML_REPRESENTATION;
110        }
111
112    @Override
113        public String getAttributeTableName() {
114                return ATTRIBUTE_DATABASE_TABLE_NAME;
115        }
116
117    @Override
118        public boolean allowsWildcards() {
119                return DEFAULT_WILDCARD_ALLOWANCE_POLICY;
120        }
121
122    @Override
123        public boolean allowsCaseInsensitivity() {
124                return ALLOWS_CASE_INSENSITIVE_SEARCH;
125        }
126
127    @Override
128        public boolean allowsRangeSearches() {
129                return ALLOWS_RANGE_SEARCH;
130        }
131
132    @Override
133    public Boolean isRangeValid(String lowerValue, String upperValue) {
134        if (allowsRangeSearches()) {
135            BigDecimal lower = null;
136            BigDecimal upper = null;
137            try{
138                lower = convertStringToBigDecimal(lowerValue);
139                upper = convertStringToBigDecimal(upperValue);
140            }catch(NumberFormatException ex){
141                return false;
142            }
143            if ( (lower != null) && (upper != null) ) {
144                return (lower.compareTo(upper) <= 0);
145            }
146            return true;
147        }
148        return null;
149    }
150
151    @Override
152    public BigDecimal getSearchableAttributeValue() {
153        return searchableAttributeValue;
154    }
155
156    public void setSearchableAttributeValue(BigDecimal searchableAttributeValue) {
157        this.searchableAttributeValue = searchableAttributeValue;
158    }
159
160    /**
161     * @deprecated USE method setSearchableAttributeValue(BigDecimal) instead
162     */
163    @Deprecated
164    public void setSearchableAttributeValue(Float floatValueToTranslate) {
165        this.searchableAttributeValue = null;
166        if (floatValueToTranslate != null) {
167            this.searchableAttributeValue = new BigDecimal(floatValueToTranslate.toString());
168        }
169    }
170
171    @Override
172    public DocumentAttributeDecimal toDocumentAttribute() {
173        return DocumentAttributeFactory.createDecimalAttribute(getSearchableAttributeKey(), getSearchableAttributeValue());
174    }
175
176    @Override
177    protected Pattern getDefaultValidationPattern() {
178        return defaultValidationPattern;
179    }
180}
181