Package de.dlr.proseo.model

Class Product

java.lang.Object
de.dlr.proseo.model.PersistentObject
de.dlr.proseo.model.Product
@Entity public class Product extends PersistentObject
Representation of a data product
Author:
Dr. Thomas Bassler

  • Constructor Details

    • Product

      public Product()

  • Method Details

    • getUuid

      public UUID getUuid()
      Gets the universally unique product identifier
      Returns:
      the UUID

    • setUuid

      public void setUuid(UUID uuid)
      Sets the universally unique product identifier
      Parameters:
      uuid - the UUID to set

    • getProductClass

      public ProductClass getProductClass()
      Gets the product class
      Returns:
      the productClass

    • setProductClass

      public void setProductClass(ProductClass productClass)
      Sets the product class
      Parameters:
      productClass - the productClass to set

    • getFileClass

      public String getFileClass()
      Gets the product file class
      Returns:
      the file class

    • setFileClass

      public void setFileClass(String fileClass)
      Sets the product file class
      Parameters:
      fileClass - the file class to set

    • getMode

      public String getMode()
      Gets the processing mode
      Returns:
      the mode

    • setMode

      public void setMode(String mode)
      Sets the processing mode
      Parameters:
      mode - the mode to set

    • getProductQuality

      public ProductQuality getProductQuality()
      Gets the product quality indicator
      Returns:
      the product quality

    • setProductQuality

      public void setProductQuality(ProductQuality productQuality)
      Sets the product quality indicator
      Parameters:
      productQuality - the product quality to set

    • getRequestedStartTime

      public Instant getRequestedStartTime()
      Gets the requested start time
      Returns:
      the requested start time

    • setRequestedStartTime

      public void setRequestedStartTime(Instant requestedStartTime)
      Sets the requested start time
      Parameters:
      requestedStartTime - the requested start time to set

    • getRequestedStopTime

      public Instant getRequestedStopTime()
      Gets the requested stop time
      Returns:
      the requested stop time

    • setRequestedStopTime

      public void setRequestedStopTime(Instant requestedStopTime)
      Sets the requested stop time
      Parameters:
      requestedStopTime - the requested stop time to set

    • getSensingStartTime

      public Instant getSensingStartTime()
      Gets the sensing start time
      Returns:
      the sensing start time

    • setSensingStartTime

      public void setSensingStartTime(Instant sensingStartTime)
      Sets the sensing start time
      Parameters:
      sensingStartTime - the sensing start time to set

    • getSensingStopTime

      public Instant getSensingStopTime()
      Gets the sensing stop time
      Returns:
      the sensing stop time

    • setSensingStopTime

      public void setSensingStopTime(Instant sensingStopTime)
      Sets the sensing stop time
      Parameters:
      sensingStopTime - the sensing stop time to set

    • getRawDataAvailabilityTime

      public Instant getRawDataAvailabilityTime()
      Gets the time of the availability of the satellite raw data
      Returns:
      the raw data availability time

    • setRawDataAvailabilityTime

      public void setRawDataAvailabilityTime(Instant rawDataAvailabilityTime)
      Sets the time of the availability of the satellite raw data
      Parameters:
      rawDataAvailabilityTime - the raw data availability time to set

    • getGenerationTime

      public Instant getGenerationTime()
      Gets the product generation time
      Returns:
      the generationTime

    • setGenerationTime

      public void setGenerationTime(Instant generationTime)
      Sets the product generation time
      Parameters:
      generationTime - the generationTime to set

    • getPublicationTime

      public Instant getPublicationTime()
      Gets the product publication (= ingestion) time
      Returns:
      the publication time

    • setPublicationTime

      public void setPublicationTime(Instant publicationTime)
      Sets the product publication (= ingestion) time
      Parameters:
      publicationTime - the publication time to set

    • getEvictionTime

      public Instant getEvictionTime()
      Gets the product eviction time
      Returns:
      the eviction time

    • setEvictionTime

      public void setEvictionTime(Instant evictionTime)
      Sets the product eviction time
      Parameters:
      evictionTime - the eviction time to set

    • getDownloadHistory

      public Set<DownloadHistory> getDownloadHistory()
      Gets the product download history
      Returns:
      the download history

    • setDownloadHistory

      public void setDownloadHistory(Set<DownloadHistory> downloadHistory)
      Sets the product download history
      Parameters:
      downloadHistory - the download history to set

    • getProductionType

      public ProductionType getProductionType()
      Gets the production type of the product
      Returns:
      the production type

    • setProductionType

      public void setProductionType(ProductionType productionType)
      Sets the production type of the product
      Parameters:
      productionType - the production type to set

    • getComponentProducts

      public Set<Product> getComponentProducts()
      Gets the sub-products of this product
      Returns:
      the componentProducts

    • setComponentProducts

      public void setComponentProducts(Set<Product> componentProducts)
      Sets the sub-products of this product
      Parameters:
      componentProducts - the componentProducts to set

    • getEnclosingProduct

      public Product getEnclosingProduct()
      Gets the enclosing product of this product
      Returns:
      the enclosingProduct

    • setEnclosingProduct

      public void setEnclosingProduct(Product enclosingProduct)
      Sets the enclosing product of this product
      Parameters:
      enclosingProduct - the enclosingProduct to set

    • getOrbit

      public Orbit getOrbit()
      Gets the orbit for this product
      Returns:
      the orbit (or null, if this product is not associated to an orbit)

    • setOrbit

      public void setOrbit(Orbit orbit)
      Sets the orbit for this product
      Parameters:
      orbit - the orbit to set (may be null)

    • getProductFile

      public Set<ProductFile> getProductFile()
      Gets the set of product files (at most one per existing processing facility)
      Returns:
      the productFile

    • setProductFile

      public void setProductFile(Set<ProductFile> productFile)
      Sets the set of product files (at most one per existing processing facility)
      Parameters:
      productFile - the productFile to set

    • getSatisfiedProductQueries

      public Set<ProductQuery> getSatisfiedProductQueries()
      Gets the set of satisfied product queries
      Returns:
      the satisfiedProductQueries

    • setSatisfiedProductQueries

      public void setSatisfiedProductQueries(Set<ProductQuery> satisfiedProductQueries)
      Sets the set of satisfied product queries
      Parameters:
      satisfiedProductQueries - the satisfiedProductQueries to set

    • getJobStep

      public JobStep getJobStep()
      Gets the job step that created this product
      Returns:
      the jobStep

    • setJobStep

      public void setJobStep(JobStep jobStep)
      Sets the job step that created this product
      Parameters:
      jobStep - the jobStep to set

    • getConfiguredProcessor

      public ConfiguredProcessor getConfiguredProcessor()
      Gets the configured processor that generated this product
      Returns:
      the configuredProcessor

    • setConfiguredProcessor

      public void setConfiguredProcessor(ConfiguredProcessor configuredProcessor)
      Sets the configured processor that generated this product
      Parameters:
      configuredProcessor - the configuredProcessor to set

    • getParameters

      public Map<String,Parameter> getParameters()
      Gets the product parameters
      Returns:
      the parameters

    • setParameters

      public void setParameters(Map<String,Parameter> parameters)
      Sets the product parameters
      Parameters:
      parameters - the parameters to set

    • getStringParameter

      public String getStringParameter(String key) throws ClassCastException
      Get a named String parameter
      Parameters:
      key - the name of the String parameter
      Returns:
      the parameter value casted to String
      Throws:
      ClassCastException - if the named parameter is not of an appropriate type

    • setStringParameter

      public void setStringParameter(String key, String value)
      Set the named String parameter to the given value
      Parameters:
      key - the parameter name
      value - the parameter value to set

    • getIntegerParameter

      public Integer getIntegerParameter(String key) throws ClassCastException
      Get a named Integer parameter
      Parameters:
      key - the name of the Integer parameter
      Returns:
      the parameter value casted to Integer
      Throws:
      ClassCastException - if the named parameter is not of an appropriate type

    • setIntegerParameter

      public void setIntegerParameter(String key, Integer value)
      Set the named Integer parameter to the given value
      Parameters:
      key - the parameter name
      value - the parameter value to set

    • getBooleanParameter

      public Boolean getBooleanParameter(String key) throws ClassCastException
      Get a named Boolean parameter
      Parameters:
      key - the name of the Boolean parameter
      Returns:
      the parameter value casted to Boolean
      Throws:
      ClassCastException - if the named parameter is not of an appropriate type

    • setBooleanParameter

      public void setBooleanParameter(String key, Boolean value)
      Set the named Boolean parameter to the given value
      Parameters:
      key - the parameter name
      value - the parameter value to set

    • getDoubleParameter

      public Double getDoubleParameter(String key) throws ClassCastException
      Get a named Double parameter
      Parameters:
      key - the name of the Double parameter
      Returns:
      the parameter value casted to Double
      Throws:
      ClassCastException - if the named parameter is not of an appropriate type

    • setDoubleParameter

      public void setDoubleParameter(String key, Double value)
      Set the named Double parameter to the given value
      Parameters:
      key - the parameter name
      value - the parameter value to set

    • getInstantParameter

      public Instant getInstantParameter(String key) throws ClassCastException
      Get a named Instant parameter
      Parameters:
      key - the name of the Instant parameter
      Returns:
      the parameter value casted to Instant
      Throws:
      ClassCastException - if the named parameter is not of an appropriate type

    • setInstantParameter

      public void setInstantParameter(String key, TemporalAccessor value)
      Set the named Instant parameter to the given value
      Parameters:
      key - the parameter name
      value - the parameter value to set

    • generateFilename

      public String generateFilename() throws IllegalStateException, org.springframework.expression.ParseException, org.springframework.expression.EvaluationException
      Generates a product filename according to the file name template given for the enclosing mission
      Returns:
      a filename string
      Throws:
      IllegalStateException - if the filename template for the mission could not be found
      org.springframework.expression.ParseException - if the filename template could not be parsed using Spring Expression Language
      org.springframework.expression.EvaluationException - if the filename template could not be evaluated

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class PersistentObject

    • equals

      public boolean equals(Object obj)
      Tests equality of products based on their attribute values. Returns true if either of the following alternatives holds:
      1. The database IDs are equal
      2. The UUIDs are equal or at least one of the UUIDs is null (i.e. they do not have different UUIDs)
      3. All of the following attributes are equal:
        • Product class
        • Configured processor
        • Sensing start/stop times
        • Processing mode
        • File class
        • Product quality
        • Production type
        • All product parameters present in both products (additional parameters on either product will be ignored)
      Note that the generation time is not considered relevant for product equality, because two processings with the same set of attributes as listed above are expected to produce the same output.
      Overrides:
      equals in class PersistentObject
      Parameters:
      obj - the object to compare to
      Returns:
      true, if the two objects are equal, false otherwise
      See Also: