Application: gvSIG desktop

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2020 gvSIG Association.

 *

 * 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 3

 * 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., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.fmap.dal.store.dbf.utils;

import org.gvsig.fmap.dal.feature.exception.AttributeFeatureTypeNotSuportedException;

import static org.gvsig.fmap.dal.store.dbf.utils.FieldFormatter.BOOLEAN_SIZE;

import static org.gvsig.fmap.dal.store.dbf.utils.FieldFormatter.DATE_SIZE;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 * Class for holding the information assicated with a record.

 */

public class DbaseFieldDescriptor {

  private static final Logger LOGGER = LoggerFactory.getLogger(DbaseFieldDescriptor.class);

  public static final char DBFTYPE_STRING = 'C';

  public static final char DBFTYPE_NUMBER = 'N';

  public static final char DBFTYPE_FLOAT = 'F';

  public static final char DBFTYPE_DATE = 'D';

  public static final char DBFTYPE_BOOLEAN = 'L';

  public static final char DBFTYPE_LONG = 'l';

  public static final char DBFTYPE_DOUBLE = 'O';

  public static final char DBFTYPE_TIMESTAMP = '@';

  public static final char DBFTYPE_AUTOINCREMENT = '+';

  // Field Name

  private String name;

  private String name_trim;

  // Field Type (C N L D F or M)

  private char type;

  // Field Data Address offset from the start of the record.

  private int offsetInRecord;

  // Length of the data in bytes

  private int size;

  private int precision;

  private int scale;

  public String getName() {

    return this.name.trim();

  }

  public int getSize() {

    switch (this.getType()) {

      case DBFTYPE_FLOAT:

      case DBFTYPE_NUMBER:

        if( this.scale < 1 ) {

          return this.precision+1; // -XXX

        } else {

          return this.precision+3; // -0.XXX

        }

    }

    return this.size;

  }

  public int getScale() {

    return this.scale;

  }

  public int getPrecision() {

    return this.precision;

  }

  public char getType() {

    return this.type;

  }

  public int getOffsetInRecord() {

    return this.offsetInRecord;

  }

  public String getName_trim() {

    return name_trim;

  }

  public void setName(String name) {

    this.name = name;

  }

  public void setName_trim(String name_trim) {

    this.name_trim = name_trim;

  }

  public void setType(char type) throws AttributeFeatureTypeNotSuportedException {

    switch(type) {

      case DBFTYPE_NUMBER:

      case DBFTYPE_FLOAT:

      case DBFTYPE_STRING:

      case DBFTYPE_DATE:

      case DBFTYPE_BOOLEAN:

        this.type = type;

        break;

      case 'c':        

        this.type = DBFTYPE_STRING;

        break;

      case 'S':        

      case 's':        

        warn("Field type for " + name + " set to S which is flat out wrong people!, I am setting this to C, in the hopes you meant character.");        

        this.type = DBFTYPE_STRING;

        break;

      case 'd':        

        this.type = DBFTYPE_DATE;

        break;

      case 'f':        

        this.type = DBFTYPE_FLOAT;

        break;

      case 'n':

        this.type = DBFTYPE_NUMBER;

        break;

      case 'l':

        this.type = DBFTYPE_BOOLEAN;

        break;

      default:

        throw new AttributeFeatureTypeNotSuportedException(name, type, "unknown", "DBF");        

    }

  }

  public void setOffsetInRecord(int offsetInRecord) {

    this.offsetInRecord = offsetInRecord;

  }

  public void setSize(int size) {

    switch(this.getType()) {

      case DBFTYPE_FLOAT:

      case DBFTYPE_NUMBER:

        this.size = size;

        break;

      case DBFTYPE_STRING:

        if (size > 254) {

            warn("Field Length for " + this.name + " set to " + size + " Which is longer than 254, not consistent with dbase III");

        }

        this.size = size;

        break;

      case DBFTYPE_DATE:

        this.size = DATE_SIZE;

        break;

      case DBFTYPE_BOOLEAN:

        this.size = BOOLEAN_SIZE;

        break;

      default:

        this.size = size;

    }

  }

  public void setScale(int scale) {

    switch(this.getType()) {

      case DBFTYPE_FLOAT:

      case DBFTYPE_NUMBER:

        this.scale = scale;

        break;

      default:

        this.scale = 0;

    }

  }

  public void calculateScaleAndPrecission() {

    switch(this.getType()) {

      case DBFTYPE_FLOAT:

      case DBFTYPE_NUMBER:

        if( this.size>0 ) {

          if( this.scale<1 ) {

            this.precision = this.size -1;

          } else {

            this.precision = this.size -3;

          }

          this.size = 0;

        }

        break;

      default:

        this.scale = 0;

    }

  }

  public void setPrecision(int precision) {

    switch(this.getType()) {

      case DBFTYPE_FLOAT:

      case DBFTYPE_NUMBER:

        if( precision>250 ) {

          this.precision = 250;

        } else {

          this.precision = precision;

        }

        break;

      default:

        this.precision = 0;

    }

  }

  private void warn(String msg) {

      LOGGER.warn(msg);

  }

}