IndexerChange.java

  1. package gov.usgs.earthquake.indexer;

  3. /**
  4.  * Description of a specific change to a {@link ProductIndex}.
  5.  *
  6.  * Multiple IndexerChange objects may be created, and grouped
  7.  * into an {@link IndexerEvent}, in response to one product
  8.  * being processed.
  9.  */
  10. public class IndexerChange {

  12.     /** Enumeration of indexer event types. */
  13.     public static enum IndexerChangeType {
  14.         /** Enum for IndexerChangeType Event Added */
  15.         EVENT_ADDED,
  16.         /** Enum for IndexerChangeType Event Updated */
  17.         EVENT_UPDATED,
  18.         /** Enum for IndexerChangeType Event Deleted */
  19.         EVENT_DELETED,
  20.         /** Enum for IndexerChangeType Event Archived */
  21.         EVENT_ARCHIVED,
  22.         /** Enum for IndexerChangeType Event Merged */
  23.         EVENT_MERGED,
  24.         /** Enum for IndexerChangeType Event Split */
  25.         EVENT_SPLIT,

  27.         /** Enum for IndexerChangeType Product Added */
  28.         PRODUCT_ADDED,
  29.         /** Enum for IndexerChangeType Product Updated */
  30.         PRODUCT_UPDATED,
  31.         /** Enum for IndexerChangeType Product Deleted */
  32.         PRODUCT_DELETED,
  33.         /** Enum for IndexerChangeType Product Archived */
  34.         PRODUCT_ARCHIVED
  35.     };
  36.     /** IndexerChangeType for Event Added */
  37.     public static final IndexerChangeType EVENT_ADDED = IndexerChangeType.EVENT_ADDED;
  38.     /** IndexerChangeType for Event Updated */
  39.     public static final IndexerChangeType EVENT_UPDATED = IndexerChangeType.EVENT_UPDATED;
  40.     /** IndexerChangeType for Event Deleted */
  41.     public static final IndexerChangeType EVENT_DELETED = IndexerChangeType.EVENT_DELETED;
  42.     /** IndexerChangeType for Event Archived */
  43.     public static final IndexerChangeType EVENT_ARCHIVED = IndexerChangeType.EVENT_ARCHIVED;
  44.     /** IndexerChangeType for Event Merged */
  45.     public static final IndexerChangeType EVENT_MERGED = IndexerChangeType.EVENT_MERGED;
  46.     /** IndexerChangeType for Event Split */
  47.     public static final IndexerChangeType EVENT_SPLIT = IndexerChangeType.EVENT_SPLIT;

  49.     /** IndexerChangeType for Product Added */
  50.     public static final IndexerChangeType PRODUCT_ADDED = IndexerChangeType.PRODUCT_ADDED;
  51.     /** IndexerChangeType for Product Updated */
  52.     public static final IndexerChangeType PRODUCT_UPDATED = IndexerChangeType.PRODUCT_UPDATED;
  53.     /** IndexerChangeType for Product Deleted */
  54.     public static final IndexerChangeType PRODUCT_DELETED = IndexerChangeType.PRODUCT_DELETED;
  55.     /** IndexerChangeType for Product Archived */
  56.     public static final IndexerChangeType PRODUCT_ARCHIVED = IndexerChangeType.PRODUCT_ARCHIVED;

  58.     /** Indicates the type of change that is occurring */
  59.     private IndexerChangeType type;
  60.     /** The event as it was before the change occurred. */
  61.     private Event originalEvent;
  62.     /** The event as it is after the change occurred. */
  63.     private Event newEvent;

  65.     /**
  66.      * Constructor to quickly create a new <code>IndexerChange</code> object to
  67.      * be added to the list of changes in a given <code>IndexerEvent</code>.
  68.      * Note the <code>oldEvent</code> and <code>newEvent</code> will have
  69.      * particular meanings depending on the given <code>type</code> of change
  70.      * that occurred.
  71.      *
  72.      * @param type
  73.      *            The type of change that occurred.
  74.      * @param originalEvent
  75.      *            The event as it was before the change occurred.
  76.      * @param newEvent
  77.      *            The event as it is after the change occurred.
  78.      * @see IndexerEvent
  79.      */
  80.     public IndexerChange(IndexerChangeType type, Event originalEvent,
  81.             Event newEvent) {
  82.         this.type = type;
  83.         this.originalEvent = originalEvent;
  84.         this.newEvent = newEvent;
  85.     }

  87.     /** @return IndexerChangeType */
  88.     public IndexerChangeType getType() {
  89.         return this.type;
  90.     }

  92.     /** @return originalEvent */
  93.     public Event getOriginalEvent() {
  94.         return this.originalEvent;
  95.     }

  97.     /** @return newEvent */
  98.     public Event getNewEvent() {
  99.         return this.newEvent;
  100.     }

  102.     @Override
  103.     public String toString() {
  104.         StringBuffer b = new StringBuffer();
  105.         b.append(getType().toString() + " :: ");

  107.         if (getOriginalEvent() != null) {
  108.             b.append(getOriginalEvent().getEventId() + " --> ");
  109.         } else {
  110.             b.append("null --> ");
  111.         }

  113.         if (getNewEvent() != null) {
  114.             b.append(getNewEvent().getEventId());
  115.         } else {
  116.             b.append("null");
  117.         }

  119.         return b.toString();
  120.     }
  121. }
Created with JaCoCo 0.8.8.202204050719