SearchQuery.java

  1. /*
  2.  * SearchQuery
  3.  */
  4. package gov.usgs.earthquake.indexer;

  6. /**
  7.  * A search to execute against a ProductIndex, or ProductStorage.
  8.  */
  9. public abstract class SearchQuery implements Comparable<SearchQuery> {

  11.     /** The type of response that is expected. */
  12.     private final SearchMethod type;

  14.     /** The search parameters. */
  15.     private final ProductIndexQuery query;

  17.     /** Contains an error returned in a SearchResult if one occurred **/
  18.     private String error;

  20.     /**
  21.      * Construct a new SearchQuery object.
  22.      *
  23.      * @param type
  24.      *            the type of search.
  25.      * @param query
  26.      *            the query parameters.
  27.      */
  28.     protected SearchQuery(final SearchMethod type, final ProductIndexQuery query) {
  29.         this.type = type;
  30.         this.query = query;
  31.         this.error = null;
  32.     }

  34.     /** @return type */
  35.     public SearchMethod getType() {
  36.         return this.type;
  37.     }

  39.     /** @return ProductIndexQuery */
  40.     public ProductIndexQuery getProductIndexQuery() {
  41.         return this.query;
  42.     }

  44.     /**
  45.      * Get the result associated with a specific query type.
  46.      *
  47.      * @return the result, or null if the search has not yet executed.
  48.      */
  49.     public abstract Object getResult();

  51.     /**
  52.      * Create a SearchQuery object based on a SearchType.
  53.      *
  54.      * @param type
  55.      *            the search type to create
  56.      * @param query
  57.      *            the associated query
  58.      * @return a SearchQuery, or null if type is unknown.
  59.      */
  60.     public static SearchQuery getSearchQuery(final SearchMethod type,
  61.             final ProductIndexQuery query) {
  62.         if (type == null) {
  63.             return null;
  64.         } else if (type.equals(SearchMethod.EVENTS_SUMMARY)) {
  65.             return new EventsSummaryQuery(query);
  66.         } else if (type.equals(SearchMethod.EVENT_DETAIL)) {
  67.             return new EventDetailQuery(query);
  68.         } else if (type.equals(SearchMethod.PRODUCTS_SUMMARY)) {
  69.             return new ProductsSummaryQuery(query);
  70.         } else if (type.equals(SearchMethod.PRODUCT_DETAIL)) {
  71.             return new ProductDetailQuery(query);
  72.         } else {
  73.             return null;
  74.         }
  75.     }

  77.     @Override
  78.     public boolean equals(Object that) {
  79.         return (this.compareTo((SearchQuery) that)) == 0;
  80.     }

  82.     @Override
  83.     public int compareTo(SearchQuery that) {
  84.         int r;

  86.         if ((r = this.type.compareTo(that.type)) != 0) {
  87.             return r;
  88.         }

  90.         if ((r = this.query.compareTo(that.query)) != 0) {
  91.             return r;
  92.         }

  94.         //both have results
  95.         Object thatResult = that.getResult();
  96.         Object thisResult = this.getResult();
  97.         if (thisResult == null && thatResult == null) {
  98.             return 0;
  99.         } else if (thisResult != null && thatResult == null) {
  100.             return -1;
  101.         } else if (thisResult == null && thatResult != null) {
  102.             return 1;
  103.         }

  105.         return 0;
  106.     }

  108.     /**
  109.      * @param error the error to set
  110.      */
  111.     public void setError(String error) {
  112.         this.error = error;
  113.     }

  115.     /**
  116.      * @return the error or null if no error occurred.
  117.      */
  118.     public String getError() {
  119.         return error;
  120.     }

  122. }
Created with JaCoCo 0.8.8.202204050719