| gvSIG desktop 1

/*

 *    Geotools - OpenSource mapping toolkit

 *    (C) 2002, Centre for Computational Geography

 *

 *    This library is free software; you can redistribute it and/or

 *    modify it under the terms of the GNU Lesser General Public

 *    License as published by the Free Software Foundation;

 *    version 2.1 of the License.

 *

 *    This library 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

 *    Lesser General Public License for more details.

 *

 *    You should have received a copy of the GNU Lesser General Public

 *    License along with this library; if not, write to the Free Software

 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 *

 *    This file is based on an origional contained in the GISToolkit project:

 *    http://gistoolkit.sourceforge.net/

 *

 */

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2004 IVER T.I. and Generalitat Valenciana.

 *

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

 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

package org.gvsig.data.datastores.vectorial.file.dbf.utils;

import java.io.IOException;

import java.nio.ByteBuffer;

import java.nio.MappedByteBuffer;

import java.nio.channels.FileChannel;

import java.nio.channels.WritableByteChannel;

import java.nio.charset.Charset;

import java.text.FieldPosition;

import java.text.NumberFormat;

import java.util.Calendar;

import java.util.Date;

import java.util.Iterator;

import java.util.Locale;

import org.gvsig.data.exception.CloseException;

import org.gvsig.data.exception.InitializeWriterException;

import org.gvsig.data.exception.UnsupportedEncodingException;

import org.gvsig.data.exception.WriteException;

import org.gvsig.data.vectorial.DefaultAttributeDescriptor;

import org.gvsig.data.vectorial.IFeature;

import org.gvsig.data.vectorial.IFeatureAttributeDescriptor;

import org.gvsig.data.vectorial.IFeatureType;

/** A DbaseFileReader is used to read a dbase III format file.

 * The general use of this class is:

 * <CODE><PRE>

 * DbaseFileHeader header = ...

 * WritableFileChannel out = new FileOutputStream("thefile.dbf").getChannel();

 * DbaseFileWriter w = new DbaseFileWriter(header,out);

 * while ( moreRecords ) {

 *   w.write( getMyRecord() );

 * }

 * w.close();

 * </PRE></CODE>

 * You must supply the <CODE>moreRecords</CODE> and <CODE>getMyRecord()</CODE>

 * logic...

 * @author Ian Schneider

 */

public class DbaseFileWriter  {

  private DbaseFileHeader header;

  private DbaseFileWriter.FieldFormatter formatter = new DbaseFileWriter.FieldFormatter();

  WritableByteChannel channel;

  private ByteBuffer buffer;

  private final Number NULL_NUMBER = new Integer(0);

  private final String NULL_STRING = "";

  private final String NULL_DATE = "        ";

  // TODO: READ HEADER AND STABLIST THE RIGHT CHARSET

  private Charset charset = Charset.forName("ISO-8859-1");

  /** Create a DbaseFileWriter using the specified header and writing to the given

   * channel.

   * @param header The DbaseFileHeader to write.

   * @param out The Channel to write to.

 * @throws InitializeWriterException

   * @throws IOException If errors occur while initializing.

   */

  public DbaseFileWriter(DbaseFileHeader header,FileChannel out) throws InitializeWriterException {

    try {

                header.writeHeader(out);

        } catch (IOException e) {

                throw new InitializeWriterException("DBF Writer",e);

        }

    this.header = header;

    this.channel = out;

    init();

  }

  private void init() throws InitializeWriterException {

          try{

    buffer = ByteBuffer.allocateDirect(header.getRecordLength());

          }catch (Exception e) {

                throw new InitializeWriterException("DBF Writer",e);

        }

  }

  private void write() throws WriteException {

    buffer.position(0);

    int r = buffer.remaining();

    try {

                while ( (r -= channel.write(buffer)) > 0) {

                  ; // do nothing

                }

        } catch (IOException e) {

                throw new WriteException("DBF Writer",e);

        }

  }

  /** Write a single dbase record.

   * @param record The entries to write.

 * @throws UnsupportedEncodingException

 * @throws WriteException

 * @throws UnsupportedEncodingDriverException

   * @throws IOException If IO error occurs.

   * @throws DbaseFileException If the entry doesn't comply to the header.

   */

  public void write(IFeature feature) throws WriteException, UnsupportedEncodingException{

          IFeatureType featureType=feature.getType();

    buffer.position(0);

    // put the 'not-deleted' marker

    buffer.put( (byte) ' ');

    Iterator iterator=featureType.iterator();

   int i=0;

   int jGeom=0;

   while (iterator.hasNext()) {

           IFeatureAttributeDescriptor fad = (IFeatureAttributeDescriptor) iterator.next();

           String type=fad.getDataType();

           i=((DefaultAttributeDescriptor)fad).originalPosition();

//           int i=fad.ordinal();

           if (featureType.getDefaultGeometry()!=null && featureType.getDefaultGeometry().equals(fad.getName())){

                   jGeom++;

                   continue;

           }

           String fieldString = fieldString(type, feature, i-jGeom);

           if (fieldString==null){

                   if (type==IFeatureAttributeDescriptor.TYPE_STRING){

                           fieldString = NULL_STRING;

                   }else if (type==IFeatureAttributeDescriptor.TYPE_DATE){

                           fieldString = NULL_DATE;

                   }else{

                           fieldString = "0";

                   }

           }

           try {

                   buffer.put(fieldString.getBytes(charset.name()));

           } catch (java.io.UnsupportedEncodingException e) {

                   throw new UnsupportedEncodingException("DBF Writer",e);

           }

           i++;

   }

    write();

  }

  /** Write a single dbase record. Useful to update a dbf.

   * @param record The entries to write.

 * @throws WriteException

 * @throws UnsupportedEncodingException

 * @throws

   * @throws IOException If IO error occurs.

   * @throws DbaseFileException If the entry doesn't comply to the header.

   */

  public void writeRecord(IFeature feature, int numReg) throws WriteException, UnsupportedEncodingException{

        IFeatureType featureType=feature.getType();

        if (!(channel instanceof FileChannel)) {

              throw new WriteException("DBF Writer",new IOException("DbaseFileWriterNIO: channel is not a FileChannel. Cannot position properly"));

        }

    if (featureType.size() != header.getNumFields()) {

      throw new WriteException("DBF Writer",new IOException("Wrong number of fields " + featureType.size() +

      " expected " +  header.getNumFields()));

    }

    FileChannel fileChannel = (FileChannel) channel;

    long newPos = header.getHeaderLength() + numReg*header.getRecordLength();

    buffer.position(0);

    // put the 'not-deleted' marker

    buffer.put( (byte) ' ');

    Iterator iterator=featureType.iterator();

    while (iterator.hasNext()) {

            IFeatureAttributeDescriptor fad = (IFeatureAttributeDescriptor) iterator.next();

            int i=((DefaultAttributeDescriptor)fad).originalPosition();

            String type=fad.getDataType();

            String fieldString = fieldString(type, feature, i);

            try {

                        buffer.put(fieldString.getBytes(charset.name()));

                } catch (java.io.UnsupportedEncodingException e) {

                        throw new UnsupportedEncodingException("DBF",e);

                }

        }

    try {

                fileChannel.write(buffer, newPos);

        } catch (IOException e) {

                throw new WriteException("DBF Writer",e);

        }

  }

  private String fieldString(String type,IFeature feature,int i){

          final int fieldLen = header.getFieldLength(i);

          String fieldString="";

          if (IFeatureAttributeDescriptor.TYPE_BOOLEAN==type){

                  boolean b=feature.getBoolean(i);

                  if (b)

                          fieldString="T";

                  else

                          fieldString="F";

          }else if (IFeatureAttributeDescriptor.TYPE_BYTE==type){

                  fieldString=String.valueOf(feature.getByte(i));

          }else if (IFeatureAttributeDescriptor.TYPE_DATE==type){

                  Date date=feature.getDate(i);

                  fieldString=formatter.getFieldString(date);

          }else if (IFeatureAttributeDescriptor.TYPE_DOUBLE==type){

                  double d=feature.getDouble(i);

                  fieldString= formatter.getFieldString(fieldLen,

                                header.getFieldDecimalCount(i),

                                        d);

          }else if (IFeatureAttributeDescriptor.TYPE_FLOAT==type){

                  float f=feature.getFloat(i);

                  fieldString= formatter.getFieldString(fieldLen,

                                header.getFieldDecimalCount(i),

                                        f);

          }else if (IFeatureAttributeDescriptor.TYPE_INT==type){

                  int integer=feature.getInt(i);

                  fieldString= formatter.getFieldString(fieldLen,

                                header.getFieldDecimalCount(i),

                                        integer);

          }else if (IFeatureAttributeDescriptor.TYPE_LONG==type){

                  long l=feature.getLong(i);

                  fieldString= formatter.getFieldString(fieldLen,

                                header.getFieldDecimalCount(i),

                                        l);

          }else if (IFeatureAttributeDescriptor.TYPE_STRING==type){

                  String s=feature.getString(i);

                  fieldString =formatter.getFieldString(

                          fieldLen, s);

          }

          return fieldString;

  }

//  private String fieldString(Object obj,final int col) {

//    String o;

//    final int fieldLen = header.getFieldLength(col);

//    switch (header.getFieldType(col)) {

//      case 'C':

//      case 'c':

//        o = formatter.getFieldString(

//          fieldLen,

//          (obj instanceof NullValue)? NULL_STRING : ((StringValue) obj).getValue()

//        );

//        break;

//      case 'L':

//      case 'l':

//        o = (obj instanceof NullValue) ? "F" : ((BooleanValue)obj).getValue() == true ? "T" : "F";

//        break;

//      case 'M':

//      case 'G':

//        o = formatter.getFieldString(

//          fieldLen,

//          (obj instanceof NullValue) ? NULL_STRING : ((StringValue) obj).getValue()

//        );

//        break;

//     /* case 'N':

//      case 'n':

//        // int?

//        if (header.getFieldDecimalCount(col) == 0) {

//

//          o = formatter.getFieldString(

//            fieldLen, 0, (Number) (obj == null ? NULL_NUMBER : Double.valueOf(obj.toString()))

//          );

//          break;

//

//         }

//      */

//      case 'N':

//      case 'n':

//      case 'F':

//      case 'f':

//            Number number = null;

//            if(obj instanceof NullValue){

//                    number = NULL_NUMBER;

//            }else{

//                    NumericValue gVal = (NumericValue) obj;

//                    number = new Double(gVal.doubleValue());

//            }

//        o = formatter.getFieldString(fieldLen,

//                        header.getFieldDecimalCount(col),

//                                number);

//        break;

//      case 'D':

//      case 'd':

//          if (obj instanceof NullValue)

//              o = NULL_DATE;

//          else

//              o = formatter.getFieldString(((DateValue)obj).getValue());

//        break;

//      default:

//        throw new RuntimeException("Unknown type " + header.getFieldType(col));

//    }

//

//    return o;

//  }

  /** Release resources associated with this writer.

   * <B>Highly recommended</B>

 * @throws CloseException

   * @throws IOException If errors occur.

   */

  public void close() throws CloseException {

      // IANS - GEOT 193, bogus 0x00 written. According to dbf spec, optional

      // eof 0x1a marker is, well, optional. Since the original code wrote a

      // 0x00 (which is wrong anyway) lets just do away with this :)

      // - produced dbf works in OpenOffice and ArcExplorer java, so it must

      // be okay.

//    buffer.position(0);

//    buffer.put((byte) 0).position(0).limit(1);

//    write();

    try {

                channel.close();

        } catch (IOException e) {

                throw new CloseException("DBF Writer",e);

        }

    if (buffer instanceof MappedByteBuffer) {

     // NIOUtilities.clean(buffer);

    }

    buffer = null;

    channel = null;

    formatter = null;

  }

  /** Utility for formatting Dbase fields. */

  public static class FieldFormatter {

    private StringBuffer buffer = new StringBuffer(255);

    private NumberFormat numFormat = NumberFormat.getNumberInstance(Locale.US);

    private Calendar calendar = Calendar.getInstance(Locale.US);

    private String emtpyString;

    private static final int MAXCHARS = 255;

    public FieldFormatter() {

      // Avoid grouping on number format

      numFormat.setGroupingUsed(false);

      // build a 255 white spaces string

      StringBuffer sb = new StringBuffer(MAXCHARS);

      sb.setLength(MAXCHARS);

      for(int i = 0; i < MAXCHARS; i++) {

        sb.setCharAt(i, ' ');

      }

      emtpyString = sb.toString();

    }

    public String getFieldString(int size, String s) {

      buffer.replace(0, size, emtpyString);

      buffer.setLength(size);

      if(s != null) {

        buffer.replace(0, size, s);

        if(s.length() <= size) {

          for(int i = s.length(); i < size; i++) {

            buffer.append(' ');

          }

        }

      }

      buffer.setLength(size);

      return buffer.toString();

    }

    public String getFieldString(Date d) {

      if(d != null) {

        buffer.delete(0, buffer.length());

        calendar.setTime(d);

        int year = calendar.get(Calendar.YEAR);

        int month = calendar.get(Calendar.MONTH) + 1;  // returns 0 based month?

        int day = calendar.get(Calendar.DAY_OF_MONTH);

        if(year < 1000) {

          if(year >= 100) {

            buffer.append("0");

          } else if(year >= 10) {

            buffer.append("00");

          } else {

            buffer.append("000");

          }

        }

        buffer.append(year);

        if(month < 10) {

          buffer.append("0");

        }

        buffer.append(month);

        if(day < 10) {

          buffer.append("0");

        }

        buffer.append(day);

      } else {

        buffer.setLength(8);

        buffer.replace(0, 8, emtpyString);

      }

      buffer.setLength(8);

      return buffer.toString();

    }

    public String getFieldString(int size, int decimalPlaces, double n) {

      buffer.delete(0, buffer.length());

//      if (n != null) {

        numFormat.setMaximumFractionDigits(decimalPlaces);

        numFormat.setMinimumFractionDigits(decimalPlaces);

        numFormat.format(n, buffer, new FieldPosition(NumberFormat.INTEGER_FIELD));

//      }

      int diff = size - buffer.length();

      if (diff >= 0) {

          while (diff-- > 0) {

              buffer.insert(0, ' ');

          }

      } else {

          buffer.setLength(size);

      }

      return buffer.toString();

    }

  }

public void setCharset(Charset charset) {

        this.charset = charset;

}

}