Metacat

/**

 *  '$RCSfile$'

 *  Copyright: 2005 University of New Mexico and the 

 *             Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *   '$Author$'

 *     '$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.advancedsearch;

import java.io.IOException;

import java.util.Enumeration;

import javax.servlet.RequestDispatcher;

import javax.servlet.ServletContext;

import javax.servlet.ServletException;

import javax.servlet.http.HttpServlet;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import javax.servlet.http.HttpSession;

import edu.ucsb.nceas.metacat.client.*;

/** 

 * @author dcosta

 * 

 * The AdvancedSearchServlet executes an advanced search.

 */

public class AdvancedSearchServlet extends HttpServlet {

  // Instance Variables -- (Not used because they are not thread-safe.)

  // Methods

  /**

   * Executes an advanced search.

   */

  public void doPost(HttpServletRequest request, HttpServletResponse response)

          throws IOException, ServletException {

    AdvancedSearch advancedSearch;

    AdvancedSearchBean advancedSearchBean;

    RequestDispatcher dispatcher;

    HttpSession httpSession = request.getSession();

    Metacat metacat = (Metacat) httpSession.getAttribute("metacat");

    String metacatURL;

    String result;

    final String resultsJSP = "style/skins/default/advancedsearchresults.jsp";

    final String resultsXSL = "style/common/resultset.xsl";

    ServletContext servletContext = httpSession.getServletContext();

    String xslPath = servletContext.getRealPath(resultsXSL);

    // First check whether the metacat URL was set as a context-param.

    metacatURL = servletContext.getInitParameter("metacatURL");

    // If no metacat URL was configured, then derive the metacat URL from the

    // server name and server port.

    if (metacatURL == null || metacatURL.equals("")) {

      MetacatHelper metacatHelper = new MetacatHelper();

      String serverName = request.getServerName();

      int serverPort = request.getServerPort();

      metacatURL = metacatHelper.constructMetacatURL(serverName, serverPort);

    }

    // Get the advancedSearchBean object that has been loaded up with user

    // input. Pass the bean to the advancedSearch object, execute the query,

    // and return the search result HTML string.

    advancedSearchBean = 

                (AdvancedSearchBean) request.getAttribute("advancedSearchBean");

    advancedSearch = new AdvancedSearch(advancedSearchBean);

    result = advancedSearch.executeAdvancedSearch(metacatURL, metacat, xslPath);

    // Store the result HTML string in the request for retrieval by

    // the metacatpathqueryresults.jsp form.

    request.setAttribute("result", result);

    dispatcher = request.getRequestDispatcher(resultsJSP);

    dispatcher.forward(request, response);

  }

}

/**

 *  '$RCSfile$'

 *  Copyright: 2005 University of New Mexico and the 

 *             Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *   '$Author$'

 *     '$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.advancedsearch;

import java.io.Serializable;

/**

 * @author dcosta

 *

 * The AdvancedSearchBean class stores query properties and values for

 * conducting an advanced Metacat search.

 */

public class AdvancedSearchBean implements Serializable {

  // Possible values for the various ___QueryType fields. These are translated

  // to the various "searchmode" values in the Metacat pathquery.

  public static final int CONTAINS = 0;     // LIKE "%word%"

  public static final int EXACT_MATCH = 1; 	// LIKE = "word"

  public static final int STARTS_WITH = 2;	// LIKE "word%"

  public static final int ENDS_WITH = 3;    // LIKE "%word"

  // Possible values for subjectAllAny field

  public static final int MATCH_ALL = 0;

  public static final int MATCH_ANY = 1;

  private boolean boundaryContained;

  private boolean caseSensitive;

  private String  creatorOrganization;

  private int     creatorOrganizationQueryType;

  private String  creatorSurname;

  private int     creatorSurnameQueryType;

  private String  dateField;      // "PUBLICATION", "COLLECTION", or "ALL"

  private String  eastBound;

  private String  endDate;

  private int     formAllAny;     // MATCH_ALL or MATCH_ANY

  private String  locationName;

  private String  namedTimescale;

  private int     namedTimescaleQueryType;

  private String  northBound;

  private String  southBound;

  private String  siteValue;

  private String  startDate;

  private int     subjectAllAny;  // MATCH_ALL or MATCH_ANY

  private String  subjectField;   // "ALL", "TITLE", "ABSTRACT", or "KEYWORD"

  private int     subjectQueryType;

  private String  subjectValue;

  private String  taxon;

  private int     taxonQueryType;

  private String  westBound;

  /**

   * @return Returns the creatorOrganization.

   */

  public String getCreatorOrganization() {

    return creatorOrganization;

  }

  /**

   * @return Returns the creatorOrganizationQueryType.

   */

  public int getCreatorOrganizationQueryType() {

    return creatorOrganizationQueryType;

  }

  /**

   * @return Returns the creatorSurname.

   */

  public String getCreatorSurname() {

    return creatorSurname;

  }

  /**

   * @return Returns the creatorSurnameQueryType.

   */

  public int getCreatorSurnameQueryType() {

    return creatorSurnameQueryType;

  }

  /**

   * @return Returns the dateField. Possible values: "PUBLICATION", "COLLECTION" 

   */

  public String getDateField() {

    return dateField;

  }

  /**

   * @return Returns the eastBound.

   */

  public String getEastBound() {

    return eastBound;

  }

  /**

   * @return Returns the endDate.

   */

  public String getEndDate() {

    return endDate;

  }

  /**

   * @return Returns the formAllAny value.  Possible values are 0 or 1.      

   */

  public int getFormAllAny() {

    return formAllAny;

  }

  /**

   * @return Returns the locationName.

   */

  public String getLocationName() {

    return locationName;

  }

  /**

   * @return Returns the namedTimescale.

   */

  public String getNamedTimescale() {

    return namedTimescale;

  }

  /**

   * @return Returns the namedTimescaleQueryType.

   */

  public int getNamedTimescaleQueryType() {

    return namedTimescaleQueryType;

  }

  /**

   * @return Returns the northBound.

   */

  public String getNorthBound() {

    return northBound;

  }

  /**

   * @return Returns the siteValue string.

   */

  public String getSiteValue() {

    return siteValue;

  }

  /**

   * @return Returns the southBound.

   */

  public String getSouthBound() {

    return southBound;

  }

  /**

   * @return Returns the startDate.

   */

  public String getStartDate() {

    return startDate;

  }

  /**

   * @return Returns the subjectAllAny value.  Possible values are 0 or 1.      

   */

  public int getSubjectAllAny() {

    return subjectAllAny;

  }

  /**

   * @return Returns the subjectField.  Possible values are:

   *         "ALL", "TITLE", "ABSTRACT", "KEYWORD"

   */

  public String getSubjectField() {

    return subjectField;

  }

  /**

   * @return Returns the subjectQueryType. Possible values are:

   * 0 (contains), 1 (exact match), 2 (starts with), 3 (ends with).

   */

  public int getSubjectQueryType() {

    return subjectQueryType;

  }

  /**

   * @return Returns the subjectValue.

   */

  public String getSubjectValue() {

    return subjectValue;

  }

  /**

   * @return Returns the taxon.

   */

  public String getTaxon() {

    return taxon;

  }

  /**

   * @return Returns the taxonConditonType.

   */

  public int getTaxonQueryType() {

    return taxonQueryType;

  }

  /**

   * @return Returns the westBound.

   */

  public String getWestBound() {

    return westBound;

  }

  /**

   * @return Returns the boundaryContained value.

   */

  public boolean isBoundaryContained() {

    return boundaryContained;

  }

  /**

   * @return Returns the caseSensitive value;

   */

  public boolean isCaseSensitive() {

    return caseSensitive;

  }

  /**

   * Boolean to determine whether a string is empty. A string is considered to

   * be empty if its value is either null or "".

   * 

   * @param  s      the string to check

   * @return        true if the string is empty, else false.

   */

  public boolean isEmpty(String s) {

    if (s != null && !s.equals(""))

      return false;

    else

      return true;

  }

  /**

   * @return Returns the limitedByBoundaries.

   */

  public boolean isLimitedByBoundaries() {

    if (!isEmpty(this.eastBound) && !isEmpty(this.westBound)) {

      return true;

    }

    else if (!isEmpty(this.southBound) && !isEmpty(this.northBound)) {

      return true;

    }

    else {

      return false;

    }

  }

  /**

   * @return Returns the limitedByDate.

   */

  public boolean isLimitedByDate() {

    if (!isEmpty(this.endDate) || !isEmpty(this.startDate)) {

      return true;

    }

    else {

      return false;

    }

  }

  /**

   * @param boundaryContained The boundaryContained value to set.

   */

  public void setBoundaryContained(final boolean boundaryContained) {

    this.boundaryContained = boundaryContained;

  }

  /**

   * @param caseSensitive The caseSensitive value to set.

   */

  public void setCaseSensitive(final boolean caseSensitive) {

    this.caseSensitive = caseSensitive;

  }

  /**

   * @param creatorOrganization The creatorOrganization to set.

   */

  public void setCreatorOrganization(final String creatorField) {

    this.creatorOrganization = creatorField;

  }

  /**

   * @param creatorOrganizationQueryType The creatorOrganizationQueryType to set

   */

  public void setCreatorOrganizationQueryType(final int creatorConditionType) {

    this.creatorOrganizationQueryType = creatorConditionType;

  }

  /**

   * @param creatorSurname   The creatorSurname to set.

   */

  public void setCreatorSurname(final String creatorValue) {

    this.creatorSurname = creatorValue;

  }

  /**

   * @param creatorSurnameQueryType   The creatorSurnameQueryType to set.

   */

  public void setCreatorSurnameQueryType(final int creatorSurnameQueryType) {

    this.creatorSurnameQueryType = creatorSurnameQueryType;

  }

  /**

   * @param dateField The dateField to set.

   */

  public void setDateField(final String dateField) {

    this.dateField = dateField;

  }

  /**

   * @param eastBound The eastBound to set.

   */

  public void setEastBound(final String eastBound) {

    this.eastBound = eastBound;

  }

  /**

   * @param endDate The endDate to set.

   */

  public void setEndDate(final String endDate) {

    this.endDate = endDate;

  }

  /**

   * @return Sets the formAllAny value.  Possible values are

   *         MATCH_ALL (0) or MATCH_ANY (1).  

   */

  public void setFormAllAny(final int allAny) {

    this.formAllAny = allAny;

  }

  /**

   * @param locationName The locationName to set.

   */

  public void setLocationName(final String locationName) {

    this.locationName = locationName;

  }

  /**

   * @param namedTimescale The namedTimescale to set.

   */

  public void setNamedTimescale(final String namedTimescale) {

    this.namedTimescale = namedTimescale;

  }

  /**

   * @param namedTimescaleQueryType The namedTimescaleQueryType to set.

   */

  public void setNamedTimescaleQueryType(final int namedTimescaleQueryType) {

    this.namedTimescaleQueryType = namedTimescaleQueryType;

  }

  /**

   * @param northBound The northBound to set.

   */

  public void setNorthBound(final String northBound) {

    this.northBound = northBound;

  }

  /**

   * @param siteValue    the siteValue to set.

   */

  public void setSiteValue(final String siteValue) {

    this.siteValue = siteValue;

  }

  /**

   * @param southBound The southBound to set.

   */

  public void setSouthBound(final String southBound) {

    this.southBound = southBound;

  }

  /**

   * @param startDate The startDate to set.

   */

  public void setStartDate(final String startDate) {

    this.startDate = startDate;

  }

  /**

   * Sets the subjectAllAny value.  

   * 

   * @param allAny Possible values are MATCH_ALL (0) or MATCH_ANY (1).  

   */

  public void setSubjectAllAny(final int allAny) {

    this.subjectAllAny = allAny;

  }

  /**

   * @param subjectField The subjectField to set.

   */

  public void setSubjectField(final String subjectField) {

    this.subjectField = subjectField;

  }

  /**

   * @param subjectQueryType The subjectQueryType to set. Possible values are:

   *                         0 (contains), 1 (exact match), 2 (starts with), 

   *                         3 (ends with).   

   */

  public void setSubjectQueryType(final int subjectQueryType) {

    this.subjectQueryType = subjectQueryType;

  }

  /**

   * @param subjectValue The subjectValue to set.

   */

  public void setSubjectValue(final String subjectValue) {

    this.subjectValue = subjectValue;

  }

  /**

   * @param taxon The taxon to set.

   */

  public void setTaxon(final String taxon) {

    this.taxon = taxon;

  }

  /**

   * @param taxonQueryType The taxonQueryType to set.

   */

  public void setTaxonQueryType(final int taxonQueryType) {

    this.taxonQueryType = taxonQueryType;

  }

  /**

   * @param westBound The westBound to set.

   */

  public void setWestBound(final String westBound) {

    this.westBound = westBound;

  }

}

/**

 *  '$RCSfile$'

 *  Copyright: 2005 University of New Mexico and the 

 *             Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *   '$Author$'

 *     '$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.advancedsearch;

import java.io.*;

import javax.xml.transform.Result;

import javax.xml.transform.Source;

import javax.xml.transform.Transformer;

import javax.xml.transform.TransformerConfigurationException;

import javax.xml.transform.TransformerException;

import javax.xml.transform.TransformerFactory;

/**

 * @author dcosta

 * 

 * Stylizer class applies the resultset.xsl stylesheet to the pathquery

 * results returned by Metacat.

 */

public class Stylizer {

  /**

   * Applies the resultset.xsl stylesheet to the pathquery result string

   * returned by Metacat.

   * 

   * @param resultset       the pathquery result string from Metacat

   * @param sessionId       the user's session id

   * @param metacatURL      the URL to the Metacat server

   * 

   * @return htmlString     the result of the transformation from XML to HTML

   */

  public String resultsetToHTML(final String resultset, 

                                final String sessionId,

                                final String metacatURL,

                                final String xslPath) {

    String htmlString = "";

    Result result;

    StringWriter stringWriter = new StringWriter();

    Transformer transformer;

    TransformerFactory transformerFactory;

    Source xmlSource;

    File xsltFile = new File(xslPath);            

    Source xsltSource;

    StringReader stringReader = new StringReader(resultset);

    xmlSource = new javax.xml.transform.stream.StreamSource(stringReader);

    xsltSource = new javax.xml.transform.stream.StreamSource(xsltFile);

    result = new javax.xml.transform.stream.StreamResult(stringWriter);

    // create an instance of TransformerFactory

    transformerFactory = TransformerFactory.newInstance();

    try {

      transformer = transformerFactory.newTransformer(xsltSource);

      transformer.setParameter("sessid", sessionId);

      transformer.setParameter("metacatURL", metacatURL);

      transformer.transform(xmlSource, result);

      htmlString = stringWriter.toString();

    }

    catch (TransformerConfigurationException tce) {

      // Error generated by the parser

      Throwable x = tce;  // Use the contained exception, if any

      if (tce.getException() != null) {

        x = tce.getException();    

      }

      x.printStackTrace();   

    }

    catch (TransformerException te) {

      // Error generated by the parser

      Throwable x = te;  // Use the contained exception, if any

      if (te.getException() != null) {

        x = te.getException();    

      }

      x.printStackTrace(); 

    }

    return htmlString;

  }

}

/**

 *  '$RCSfile$'

 *  Copyright: 2005 University of New Mexico and the 

 *             Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *   '$Author$'

 *     '$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.advancedsearch;

import java.io.IOException;

import javax.servlet.RequestDispatcher;

import javax.servlet.ServletContext;

import javax.servlet.ServletException;

import javax.servlet.http.HttpServlet;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import javax.servlet.http.HttpSession;

import edu.ucsb.nceas.metacat.client.*;

/** 

 * @author dcosta

 * 

 * The BrowseServlet class executes a browse action. This is equivalent to

 * a simple search, but the user clicks on a link to determine the search term.

 */

public class BrowseServlet extends HttpServlet {

  // Instance Variables -- (Not used because they are not thread-safe.)

  // Methods

  /**

   * Executes a browse-based simple search.

   */

  public void doPost(HttpServletRequest request, HttpServletResponse response)

      throws IOException, ServletException {

    AdvancedSearch advancedSearch;

    String browseValue;

    RequestDispatcher dispatcher;

    HttpSession httpSession = request.getSession();

    Metacat metacat = (Metacat) httpSession.getAttribute("metacat");

    String metacatURL;

    String result = "";

    final String resultsJSP = "style/skins/default/advancedsearchresults.jsp";

    ServletContext servletContext = httpSession.getServletContext();

    String stylesheet = (String) httpSession.getAttribute("stylesheet");

    String xslPath = servletContext.getRealPath("style/common/resultset.xsl");

    // First check whether the metacat URL was set as a context-param.

    metacatURL = servletContext.getInitParameter("metacatURL");

    // If no metacat URL was configured, then derive the metacat URL from the

    // server name and server port.

    if (metacatURL == null || metacatURL.equals("")) {

      MetacatHelper metacatHelper = new MetacatHelper();

      String serverName = request.getServerName();

      int serverPort = request.getServerPort();

      metacatURL = metacatHelper.constructMetacatURL(serverName, serverPort);

    }

    // Tell the web server that the response is HTML

    response.setContentType("text/html");

    // Fetch the browseValue parameter from the request and execute a search

    advancedSearch = new AdvancedSearch(null);

    browseValue = request.getParameter("browseValue");

    result = advancedSearch.executeSearch(metacatURL, metacat, xslPath, 

                                          browseValue);

    // Store the result HTML string in the request for retrieval by

    // the metacatpathqueryresults.jsp form.

    request.setAttribute("result", result);

    dispatcher = request.getRequestDispatcher(resultsJSP);

    dispatcher.forward(request, response);

  }

}

/**

 *  '$RCSfile$'

 *  Copyright: 2005 University of New Mexico and the 

 *             Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *   '$Author$'

 *     '$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.advancedsearch;

import edu.ucsb.nceas.metacat.client.*;

/**

 * @author dcosta

 * 

 * MetacatLogin class executes a Metacat login using the Metacat client.

 */

public class MetacatLogin  {

  /* Object variables */

  private LoginBean loginBean = null;

  /**

   * Constructor. Initializes the loginBean object variable.

   * 

   * @param loginBean  the LoginBean object, holds username and password

   */

  public MetacatLogin(final LoginBean loginBean) {

    this.loginBean = loginBean;

  }

  /**

   * Executes the Metacat login.

   * 

   * @param metacatURL      URL to the metacat servlet

   * @param metacat         a Metacat object, possibly null

   * 

   * @return loginSuccess   true if metacat login was successful, else false

   */

  public boolean executeLogin(final String metacatURL, final Metacat metacat) {

    final String DN;                            // LDAP distinguished name

    boolean loginSuccess = false;

    MetacatHelper metacatHelper = new MetacatHelper();

    String metacatResponse = "";

    final String organization = loginBean.getOrganization();

    final String password = loginBean.getPassword();

    final String username = loginBean.getUsername();

    if (

        username == null || 

        organization == null || 

        password == null || 

        username.equals("") || 

        organization.equals("") || 

        password.equals("")) 

    {

      return loginSuccess;

    }

    else {    

      System.err.println("Metacat URL: " + metacatURL);

      try {

        DN = metacatHelper.constructDN(username, organization);    

        metacatResponse = metacat.login(DN, password);

        System.err.println("metacatResponse:\n" + metacatResponse);

        if (metacatResponse.indexOf("Authentication successful") > -1) {

          loginSuccess = true;

        }

      } 

      catch (MetacatAuthException mae) {

        System.err.println("MetacatAuthException:\n" + mae.getMessage());

      } 

      catch (MetacatInaccessibleException mie) {

        System.err.println("Metacat Inaccessible:\n" + mie.getMessage());

      }

      catch (Exception e) {

        System.err.println("General exception:\n" + e.getMessage());

        e.printStackTrace();

      }

    }

    return loginSuccess;

  }

}

/**

 *  '$RCSfile$'

 *  Copyright: 2005 University of New Mexico and the 

 *             Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *   '$Author$'

 *     '$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.advancedsearch;

/** 

 * @author dcosta

 * 

 * The AdvancedSearchQueryTerm class holds the data needed to produce a xml 

 * string fragment representing a single queryterm in a querygroup.

 */

public class AdvancedSearchQueryTerm  {

  // Object variables

  private final String caseSensitive;//Case sensitive setting, "true" or "false"

  private final String indent;       // String of spaces for indenting output

  private final int initialLength = 100; // Initial length of the stringBuffer

  private final String pathExpr;         // The search field, e.g. "keyword"

  private final String searchMode;   // The search mode, e.g. "less-than"

  private StringBuffer stringBuffer; // Holds the queryterm xml string

  private final String value;        // The search value to match, e.g. "35"

  /**

   * Constructor. Initializes searchMode, caseSensitive, value, and indent.

   * 

   * @param searchMode       The search mode, e.g. "less-than-equals"

   * @param caseSensitive    Case sensitive setting, "true" or "false"

   * @param pathExpr         The search field, e.g. "northBoundingCoordinate"

   * @param value            The search value to match, e.g. "35"

   * @param indent           String of spaces for indenting output

   */

  public AdvancedSearchQueryTerm(final String searchMode, 

                                 final String caseSensitive, 

                                 final String pathExpr, 

                                 final String value, 

                                 final String indent

                         ) {

    this.searchMode = searchMode;

    this.caseSensitive = caseSensitive;

    this.pathExpr = pathExpr;

    this.value = value;

    this.indent = indent;

    stringBuffer = new StringBuffer(initialLength);

  }

  /**

   * Produce a xml string fragment that represents this queryterm.

   * 

   * @return    A xml string fragment that represents this queryterm.

   */

  public String toString() {

    stringBuffer.append(indent + 

                        "<queryterm searchmode=\"" + 

                        searchMode + 

                        "\" casesensitive=\"" + 

                        caseSensitive + 

                        "\">\n"

                       );

    stringBuffer.append(indent + "  <value>" + value + "</value>\n");

    // For a simple search or a browse search, the pathExpr string will be "".

    if (!pathExpr.equals("")) {

      stringBuffer.append(indent + "  <pathexpr>" + pathExpr + "</pathexpr>\n");

    }

    stringBuffer.append(indent + "</queryterm>\n");

    return stringBuffer.toString();

  }

}

/**

 *  '$RCSfile$'

 *  Copyright: 2005 University of New Mexico and the 

 *             Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *   '$Author$'

 *     '$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.advancedsearch;

import java.io.IOException;

import javax.servlet.RequestDispatcher;

import javax.servlet.ServletContext;

import javax.servlet.ServletException;

import javax.servlet.http.HttpServlet;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import javax.servlet.http.HttpSession;

import edu.ucsb.nceas.metacat.client.*;

/** 

 * @author dcosta

 * 

 * The SearchServlet class executes a search action. This corresponds to when a

 * user fills in a simple search text box and clicks "Search".

 */

public class SearchServlet extends HttpServlet {

  // Instance Variables -- (Not used because they are not thread-safe.)

  // Methods

  /**

   * Executes a simple search.

   */

  public void doPost(HttpServletRequest request, HttpServletResponse response)

      throws IOException, ServletException {

    AdvancedSearch advancedSearch;

    RequestDispatcher dispatcher;

    HttpSession httpSession = request.getSession();

    Metacat metacat = (Metacat) httpSession.getAttribute("metacat");

    String metacatURL;

    String result = "";

    final String resultsJSP = "style/skins/default/advancedsearchresults.jsp";

    String searchValue;

    ServletContext servletContext = httpSession.getServletContext();

    String stylesheet = (String) httpSession.getAttribute("stylesheet");

    String xslPath = servletContext.getRealPath("style/common/resultset.xsl");

    // First check whether the metacat URL was set as a context-param.

    metacatURL = servletContext.getInitParameter("metacatURL");

    // If no metacat URL was configured, then derive the metacat URL from the

    // server name and server port.

    if (metacatURL == null || metacatURL.equals("")) {

      MetacatHelper metacatHelper = new MetacatHelper();

      String serverName = request.getServerName();

      int serverPort = request.getServerPort();

      metacatURL = metacatHelper.constructMetacatURL(serverName, serverPort);

    }

    // Tell the web server that the response is HTML

    response.setContentType("text/html");

    // Fetch the searchValue parameter from the request and execute a search

    advancedSearch = new AdvancedSearch(null);

    searchValue = request.getParameter("searchValue");

    System.err.println("Search Servlet: " + searchValue);

    result = advancedSearch.executeSearch(metacatURL, metacat, xslPath, searchValue);

    // Store the result HTML string in the request for retrieval by

    // the metacatpathqueryresults.jsp form.

    request.setAttribute("result", result);

    dispatcher = request.getRequestDispatcher(resultsJSP);

    dispatcher.forward(request, response);

  }

}

/**

 *  '$RCSfile$'

 *  Copyright: 2005 University of New Mexico and the 

 *             Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *

 *   '$Author$'

 *     '$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.advancedsearch;

import java.io.Reader;

import java.io.StringReader;

import java.util.ArrayList;

import java.util.StringTokenizer;

import edu.ucsb.nceas.metacat.client.*;

import edu.ucsb.nceas.utilities.*;

/**

 * @author dcosta

 * 

 * AdvancedSearch class constructs queries that use the pathquery feature of 

 * Metacat. It can execute either an advanced search, where the user fills in

 * fields in a web form, or a simple search on a string.

 */

public class AdvancedSearch  {

  // Object variables

  private AdvancedSearchBean advancedSearchBean = null;

  private String caseSensitive;

  private final String globalOperator;

  private boolean hasSubjectSearch = false;

  private boolean hasAuthorSearch = false;

  private boolean hasSpatialSearch = false;

  private boolean hasTaxonomicSearch = false;

  private boolean hasTemporalSearch = false;

  private boolean hasSiteFilter = false;

  private int indentLevel = 2;

  private boolean isCaseSensitive = false;

  private AdvancedSearchPathQuery pathQuery;

  private AdvancedSearchQueryGroup queryGroup;

  private String queryString;

  private String site;

  private final String title = "Advanced Search";

  /**

   * Constructor. Used when the user has filled in an Advanced Search form.

   * The property values are contained in the advancedSearchBean object.

   * For a simple search, the advancedSearchBean object is passed as null.

   * 

   * @param advancedSearchBean   An AdvancedSearch bean.

   */

  public AdvancedSearch(final AdvancedSearchBean advancedSearchBean) {

    int allAny = AdvancedSearchBean.MATCH_ALL;

    String indent = getIndent(indentLevel * 1);

    final String operator;

    if (advancedSearchBean != null) {

      allAny = advancedSearchBean.getFormAllAny();

      this.isCaseSensitive = advancedSearchBean.isCaseSensitive();

      site = advancedSearchBean.getSiteValue();

    }

    if (allAny == AdvancedSearchBean.MATCH_ALL) {

      globalOperator = "INTERSECT";

    }

    else {

      globalOperator = "UNION";

    }

    if (isCaseSensitive == true) {

      this.caseSensitive = "true";

    }

    else {

      this.caseSensitive = "false";

    }

    this.queryGroup = new AdvancedSearchQueryGroup(globalOperator, indent);

    this.pathQuery = new AdvancedSearchPathQuery(title, queryGroup, indent);

    this.advancedSearchBean = advancedSearchBean;

  }

  /**

   * Adds a string to an ArrayList of terms. An auxiliary method to the

   * parseTermsAdvanced() method.

   * 

   * @param terms      ArrayList of strings.

   * @param term       the new string to add to the ArrayList, but only if

   *                   it isn't an empty string.

   */

  private void addTerm(ArrayList terms, final StringBuffer term) {

    final String s = term.toString().trim();

    if (s.length() > 0) {

      terms.add(s);

    }

  }

  /**

   * A full subject query searches the title, abstract, and keyword sections of

   * the document. Individual searches on these sections is also supported.

   */

  private void buildQuerySubject() {

    int allAny = advancedSearchBean.getSubjectAllAny();

    String emlField;

    String indent;

    final String innerOperator = "UNION";

    AdvancedSearchQueryGroup innerQuery = null;

    final String outerOperator;

    AdvancedSearchQueryGroup outerQuery;

    AdvancedSearchQueryTerm qt;

    String searchMode;

    final String subjectField = advancedSearchBean.getSubjectField();

    final int subjectQueryType = advancedSearchBean.getSubjectQueryType();

    String term;

    ArrayList terms;

    String value = advancedSearchBean.getSubjectValue();

    if ((value != null) && (!(value.equals("")))) {

      hasSubjectSearch = true;

      if (allAny == AdvancedSearchBean.MATCH_ALL) {

        outerOperator = "INTERSECT";

      }

      else {

        outerOperator = "UNION";

      }

      indent = getIndent(indentLevel * 2);

      outerQuery = new AdvancedSearchQueryGroup(outerOperator, indent);

      terms = parseTermsAdvanced(value);

      searchMode = metacatSearchMode(subjectQueryType);

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

        term = (String) terms.get(i);

        indent = getIndent(indentLevel * 3);

        innerQuery = new AdvancedSearchQueryGroup(innerOperator, indent);

        indent = getIndent(indentLevel * 4);

        if (subjectField.equals("ALL") || subjectField.equals("TITLE")) {

          emlField = "dataset/title";

          qt = new AdvancedSearchQueryTerm(searchMode, caseSensitive, emlField, 

                                           term, indent);

          innerQuery.addQueryTerm(qt);

        }

        if (subjectField.equals("ALL") || subjectField.equals("ABSTRACT")) {

          emlField = "dataset/abstract/para";

          qt = new AdvancedSearchQueryTerm(searchMode, caseSensitive, emlField, 

                                           term, indent);

          innerQuery.addQueryTerm(qt);

          emlField = "dataset/abstract/section/para";

          qt = new AdvancedSearchQueryTerm(searchMode, caseSensitive, emlField, 

                                           term, indent);

          innerQuery.addQueryTerm(qt);

        }

        if (subjectField.equals("ALL") || subjectField.equals("KEYWORDS")) {

          emlField = "keywordSet/keyword";

          qt = new AdvancedSearchQueryTerm(searchMode, caseSensitive, emlField, 

                                           term, indent);

          innerQuery.addQueryTerm(qt);

        }

        outerQuery.addQueryGroup(innerQuery);

      }

      // Minimize the number of query groups that get created, depending on

      // which criteria the user specified.

      //

      if (terms.size() > 1) {

        queryGroup.addQueryGroup(outerQuery);

      }

      else if (terms.size() == 1){

        queryGroup.addQueryGroup(innerQuery);

      }

    }

  }

  /**

   * An author query will search the creator/individualName/surName field, the

   * creator/organizationName field, or an intersection of both fields.

   */

  private void buildQueryAuthor() {

    boolean addQueryGroup = false;

    final int creatorSurnameQueryType = 

                                advancedSearchBean.getCreatorSurnameQueryType();

    final int creatorOrganizationQueryType = 

                           advancedSearchBean.getCreatorOrganizationQueryType();

    String emlField;

    String indent = getIndent(indentLevel * 2);

    AdvancedSearchQueryGroup qg = 

                           new AdvancedSearchQueryGroup(globalOperator, indent);

    AdvancedSearchQueryTerm qt;

    String searchMode;

    String value = advancedSearchBean.getCreatorSurname();

    indent = getIndent(indentLevel * 3);

    if ((value != null) && (!(value.equals("")))) {

      emlField = "dataset/creator/individualName/surName";

      searchMode = metacatSearchMode(creatorSurnameQueryType);

      qt = new AdvancedSearchQueryTerm(searchMode, caseSensitive, emlField, 

                                       value, indent);

      qg.addQueryTerm(qt);        

      addQueryGroup = true;

    }

    value = advancedSearchBean.getCreatorOrganization();

    if ((value != null) && (!(value.equals("")))) {

      emlField = "creator/organizationName";

      searchMode = metacatSearchMode(creatorOrganizationQueryType);

      qt = new AdvancedSearchQueryTerm(searchMode, caseSensitive, emlField, 

                                       value, indent);

      qg.addQueryTerm(qt);        

      addQueryGroup = true;

    }

    if (addQueryGroup) {      

      hasAuthorSearch = true;

      queryGroup.addQueryGroup(qg);

    }

  }

  /**

   * Two kinds of spatial searches are supported. The first is on a specific

   * named location. The second is on north/south/east/west bounding