ProductIndexQuery.java

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

  6. import gov.usgs.earthquake.product.ProductId;

  8. import java.math.BigDecimal;
  9. import java.util.Date;
  10. import java.util.Iterator;
  11. import java.util.LinkedList;
  12. import java.util.List;
  13. import java.util.logging.Level;
  14. import java.util.logging.Logger;

  16. /**
  17.  * Criteria for finding events.
  18.  *
  19.  * All properties are inclusive. When a property is null, it means any value.
  20.  *
  21.  * Expected combinations:
  22.  *
  23.  * 1) find events based on event parameters event time event latitude event
  24.  * longitude
  25.  *
  26.  * 2) find previously received update of product product source product type
  27.  * product code
  28.  *
  29.  * 3) find related products/events product ids
  30.  *
  31.  * 4) find related products/events event ids
  32.  */
  33. public class ProductIndexQuery implements Comparable<ProductIndexQuery> {

  35.   /**
  36.    * Event search types determine whether to search only preferred event
  37.    * attributes (faster), or all event attributes from any associated product
  38.    * (more complete).
  39.    */
  40.   private static enum EventSearchTypes {
  41.     /**
  42.      * Search preferred event attributes.
  43.      *
  44.      * NOTE: SEARCH_EVENT_PREFERRED should ONLY be used on event queries. Using this
  45.      * on product queries will more than likely break.
  46.      */
  47.     SEARCH_EVENT_PREFERRED,

  49.     /** Search event product attributes. */
  50.     SEARCH_EVENT_PRODUCTS
  51.   };

  53.   /**
  54.    * Result types determine which products associated to an event are returned.
  55.    */
  56.   private static enum ResultTypes {
  57.     /** Only include current versions of products in the result. */
  58.     RESULT_TYPE_CURRENT,

  60.     /** Only include superseded (old) versions of products in the result. */

  62.     RESULT_TYPE_SUPERSEDED,

  64.     /**
  65.      * Include both current and superseded versions of products in the result.
  66.      */
  67.     RESULT_TYPE_ALL;
  68.   };

  70.   /** EventSearchType for SEARCH_EVENT_PREFERRED */
  71.   public static EventSearchTypes SEARCH_EVENT_PREFERRED = EventSearchTypes.SEARCH_EVENT_PREFERRED;
  72.   /** EventSearchType for SEARCH_EVENT_PRODCUTS */
  73.   public static EventSearchTypes SEARCH_EVENT_PRODUCTS = EventSearchTypes.SEARCH_EVENT_PRODUCTS;

  75.   /** ResultType for RESULT_TYPE_CURRENT */
  76.   public static ResultTypes RESULT_TYPE_CURRENT = ResultTypes.RESULT_TYPE_CURRENT;
  77.   /** ResultType for RESULT_TYPE_SUPERSEDED */
  78.   public static ResultTypes RESULT_TYPE_SUPERSEDED = ResultTypes.RESULT_TYPE_SUPERSEDED;
  79.   /** ResultType for RESULT_TYPE_ALL */
  80.   public static ResultTypes RESULT_TYPE_ALL = ResultTypes.RESULT_TYPE_ALL;

  82.   /** Search preferred or all event attributes? */
  83.   private EventSearchTypes eventSearchType = SEARCH_EVENT_PRODUCTS;

  85.   /** Include previous versions? */
  86.   private ResultTypes resultType = RESULT_TYPE_CURRENT;

  88.   /** Event source */
  89.   private String eventSource;

  91.   /** Event source code */
  92.   private String eventSourceCode;

  94.   /** Minimum event time, inclusive. */
  95.   private Date minEventTime;

  97.   /** Maximum event time, inclusive. */
  98.   private Date maxEventTime;

  100.   /** Minimum event latitude. */
  101.   private BigDecimal minEventLatitude;

  103.   /** Maximum event latitude. */
  104.   private BigDecimal maxEventLatitude;

  106.   /** Minimum event longitude. */
  107.   private BigDecimal minEventLongitude;

  109.   /** Maximum event longitude. */
  110.   private BigDecimal maxEventLongitude;

  112.   /** Minimum event depth. */
  113.   private BigDecimal minEventDepth;

  115.   /** Maximum event depth. */
  116.   private BigDecimal maxEventDepth;

  118.   /** Minimum event magnitude. */
  119.   private BigDecimal minEventMagnitude;

  121.   /** Maximum event magnitude. */
  122.   private BigDecimal maxEventMagnitude;

  124.   /** A list of product ids to search. */
  125.   private List<ProductId> productIds = new LinkedList<ProductId>();

  127.   /** Minimum product update time. */
  128.   private Date minProductUpdateTime;

  130.   /** Maximum product update time. */
  131.   private Date maxProductUpdateTime;

  133.   /** The product source. */
  134.   private String productSource;

  136.   /** The product type. */
  137.   private String productType;

  139.   /** The product code. */
  140.   private String productCode;

  142.   /** The product version */
  143.   private String productVersion;

  145.   /** The product status */
  146.   private String productStatus;

  148.   /** The product index ID; unique per productIndex */
  149.   private Long minProductIndexId;

  151.   /** The max number of results */
  152.   private Integer limit;

  154.   /** List of columns to order by */
  155.   private String orderBy;

  157.   /**
  158.    * Construct a new ProductIndexQuery.
  159.    */
  160.   public ProductIndexQuery() {
  161.   }

  163.   /** @param eventSearchType to set */
  164.   public void setEventSearchType(EventSearchTypes eventSearchType) {
  165.     this.eventSearchType = eventSearchType;
  166.   }

  168.   /** @return eventSearchType */
  169.   public EventSearchTypes getEventSearchType() {
  170.     return eventSearchType;
  171.   }

  173.   /** @param resultType to set */
  174.   public void setResultType(ResultTypes resultType) {
  175.     this.resultType = resultType;
  176.   }

  178.   /** @return resultType */
  179.   public ResultTypes getResultType() {
  180.     return resultType;
  181.   }

  183.   /** @param eventSource to set */
  184.   public void setEventSource(String eventSource) {
  185.     this.eventSource = (eventSource == null ? null : eventSource.toLowerCase());
  186.   }

  188.   /** @return eventSource */
  189.   public String getEventSource() {
  190.     return eventSource;
  191.   }

  193.   /** @param eventSourceCode to set */
  194.   public void setEventSourceCode(String eventSourceCode) {
  195.     this.eventSourceCode = (eventSourceCode == null ? null : eventSourceCode.toLowerCase());
  196.   }

  198.   /** @return eventSourceCode */
  199.   public String getEventSourceCode() {
  200.     return eventSourceCode;
  201.   }

  203.   /** @return minEventTime */
  204.   public Date getMinEventTime() {
  205.     return minEventTime;
  206.   }

  208.   /** @param minEventTime to set */
  209.   public void setMinEventTime(Date minEventTime) {
  210.     this.minEventTime = minEventTime;
  211.   }

  213.   /** @return maxEventTime */
  214.   public Date getMaxEventTime() {
  215.     return maxEventTime;
  216.   }

  218.   /** @param maxEventTime to set */
  219.   public void setMaxEventTime(Date maxEventTime) {
  220.     this.maxEventTime = maxEventTime;
  221.   }

  223.   /** @return minEventLatitude */
  224.   public BigDecimal getMinEventLatitude() {
  225.     return minEventLatitude;
  226.   }

  228.   /** @param minEventLatitude to set */
  229.   public void setMinEventLatitude(BigDecimal minEventLatitude) {
  230.     this.minEventLatitude = minEventLatitude;
  231.   }

  233.   /** @return maxEventLatitude */
  234.   public BigDecimal getMaxEventLatitude() {
  235.     return maxEventLatitude;
  236.   }

  238.   /** @param maxEventLatitude to set */
  239.   public void setMaxEventLatitude(BigDecimal maxEventLatitude) {
  240.     this.maxEventLatitude = maxEventLatitude;
  241.   }

  243.   /** @return minEventLongitude */
  244.   public BigDecimal getMinEventLongitude() {
  245.     return minEventLongitude;
  246.   }

  248.   /** @param minEventLongitude to set */
  249.   public void setMinEventLongitude(BigDecimal minEventLongitude) {
  250.     this.minEventLongitude = minEventLongitude;
  251.   }

  253.   /** @return maxEventLongitude */
  254.   public BigDecimal getMaxEventLongitude() {
  255.     return maxEventLongitude;
  256.   }

  258.   /** @param maxEventLongitude to set */
  259.   public void setMaxEventLongitude(BigDecimal maxEventLongitude) {
  260.     this.maxEventLongitude = maxEventLongitude;
  261.   }

  263.   /** @return minEventDepth */
  264.   public BigDecimal getMinEventDepth() {
  265.     return minEventDepth;
  266.   }

  268.   /** @param minEventDepth to set */
  269.   public void setMinEventDepth(BigDecimal minEventDepth) {
  270.     this.minEventDepth = minEventDepth;
  271.   }

  273.   /** @return maxEventDepth */
  274.   public BigDecimal getMaxEventDepth() {
  275.     return maxEventDepth;
  276.   }

  278.   /** @param maxEventDepth to set */
  279.   public void setMaxEventDepth(BigDecimal maxEventDepth) {
  280.     this.maxEventDepth = maxEventDepth;
  281.   }

  283.   /** @return minEventMagnitude */
  284.   public BigDecimal getMinEventMagnitude() {
  285.     return minEventMagnitude;
  286.   }

  288.   /** @param minEventMagnitude to set */
  289.   public void setMinEventMagnitude(BigDecimal minEventMagnitude) {
  290.     this.minEventMagnitude = minEventMagnitude;
  291.   }

  293.   /** @return maxEventMagnitude */
  294.   public BigDecimal getMaxEventMagnitude() {
  295.     return maxEventMagnitude;
  296.   }

  298.   /** @param maxEventMagnitude to set */
  299.   public void setMaxEventMagnitude(BigDecimal maxEventMagnitude) {
  300.     this.maxEventMagnitude = maxEventMagnitude;
  301.   }

  303.   /** @return list of product Ids */
  304.   public List<ProductId> getProductIds() {
  305.     return productIds;
  306.   }

  308.   /** @param productIds list to set */
  309.   public void setProductIds(List<ProductId> productIds) {
  310.     this.productIds.clear();
  311.     this.productIds.addAll(productIds);
  312.   }

  314.   /** @return minProductUpdateTime */
  315.   public Date getMinProductUpdateTime() {
  316.     return minProductUpdateTime;
  317.   }

  319.   /** @param minProductUpdateTime to set */
  320.   public void setMinProductUpdateTime(Date minProductUpdateTime) {
  321.     this.minProductUpdateTime = minProductUpdateTime;
  322.   }

  324.   /** @return maxProductUpdateTime */
  325.   public Date getMaxProductUpdateTime() {
  326.     return maxProductUpdateTime;
  327.   }

  329.   /** @param maxProductUpdateTime to set */
  330.   public void setMaxProductUpdateTime(Date maxProductUpdateTime) {
  331.     this.maxProductUpdateTime = maxProductUpdateTime;
  332.   }

  334.   /** @return productSource */
  335.   public String getProductSource() {
  336.     return productSource;
  337.   }

  339.   /** @param productSource to set */
  340.   public void setProductSource(String productSource) {
  341.     this.productSource = productSource;
  342.   }

  344.   /** @return productType */
  345.   public String getProductType() {
  346.     return productType;
  347.   }

  349.   /** @param productType to set */
  350.   public void setProductType(String productType) {
  351.     this.productType = productType;
  352.   }

  354.   /** @return productCode */
  355.   public String getProductCode() {
  356.     return productCode;
  357.   }

  359.   /** @param productCode to set */
  360.   public void setProductCode(String productCode) {
  361.     this.productCode = productCode;
  362.   }

  364.   /** @param productVersion to set */
  365.   public void setProductVersion(String productVersion) {
  366.     this.productVersion = productVersion;
  367.   }

  369.   /** @return productVersion */
  370.   public String getProductVersion() {
  371.     return productVersion;
  372.   }

  374.   /** @param productStatus to set */
  375.   public void setProductStatus(String productStatus) {
  376.     this.productStatus = productStatus;
  377.   }

  379.   /** @return productStatus */
  380.   public String getProductStatus() {
  381.     return productStatus;
  382.   }

  384.   /** @param minProductIndexId to set */
  385.   public void setMinProductIndexId(final Long minProductIndexId) {
  386.     this.minProductIndexId = minProductIndexId;
  387.   }

  389.   /** @return minProductIndexId */
  390.   public Long getMinProductIndexId() {
  391.     return this.minProductIndexId;
  392.   }

  394.   /** @param limit to set */
  395.   public void setLimit(final Integer limit) {
  396.     this.limit = limit;
  397.   }

  399.   /** @return limit */
  400.   public Integer getLimit() {
  401.     return this.limit;
  402.   }

  404.   /** @param orderBy to set */
  405.   public void setOrderBy(final String orderBy) {
  406.     this.orderBy = orderBy;
  407.   }

  409.   /** @return orderBy */
  410.   public String getOrderBy() {
  411.     return this.orderBy;
  412.   }

  414.   @Override
  415.   public boolean equals(Object that) {
  416.     return (this.compareTo((ProductIndexQuery) that)) == 0;
  417.   }

  419.   @Override
  420.   public int compareTo(ProductIndexQuery that) {
  421.     int r = 0;

  423.     if ((r = compare(this.eventSource, that.eventSource)) != 0) {
  424.       return r;
  425.     }
  426.     if ((r = compare(this.eventSourceCode, that.eventSourceCode)) != 0) {
  427.       return r;
  428.     }
  429.     if ((r = compare(this.maxEventDepth, that.maxEventDepth)) != 0) {
  430.       return r;
  431.     }
  432.     if ((r = compare(this.maxEventLatitude, that.maxEventLatitude)) != 0) {
  433.       return r;
  434.     }
  435.     if ((r = compare(this.maxEventLongitude, that.maxEventLongitude)) != 0) {
  436.       return r;
  437.     }
  438.     if ((r = compare(this.maxEventMagnitude, that.maxEventMagnitude)) != 0) {
  439.       return r;
  440.     }
  441.     if ((r = compare(this.maxEventTime, that.maxEventTime)) != 0) {
  442.       return r;
  443.     }
  444.     if ((r = compare(this.maxProductUpdateTime, that.maxProductUpdateTime)) != 0) {
  445.       return r;
  446.     }

  448.     if ((r = compare(this.minEventDepth, that.minEventDepth)) != 0) {
  449.       return r;
  450.     }
  451.     if ((r = compare(this.minEventLatitude, that.minEventLatitude)) != 0) {
  452.       return r;
  453.     }
  454.     if ((r = compare(this.minEventLongitude, that.minEventLongitude)) != 0) {
  455.       return r;
  456.     }
  457.     if ((r = compare(this.minEventMagnitude, that.minEventMagnitude)) != 0) {
  458.       return r;
  459.     }
  460.     if ((r = compare(this.minEventTime, that.minEventTime)) != 0) {
  461.       return r;
  462.     }
  463.     if ((r = compare(this.minProductUpdateTime, that.minProductUpdateTime)) != 0) {
  464.       return r;
  465.     }

  467.     if ((r = compare(this.productCode, that.productCode)) != 0) {
  468.       return r;
  469.     }
  470.     if ((r = compare(this.productSource, that.productSource)) != 0) {
  471.       return r;
  472.     }
  473.     if ((r = compare(this.productStatus, that.productStatus)) != 0) {
  474.       return r;
  475.     }
  476.     if ((r = compare(this.productType, that.productType)) != 0) {
  477.       return r;
  478.     }
  479.     if ((r = compare(this.productVersion, that.productVersion)) != 0) {
  480.       return r;
  481.     }

  483.     if ((r = (that.productIds.size() - this.productIds.size())) != 0) {
  484.       // different size lists
  485.       return r;
  486.     } else {
  487.       // lists are same size, check contents
  488.       Iterator<ProductId> thisIter = this.productIds.iterator();
  489.       Iterator<ProductId> thatIter = that.productIds.iterator();
  490.       while (thisIter.hasNext() && thatIter.hasNext()) {
  491.         r = thisIter.next().compareTo(thatIter.next());
  492.         if (r != 0) {
  493.           return r;
  494.         }
  495.       }
  496.     }

  498.     return 0;
  499.   }

  501.   /**
  502.    * Compare function
  503.    *
  504.    * @param <T> Type
  505.    * @param o1  First item to compare
  506.    * @param o2  Second to comoare
  507.    * @return 0 if equal, 1 if o1 is null, -1 if o2 null, or the comparison
  508.    */
  509.   protected <T extends Comparable<T>> int compare(T o1, T o2) {
  510.     if (o1 == null && o2 == null) {
  511.       return 0;
  512.     } else if (o1 == null && o2 != null) {
  513.       return 1;
  514.     } else if (o1 != null && o2 == null) {
  515.       return -1;
  516.     } else {
  517.       return o1.compareTo(o2);
  518.     }
  519.   }

  521.   /**
  522.    * Log function
  523.    *
  524.    * @param logger logger object
  525.    */
  526.   public void log(final Logger logger) {
  527.     if (!logger.isLoggable(Level.FINEST)) {
  528.       return;
  529.     }
  530.     StringBuffer buf = new StringBuffer("Product Index Query");
  531.     buf.append("\neventSearchType=").append(this.eventSearchType);
  532.     buf.append("\nresultType=").append(this.resultType);
  533.     if (this.eventSource != null) {
  534.       buf.append("\neventSource=").append(this.eventSource);
  535.     }
  536.     if (this.eventSourceCode != null) {
  537.       buf.append("\neventSourceCode=").append(this.eventSourceCode);
  538.     }
  539.     if (this.minEventTime != null) {
  540.       buf.append("\nminEventTime=").append(this.minEventTime);
  541.     }
  542.     if (this.maxEventTime != null) {
  543.       buf.append("\nmaxEventTime=").append(this.maxEventTime);
  544.     }
  545.     if (this.minEventLatitude != null) {
  546.       buf.append("\nminEventLatitude=").append(this.minEventLatitude);
  547.     }
  548.     if (this.maxEventLatitude != null) {
  549.       buf.append("\nmaxEventLatitude=").append(this.maxEventLatitude);
  550.     }
  551.     if (this.minEventLongitude != null) {
  552.       buf.append("\nminEventLongitude=").append(this.minEventLongitude);
  553.     }
  554.     if (this.maxEventLongitude != null) {
  555.       buf.append("\nmaxEventLongitude=").append(this.maxEventLongitude);
  556.     }
  557.     if (this.minEventDepth != null) {
  558.       buf.append("\nminEventDepth=").append(this.minEventDepth);
  559.     }
  560.     if (this.maxEventDepth != null) {
  561.       buf.append("\nmaxEventDepth=").append(this.maxEventDepth);
  562.     }
  563.     if (this.minEventMagnitude != null) {
  564.       buf.append("\nminEventMagnitude=").append(this.minEventMagnitude);
  565.     }
  566.     if (this.maxEventMagnitude != null) {
  567.       buf.append("\nmaxEventMagnitude=").append(this.maxEventMagnitude);
  568.     }
  569.     if (this.productIds.size() > 0) {
  570.       buf.append("\nproduct ids=");
  571.       Iterator<ProductId> iter = this.productIds.iterator();
  572.       while (iter.hasNext()) {
  573.         buf.append(iter.next().toString()).append(" ");
  574.       }
  575.     }
  576.     if (this.minProductUpdateTime != null) {
  577.       buf.append("\nminProductUpdateTime=").append(this.minProductUpdateTime);
  578.     }
  579.     if (this.maxProductUpdateTime != null) {
  580.       buf.append("\nmaxProductUpdateTime=").append(this.maxProductUpdateTime);
  581.     }
  582.     if (this.productSource != null) {
  583.       buf.append("\nproductSource=").append(this.productSource);
  584.     }
  585.     if (this.productType != null) {
  586.       buf.append("\nproductType=").append(this.productType);
  587.     }
  588.     if (this.productCode != null) {
  589.       buf.append("\nproductCode=").append(this.productCode);
  590.     }
  591.     if (this.productVersion != null) {
  592.       buf.append("\nproductVersion=").append(this.productVersion);
  593.     }
  594.     if (this.productStatus != null) {
  595.       buf.append("\nproductStatus=").append(this.productStatus);
  596.     }

  598.     logger.finest(buf.toString());
  599.   }
  600. }
Created with JaCoCo 0.8.8.202204050719