Metacat

/**

 *  '$RCSfile$'

 *  Copyright: 2003 Regents of the University of California.

 *

 * Author: John Harris

 * '$Date$'

 * '$Revision$'

 *

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

public class MetacatSpatialConstants {

  public static final float FLOAT_NULL = (float)1e20;

  /** like: nebulous.msi.ucsb.edu:9999 **/

  public static String servercontext;

  // default to off -- get from the metacat properties file 

  public static boolean runSpatialOption = false;

  //metacat?action=read&docid=knb2003.432.1&qformat=knb

  public static String metacatcontext = "knp";

  public static  void setServerContext(String _scontext) {

    servercontext = _scontext;

  }

  public static String getServerContext() { return servercontext; }

  public static String getMetacatContext() { return metacatcontext;}

}

/**

 *  '$RCSfile$'

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

 *             National Center for Ecological Analysis and Synthesis

 *

 * Author: John Harris 

 * '$Date$'

 * '$Revision$'

 *

 * 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.io.BufferedReader;

import java.io.FileReader;

import java.io.PrintStream;

import java.io.OutputStream;

import java.io.FileOutputStream;

import java.io.IOException;

import java.io.FileNotFoundException;

import org.apache.log4j.Logger;

/**

 * Class for doing IO of spatial data from.  IO can be with the FS in the 

 * case of a shapefile, and or with a DB (as in the case of a PostGIS 

 * entry or a Metacat Entry)

 *  

 * usage: metacat2shape metacat_export.txt test.shp

 *

 *   where:

 *

 *       input -- is an input ASCII file, that contains the following cols:

 *             -> docid -- the document id

 *             -> x -- the xlocation

 *             -> y -- the y location

 *             -> url -- the url to the document

 *                shapefile -- {output} is a ESRI shapefile

 *

 *             see:

 *             example: metacat2shape metacat_export.txt test.shp

 *

 *             ##><><><><><><><><><><><><><><><><><><><><><><><><>##

 *             ##           John Harris                           ##

 *             ##           harris@nceas.ucsb.edu                 ##

 *             ##           Copyright 1999-2003                   ##

 *             ##><><><><><><><><><><><><><><><><><><><><><><><><>##

 *                                                                       

 */

public class PersistentMetacatSpatialDataset {

  private String textQueryAsciiFile = "/tmp/mso_metacat_textquery.ascii";

  private String metacatTextQueryShapeFile = "/tmp/mso_metacat_textquery.shp";

  private String metacatSpatialCacheAsciiFile = "/tmp/mso_metacat_cache.ascii";

  private String metacatSpatialCacheShapeFile = "/tmp/mso_metacat_cache.shp";

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

  /*

   * Writes the dataset to the file system

   */

  public void writeMetacatSpatialCache(MetacatSpatialDataset dataset) {

  try {

    PrintStream out = new PrintStream(new FileOutputStream( metacatSpatialCacheAsciiFile));

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

    out.println( dataset.getExtentsDataAsAscii());

    log.fatal("extents data: " + dataset.getExtentsDataAsAscii() +" done" );

    out.close();

    // make the shapefile 

     String command = "metacat_shapefile "+metacatSpatialCacheAsciiFile+" "+metacatSpatialCacheShapeFile;

     try{

      Process p = Runtime.getRuntime().exec(command);

     }

     catch(IOException ioe){

         log.error("ERROR - writing the shapefile at: " + 

                 metacatSpatialCacheAsciiFile+" "+metacatSpatialCacheShapeFile);

         ioe.printStackTrace(); 

     }

  } catch (FileNotFoundException fnfe) {

    log.fatal("ERROR: could not find the file ");

    fnfe.printStackTrace();

  }  

  }

  /*

   * Writes the dataset to the file system

   */

  public void writeTextQueryData(MetacatSpatialDataset dataset) {

  try {

    PrintStream out = new PrintStream(new FileOutputStream(textQueryAsciiFile));

    out.println("#HEADER x y z segid");

    out.println( dataset.getExtentsDataAsAscii());

    out.close();

    // make the shapefile 

     String command = "metacat_shapefile "+textQueryAsciiFile+" "+metacatTextQueryShapeFile;

     try{

      Process p = Runtime.getRuntime().exec(command);

     }

     catch(IOException ioe){

         log.error("ERROR - writing the shapefile at: " + 

                 metacatSpatialCacheAsciiFile+" "+metacatSpatialCacheShapeFile);

         ioe.printStackTrace();

     }

  } catch (FileNotFoundException fnfe) {

    log.fatal("ERROR: could not find the file ");

    fnfe.printStackTrace();

  }  

  }

}

/**

 *  '$RCSfile$'

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

 *             National Center for Ecological Analysis and Synthesis

 *

 * Author: John Harris

 * '$Date$'

 * '$Revision$'

 *

 * 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 org.apache.log4j.Logger;

/**

 * Class that reflects a Metacat Document in a spatially represented sense.

 */

public class MetacatSpatialDocument {

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

  private String docid;

  private String title;

  private MetacatSpatialExtents extents;

  public MetacatSpatialDocument(String  docid) {

    setDocid(docid);

  }

  /**

   * function that registers the document with the Spatial system.  This is 

   * to be called when the document is inserted to the Metacat system.  At

   * registration time, this the Metacat Spatial Elements are requeruried, 

   * and the spatial database is repopulated

   */

  public void registerSpatialDocument() {

   log.info("Dataset " + docid + " is being registered with the metacat spatial system" ); 

  }

  public void setDocid(String _docid) {

    this.docid = _docid;

  }

  public void setExtents(MetacatSpatialExtents _extents) {

    this.extents = _extents;

  }

  /**

   * jitters a float value

   */

  public float jitter(float _val) {

    float _random = (float)Math.random();

    return _val+(_random/1000);

  }

  public String getMetacatURL() {

   return MetacatSpatialConstants.getServerContext()

   +"/"+MetacatSpatialConstants.getMetacatContext()+"/"; 

  }

  public String getTitle() { return this.title; }

  public void setTitle(String _title) {this.title = _title; }

  public float getXMin() { return extents.getXMin(); }

  public void setXMin(float x) { extents.setXMin(x); }

  public float getYMin() { return extents.getYMin(); }

  public void setYMin(float y) {extents.setYMin(y); }

  public float getXMax() { return extents.getXMax(); }

  public void setXMax(float x) {extents.setXMax(x); }

  public float getYMax() { return extents.getYMax(); }

  public void setYMax(float y) {extents.setYMax(y); }

  public String getDocid() { return this.docid; }

  public boolean getIsPoint() { return extents.getIsPoint(); }

  public void setIsPoint(boolean ispoint) { extents.setIsPoint(ispoint); }

}

/**

 *  '$RCSfile$'

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

 *             National Center for Ecological Analysis and Synthesis

 *

 * Author: John Harris 

 * '$Date$'

 * '$Revision$'

 *

 * 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 org.apache.log4j.Logger;

/**

 * Class that reflects a query against Metacat to gatther spatial data  -- this

 * could be a text query that returns a spatial dataset or a spatial query that

 * returns a spatially-referenced dataset.

 */

public class MetacatSpatialExtents {

  /** true if the document is represented by a single point and 

   *  false if is represented by a bouding box

   */

  private boolean isPoint = true;

  /** the coordinates of the bounding box, or of the point **/

  private float xmin, ymin, xmax, ymax; 

  /** the docid of the extents **/

  private String docid;

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

  public MetacatSpatialExtents() {}

  public MetacatSpatialExtents(String _docid ) {

    setDocid(_docid);

  }

  public void setIsPoint(boolean valid) {

    this.isPoint = valid;

  }

  public boolean getIsPoint() {

    return this.isPoint;

  }

  public void setDocid(String _docid) {

    this.docid = _docid;

  }

  public String getDocid() {

    return docid;

  }

  public void setXMin(float _xmin) {

    this.xmin = _xmin;

  }

  public float getXMin() { return xmin; }

  public void setYMin(float _ymin) {

    this.ymin = _ymin;

  }

  public float getYMin() { return ymin; }

  public void setXMax(float _xmax) {

    this.xmax = _xmax;

  }

  public float getXMax() { return xmax; }

  public void setYMax(float _ymax) {

    this.ymax = _ymax;

  }

  public float getYMax() { return ymax; }

  public String toString() {

   return ("\n\n***************************************************************"

          +"\n docid: " +  docid + " \n is point: " + isPoint

          +"\n x min: " +  getXMin() + " \n x max: " + getXMax() 

          +"\n y min: " +  getYMin() + " \n y max: " + getYMax()

          +"\n***************************************************************\n"); 

  }

}

/**

 *  '$RCSfile$'

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

 *             National Center for Ecological Analysis and Synthesis

 *

 * Author: John Harris 

 * '$Date$'

 * '$Revision$'

 *

 * 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 org.apache.log4j.Logger;

/**

 * Class that reflects a query against Metacat to gather spatial data  -- this

 * could be a text query that returns a spatial dataset or a spatial query that

 * returns a spatially-referenced dataset.

 */

public class MetacatSpatialQuery {

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

  private MetacatSpatialDocument msd;

  private SpatialQueryProcessor mqp;

  public MetacatSpatialQuery() { }

  /// query that returns a dataset constarined by a bounding box

  public MetacatSpatialDataset queryDatasetByCartesianBounds(float _xmin,

                                                             float _ymin, 

                                                             float _xmax, 

                                                             float _ymax) {

    /** all database querying is carried out in the Query Processor */

    mqp = new  SpatialQueryProcessor();

    // return the proc's results

    return mqp.queryDatasetByCartesianBounds(_xmin, _ymin, _xmax, _ymax);

  }

  /**

   * returns the metacat spatial document retrieved by this query

   */

  public MetacatSpatialDocument getSpatialDocument(String docid) {

    msd = new MetacatSpatialDocument(docid);

    log.info("creating spatial reference for docid: " + docid);

    /** all database querying is carried out in the Query Processor */

    mqp = new  SpatialQueryProcessor();

    // this call will return the extents (a class) of the docid

    MetacatSpatialExtents _extents = mqp.queryExtentsByDocid(docid);

    //set the elements on the spatialdocument

    msd.setDocid(docid);

    msd.setExtents(_extents);

    // destroy the processor

    mqp.close();

   return msd; 

  }

}

/**

 *  '$RCSfile$'

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

 *             National Center for Ecological Analysis and Synthesis

 *

 * Author: John Harris

 * '$Date$'

 * '$Revision$'

 *

 * 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 org.apache.log4j.Logger;

/**

 * Exception thrown when an error occurs trying to query for the

 * list of meeting document

 */

public class QueryFailedException extends Exception {

    /**

     * Create a new QueryFailedException.

     *

     * @param message The error or warning message.

     */

    public QueryFailedException(String message) {

      super(message);

    }

}

/**

 *  '$RCSfile$'

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

 *             National Center for Ecological Analysis and Synthesis

 *

 * Author: John Harris

 * '$Date$'

 * '$Revision$'

 *

 * 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); 

  }

}

         log.info(" --------- Spatial Harvester - spatial cache updated for : " + docid );

    log.info( " The '.prj' errors below are related to a geotools bug " +

              " (http://jira.codehaus.org/browse/GEOT-604) and can be ignored");