Metacat

/**

 *  '$RCSfile$'

 *  Copyright: 2000 Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *

 * Author: John Harris

 * '$Date: 2006-02-24 16:55:55 -0800 (Fri, 24 Feb 2006) $'

 * '$Revision: 2919 $'

 *

 * 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

 */

package edu.ucsb.nceas.metacat.spatial;

import java.util.Vector;

import org.apache.log4j.Logger;

/**

 * Class that reflects a dataset of Metacat Documents in a spatially represented

 * sense.  This dataset class is comprised of multiple MetacatSpatialDocument 

 * and uses the PersistentMetacatSpatialDataset class for IO with databases

 * and the file system

 */

public class MetacatSpatialDataset {

  private boolean initialized = false;

  private static Logger log = Logger.getLogger(MetacatSpatialDataset.class.getName());

  private Vector docs; // vector of MetacatSpatialDocument's 

  /** empty constructor **/

  public MetacatSpatialDataset() {

    this.initialized = true;

    docs = new Vector();

  }

  /**

    * returns a string array of the docids 

    */

  public String[] getDocidList() {

    String[] s = new String[docs.size()];

    for (int i = 0; i < docs.size(); i++) {

        MetacatSpatialDocument _doc = (MetacatSpatialDocument)docs.elementAt(i);

        s[i] = _doc.getDocid();

    }

    return s;

  }

  /**

   * Returns docid's in a csv-formatted text string

   */

   public String toTXT () {

    StringBuffer _sb = new StringBuffer();

    for (int i = 0; i < docs.size(); i++) {

      MetacatSpatialDocument _doc = (MetacatSpatialDocument)docs.elementAt(i);

      if ( i==0 ) {

        _sb.append(_doc.getDocid());

      } else { 

        _sb.append(","+_doc.getDocid());

     }

    } 

    return _sb.toString();

   }

  /**

   * Returns XML as a String -- the xml describes the dataset

   */

   public String toXML () {

    StringBuffer _sb = new StringBuffer();

    _sb.append("<metacatspatialdataset>");

    for (int i = 0; i < docs.size(); i++) {

      MetacatSpatialDocument _doc = (MetacatSpatialDocument)docs.elementAt(i);

      _sb.append("<metacatspatialdocument>\n");

     _sb.append("<creator>");

     _sb.append(" <individualName>");

     _sb.append("   <givenName></givenName>");

     _sb.append("   <surName></surName>");

     _sb.append(" </individualName>");

     _sb.append(" <organizationName></organizationName>");

     _sb.append(" </creator>");

     _sb.append("<title>"+_doc.getTitle()+"</title>");

     _sb.append("<docid>"+_doc.getDocid()+"</docid>");

     _sb.append(" <extents>");

     _sb.append("   <ispoint>"+_doc.getIsPoint()+"</ispoint>");

     _sb.append("   <xmin>"+_doc.getXMin()+"</xmin>");

     _sb.append("   <ymin>"+_doc.getYMin()+"</ymin>");

     _sb.append("   <xmax>"+_doc.getXMax()+"</xmax>");

     _sb.append("   <ymax>"+_doc.getYMax()+"</ymax>");

     _sb.append(" </extents>\n");

      _sb.append("</metacatspatialdocument>");

    } 

    _sb.append("</metacatspatialdataset>");

    return _sb.toString();

   }

  /**

   * returns the document corresponding to the input index from this dataset

   */

  public MetacatSpatialDocument getDocument(int _id) {

    return (MetacatSpatialDocument)docs.elementAt(_id);

  }

  /*

   * Adds a new MetacatSpatialDocument to this dataset

   */

   public void add(MetacatSpatialDocument msdoc) {

    docs.add(msdoc);

   }

   /**

    * Returns the size (or number of documents) of the dataset

    */

    public int size() {

      return docs.size();

    }

  /**

   * returns the data set as a flat-ascii table like:

   *

   * x y z segid 

   *

   * the data are delimited by spaces and each line is terminated bt '\n'

   * out.println("#HEADER docid x y  url");

   */

  public StringBuffer getExtentsDataAsAscii() {

    StringBuffer _sb = new StringBuffer();

    for (int i = 0; i < docs.size(); i++) {

      MetacatSpatialDocument _doc = (MetacatSpatialDocument)docs.elementAt(i);

      try {

      if ( ! _doc.getIsPoint() ) {

        //_sb.append( _doc.getDocid()+" "+ _doc.getXMin()+ " " + _doc.getYMin() + " http://www.cnn.com \n");

        //_sb.append( _doc.getDocid()+" "+ _doc.getXMax()+ " " + _doc.getYMin() + " http://www.cnn.com \n");

        _sb.append( _doc.getDocid()+" "+ _doc.jitter(_doc.getXMax())+ " " 

          + _doc.jitter(_doc.getYMax()) + " " 

          + "http://"+_doc.getMetacatURL() + "metacat?action=read&docid="+_doc.getDocid()+"&qformat=knp"

          + " \n");

        //_sb.append( _doc.getDocid()+" "+ _doc.getXMin()+ " " + _doc.getYMax() + " http://www.cnn.com \n");

      }

      } catch (NullPointerException npe) {

        log.fatal("ERROR: null pointer exception on a spatial document");

        npe.getMessage();

      }

    }

    return _sb;

  }

  /**

   * writes the entire metacat spatial dataset 

   */

   public void writeMetacatSpatialCache() {

    // write the data stored in this object using the persistent layer

    PersistentMetacatSpatialDataset _writer = new PersistentMetacatSpatialDataset();

     _writer.writeMetacatSpatialCache(this);  

   }

  /*

   * Writes the dataset to the file system

   */

  public void writeTextQueryData() { 

    // write the data stored in this object using the persistent layer

    PersistentMetacatSpatialDataset _writer = new PersistentMetacatSpatialDataset();

     _writer.writeTextQueryData(this); 

  }

}