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.
  45.          * Using this 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
  55.      * returned.
  56.      */
  57.     private static enum ResultTypes {
  58.         /** Only include current versions of products in the result. */
  59.         RESULT_TYPE_CURRENT,

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

  63.         RESULT_TYPE_SUPERSEDED,

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

  72.     /** EventSearchType for SEARCH_EVENT_PREFERRED */
  73.     public static EventSearchTypes SEARCH_EVENT_PREFERRED = EventSearchTypes.SEARCH_EVENT_PREFERRED;
  74.     /** EventSearchType for SEARCH_EVENT_PRODCUTS */
  75.     public static EventSearchTypes SEARCH_EVENT_PRODUCTS = EventSearchTypes.SEARCH_EVENT_PRODUCTS;

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

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

  87.     /** Include previous versions? */
  88.     private ResultTypes resultType = RESULT_TYPE_CURRENT;

  90.     /** Event source */
  91.     private String eventSource;

  93.     /** Event source code */
  94.     private String eventSourceCode;

  96.     /** Minimum event time, inclusive. */
  97.     private Date minEventTime;

  99.     /** Maximum event time, inclusive. */
  100.     private Date maxEventTime;

  102.     /** Minimum event latitude. */
  103.     private BigDecimal minEventLatitude;

  105.     /** Maximum event latitude. */
  106.     private BigDecimal maxEventLatitude;

  108.     /** Minimum event longitude. */
  109.     private BigDecimal minEventLongitude;

  111.     /** Maximum event longitude. */
  112.     private BigDecimal maxEventLongitude;

  114.     /** Minimum event depth. */
  115.     private BigDecimal minEventDepth;

  117.     /** Maximum event depth. */
  118.     private BigDecimal maxEventDepth;

  120.     /** Minimum event magnitude. */
  121.     private BigDecimal minEventMagnitude;

  123.     /** Maximum event magnitude. */
  124.     private BigDecimal maxEventMagnitude;

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

  129.     /** Minimum product update time. */
  130.     private Date minProductUpdateTime;

  132.     /** Maximum product update time. */
  133.     private Date maxProductUpdateTime;

  135.     /** The product source. */
  136.     private String productSource;

  138.     /** The product type. */
  139.     private String productType;

  141.     /** The product code. */
  142.     private String productCode;

  144.     /** The product version */
  145.     private String productVersion;

  147.     /** The product status */
  148.     private String productStatus;

  150.     /** The product index ID; unique per productIndex */
  151.     private Long minProductIndexId;

  153.     /** The max number of results */
  154.     private Integer limit;

  156.     /** List of columns to order by */
  157.     private String orderBy;

  159.     /**
  160.      * Construct a new ProductIndexQuery.
  161.      */
  162.     public ProductIndexQuery() {
  163.     }

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

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

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

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

  185.     /** @param eventSource to set */
  186.     public void setEventSource(String eventSource) {
  187.         this.eventSource = (eventSource == null ? null : eventSource
  188.                 .toLowerCase());
  189.     }
  190.     /** @return eventSource */
  191.     public String getEventSource() {
  192.         return eventSource;
  193.     }

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

  201.     /** @return eventSourceCode */
  202.     public String getEventSourceCode() {
  203.         return eventSourceCode;
  204.     }

  206.     /** @return minEventTime */
  207.     public Date getMinEventTime() {
  208.         return minEventTime;
  209.     }

  211.     /** @param minEventTime to set */
  212.     public void setMinEventTime(Date minEventTime) {
  213.         this.minEventTime = minEventTime;
  214.     }

  216.     /** @return maxEventTime */
  217.     public Date getMaxEventTime() {
  218.         return maxEventTime;
  219.     }

  221.     /** @param maxEventTime to set */
  222.     public void setMaxEventTime(Date maxEventTime) {
  223.         this.maxEventTime = maxEventTime;
  224.     }

  226.     /** @return minEventLatitude */
  227.     public BigDecimal getMinEventLatitude() {
  228.         return minEventLatitude;
  229.     }

  231.     /** @param minEventLatitude to set */
  232.     public void setMinEventLatitude(BigDecimal minEventLatitude) {
  233.         this.minEventLatitude = minEventLatitude;
  234.     }

  236.     /** @return maxEventLatitude */
  237.     public BigDecimal getMaxEventLatitude() {
  238.         return maxEventLatitude;
  239.     }

  241.     /** @param maxEventLatitude to set */
  242.     public void setMaxEventLatitude(BigDecimal maxEventLatitude) {
  243.         this.maxEventLatitude = maxEventLatitude;
  244.     }

  246.     /** @return minEventLongitude */
  247.     public BigDecimal getMinEventLongitude() {
  248.         return minEventLongitude;
  249.     }

  251.     /** @param minEventLongitude to set */
  252.     public void setMinEventLongitude(BigDecimal minEventLongitude) {
  253.         this.minEventLongitude = minEventLongitude;
  254.     }

  256.     /** @return maxEventLongitude */
  257.     public BigDecimal getMaxEventLongitude() {
  258.         return maxEventLongitude;
  259.     }

  261.     /** @param maxEventLongitude to set */
  262.     public void setMaxEventLongitude(BigDecimal maxEventLongitude) {
  263.         this.maxEventLongitude = maxEventLongitude;
  264.     }

  266.     /** @return minEventDepth */
  267.     public BigDecimal getMinEventDepth() {
  268.         return minEventDepth;
  269.     }

  271.     /** @param minEventDepth to set */
  272.     public void setMinEventDepth(BigDecimal minEventDepth) {
  273.         this.minEventDepth = minEventDepth;
  274.     }

  276.     /** @return maxEventDepth */
  277.     public BigDecimal getMaxEventDepth() {
  278.         return maxEventDepth;
  279.     }

  281.     /** @param maxEventDepth to set */
  282.     public void setMaxEventDepth(BigDecimal maxEventDepth) {
  283.         this.maxEventDepth = maxEventDepth;
  284.     }

  286.     /** @return minEventMagnitude */
  287.     public BigDecimal getMinEventMagnitude() {
  288.         return minEventMagnitude;
  289.     }

  291.     /** @param minEventMagnitude to set */
  292.     public void setMinEventMagnitude(BigDecimal minEventMagnitude) {
  293.         this.minEventMagnitude = minEventMagnitude;
  294.     }

  296.     /** @return maxEventMagnitude */
  297.     public BigDecimal getMaxEventMagnitude() {
  298.         return maxEventMagnitude;
  299.     }

  301.     /** @param maxEventMagnitude to set */
  302.     public void setMaxEventMagnitude(BigDecimal maxEventMagnitude) {
  303.         this.maxEventMagnitude = maxEventMagnitude;
  304.     }

  306.     /** @return list of product Ids */
  307.     public List<ProductId> getProductIds() {
  308.         return productIds;
  309.     }

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

  317.     /** @return minProductUpdateTime */
  318.     public Date getMinProductUpdateTime() {
  319.         return minProductUpdateTime;
  320.     }

  322.     /** @param minProductUpdateTime to set */
  323.     public void setMinProductUpdateTime(Date minProductUpdateTime) {
  324.         this.minProductUpdateTime = minProductUpdateTime;
  325.     }

  327.     /** @return maxProductUpdateTime */
  328.     public Date getMaxProductUpdateTime() {
  329.         return maxProductUpdateTime;
  330.     }

  332.     /** @param maxProductUpdateTime to set */
  333.     public void setMaxProductUpdateTime(Date maxProductUpdateTime) {
  334.         this.maxProductUpdateTime = maxProductUpdateTime;
  335.     }

  337.     /** @return productSource */
  338.     public String getProductSource() {
  339.         return productSource;
  340.     }

  342.     /** @param productSource to set */
  343.     public void setProductSource(String productSource) {
  344.         this.productSource = productSource;
  345.     }

  347.     /** @return productType */
  348.     public String getProductType() {
  349.         return productType;
  350.     }

  352.     /** @param productType to set */
  353.     public void setProductType(String productType) {
  354.         this.productType = productType;
  355.     }

  357.     /** @return productCode */
  358.     public String getProductCode() {
  359.         return productCode;
  360.     }

  362.     /** @param productCode to set */
  363.     public void setProductCode(String productCode) {
  364.         this.productCode = productCode;
  365.     }

  367.     /** @param productVersion to set */
  368.     public void setProductVersion(String productVersion) {
  369.         this.productVersion = productVersion;
  370.     }

  372.     /** @return productVersion */
  373.     public String getProductVersion() {
  374.         return productVersion;
  375.     }

  377.     /** @param productStatus to set */
  378.     public void setProductStatus(String productStatus) {
  379.         this.productStatus = productStatus;
  380.     }

  382.     /** @return productStatus */
  383.     public String getProductStatus() {
  384.         return productStatus;
  385.     }

  387.     /** @param minProductIndexId to set */
  388.     public void setMinProductIndexId(final Long minProductIndexId) {
  389.         this.minProductIndexId = minProductIndexId;
  390.     }

  392.     /** @return minProductIndexId */
  393.     public Long getMinProductIndexId() {
  394.         return this.minProductIndexId;
  395.     }

  397.     /** @param limit to set */
  398.     public void setLimit(final Integer limit) {
  399.         this.limit = limit;
  400.     }

  402.     /** @return limit */
  403.     public Integer getLimit() {
  404.         return this.limit;
  405.     }

  407.     /** @param orderBy to set */
  408.     public void setOrderBy(final String orderBy) {
  409.         this.orderBy = orderBy;
  410.     }

  412.     /** @return orderBy */
  413.     public String getOrderBy() {
  414.         return this.orderBy;
  415.     }

  417.     @Override
  418.     public boolean equals(Object that) {
  419.         return (this.compareTo((ProductIndexQuery) that)) == 0;
  420.     }

  422.     @Override
  423.     public int compareTo(ProductIndexQuery that) {
  424.         int r = 0;

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

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

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

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

  501.         return 0;
  502.     }

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

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

  601.         logger.finest(buf.toString());
  602.     }
  603. }
Created with JaCoCo 0.8.8.202204050719