Product (HCSS - Developer's Reference Manual)

java.lang.Object
- herschel.ia.dataset.AbstractAnnotatable<T>
- - herschel.ia.dataset.AbstractComposite<Product>
  - - herschel.ia.dataset.Product

All Implemented Interfaces:: Annotatable, Attributable, Composite, DatasetBaseListener<Dataset>, DatasetListener, DataWrapperMapper, MetaDataHolder, Copyable<Product>, EventListener

Direct Known Subclasses:: AperturePhotometryProduct, AuxiliaryProduct, BrowseImageProduct, Context, DataFile, DatasetProductWrapper, Fluxes, ImageContour, ImageHistogramProduct, OperationalDaySummaryProduct, Profile, QCLogProduct, QPAuxLog, QPLog, RgbSimpleImage, SampleProduct, SedBaseAdapter, SFProduct, SimpleCube, SimpleImage, SimpleSpectrum, SourceListProduct, SpectralLineList, SpectralLineSurveyAdapter, TagsProduct, Tod, Transition

public class Product
extends AbstractComposite<Product>
implements Copyable<Product>

A Product is a generic result that can be passed on between (standalone) processes.

In general a Product contains zero or more datasets, history, optional metadata as well as some required metadata fields.
Its intent is that it can fully describe itself; this includes the way how this product was achieved (its history). As it is the result of a process, it should be able to save to and restore from an Archive device, which is described in the herschel.ia.io package.

Many times a Product may contain a single dataset and for this purpose the first dataset entry can be accessed by the getDefault() method. Note that the datasets may be a composite of datasets by themselves.

Jython usage
Mandatory Meta-Data
Developers sub-classing Product

Jython usage:

creation:

   creation:
   $ x=Product(description="This is my product example",instrument="MyFavourite",modelName="Flight")
   $ x["RawImage"]=anImage
   $ x["QualityImage"]=aQualityImage
   $ x["Spectrum"]=aSpectrum
   $ x.creator="Me, myself and I"
   $ x.meta["Version"]=
        StringParameter(value="2.1.1a",description="patch taken from download.herschel.int")

access:

   $ print x
   $ print x.default # returns the first added dataset: "RawImage"
   $ raw=x.["RawImage"]
   $ print x.creator
   $ print x.description

comparison:

   $ p1=Product(description="Description")
   $ p2=Product(description="Description 2")
   $ print p1.equals(p2) #shows '0': false
   $ print p1.equals(p1) #shows '1': true
   #A complete report:
   $ print herschel.ia.toolbox.util.ProductDiff.diff(p1,p2)  #shows a report

Mandatory Meta-Data:
All Products must have the following Meta-Data fields:

Metadata table
Keyword Value Type Comment

creator java.lang.String Creator of this Product

creationDate herschel.share.fltdyn.time.FineTime Time of creation of this Product (TAI)

description java.lang.String Full name of the product if applicable or UNKNOWN

instrument java.lang.String Instrument name: SPIRE|PACS|HIFI|SC

startDate herschel.share.fltdyn.time.FineTime Start time of applicability (TAI)

endDate herschel.share.fltdyn.time.FineTime End time of applicability (TAI)

modelName java.lang.String Model name if applicable or UNKNOWN

type java.lang.String Sub-type within this Product family if applicable or UNKNOWN

Metadata table
Keyword	Value Type	Comment
creator	java.lang.String	Creator of this Product
creationDate	herschel.share.fltdyn.time.FineTime	Time of creation of this Product (TAI)
description	java.lang.String	Full name of the product if applicable or `UNKNOWN`
instrument	java.lang.String	Instrument name: SPIRE\|PACS\|HIFI\|SC
startDate	herschel.share.fltdyn.time.FineTime	Start time of applicability (TAI)
endDate	herschel.share.fltdyn.time.FineTime	End time of applicability (TAI)
modelName	java.lang.String	Model name if applicable or `UNKNOWN`
type	java.lang.String	Sub-type within this Product family if applicable or `UNKNOWN`

Developers sub-classing Product:

This generic product is not final; that is, under certain conditions described in the developer's documentation one is allowed to extend this class within Java.

See Also:: ArrayDataset, TableDataset, CompositeDataset, MetaData, History

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Product.DatasetProductLinkedHashMap` HashMap extension for checking 'History' dataset. 'History' dataset is not allowed to be added as a any other dataset.

Field Summary

Fields
Modifier and Type	Field and Description
`static List<String>`	`ATTRIBUTES` List of mandatory metadata entries in all products.
`static String`	`CREATION_DATE` Standard key for creationDate
`static String`	`CREATOR` Standard key for creator
`static String`	`DESCRIPTION` Standard key for description
`static String`	`END_DATE` Standard key for endDate
`static String`	`FORMATV` Standard key for format version
`static String`	`FORMATV_DESCRIPTION` Standard description for format version
`static String`	`FORMATV_INIT_VALUE` Standard value for format version
`static String`	`HISTORY` Standard key for History dataset
`static String`	`INSTRUMENT` Standard key for instrument
`static String`	`MODEL_NAME` Standard key for modelName
`static String`	`START_DATE` Standard key for startDate
`static String`	`TYPE` Standard key for type
`static String`	`UNKNOWN` Unknown string value.

Constructor Summary

Constructors
Constructor and Description
`Product()` Constructs an empty product
`Product(Product copy)` Constructs this as a deep copy of specified argument.
`Product(String description)` Constructs a product with a description

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accept(DatasetVisitor visitor)` Adds functionality through visitor pattern.
`void`	`addProductListener(ProductListener listener)` Adds a listener to the product.
`protected String`	`contentsToString()` Provides a formatted string with information common to all annotatables.
`Product`	`copy()` Returns a deep copy of this Product.
`boolean`	`equals(Object obj)`
`FineTime`	`getCreationDate()` Returns the creation date of this product.
`String`	`getCreator()` Returns the creator of this product.
`Dataset`	`getDefault()` Convenience method that returns the first dataset belonging to this product.
`String`	`getDescription()` gets the description of this Annotatable object.
`double`	`getDuration()` Return the duration in hours of a this Product.
`String`	`getDurationText()` Return the duration of this Product as a human friendly readable string
`FineTime`	`getEndDate()` Returns the end date of this product.
`String`	`getFormatVersion()` Returns the format version of this product
`History`	`getHistory()` Accesses the History of this product.
`String`	`getInstrument()` Returns the instrument name of this product.
`String`	`getModelName()` Returns the model name of this product.
`ProductOwner`	`getOwner()` Returns the product's owner; may be `null`.
`Map<String,Dataset>`	`getSets()` Provide access to the Map<String, Dataset>.
`FineTime`	`getStartDate()` Returns the creation date of this product.
`String`	`getType()` Returns the type of this product.
`int`	`hashCode()`
`void`	`removeProductListener(ProductListener listener)` Removes a listener to the product.
`void`	`setCreationDate(FineTime creationDate)` Changes the creation date of this product.
`void`	`setCreator(String creator)` Changes the creator of this product.
`void`	`setDescription(String newDescription)` Changes the description of this product; a `null` description is converted to the string `UNKNOWN`
`void`	`setEndDate(FineTime endDate)` Changes the end date of this product.
`void`	`setFormatVersion(String formatv)` Changes the format version of this product
`void`	`setHistory(History history)` Replaces the history of this product.
`void`	`setInstrument(String instrument)` Changes the instrument name of this product.
`void`	`setMeta(MetaData newMeta)` Changes the meta data.
`void`	`setModelName(String modelName)` Changes the model name of this product.
`void`	`setOwner(ProductOwner owner)` Sets the product's owner; may be `null`.
`void`	`setStartDate(FineTime startDate)` Changes the start date of this product.
`void`	`setType(String type)` Changes the type of this product.

Methods inherited from class herschel.ia.dataset.AbstractComposite
__getitem__, __setitem__, containsKey, get, getDataWrappers, getMeta, isEmpty, keySet, remove, set, size, targetChanged

Methods inherited from class herschel.ia.dataset.AbstractAnnotatable
getEventSupport, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - FORMATV
```
public static final String FORMATV
```
    Standard key for format version
    
    See Also:
    
    Constant Field Values
  - FORMATV_DESCRIPTION
```
public static final String FORMATV_DESCRIPTION
```
    Standard description for format version
    
    See Also:
    
    Constant Field Values
  - FORMATV_INIT_VALUE
```
public static final String FORMATV_INIT_VALUE
```
    Standard value for format version
    
    See Also:
    
    Constant Field Values
  - CREATOR
```
public static final String CREATOR
```
    Standard key for creator
    
    See Also:
    
    Constant Field Values
  - CREATION_DATE
```
public static final String CREATION_DATE
```
    Standard key for creationDate
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION
```
public static final String DESCRIPTION
```
    Standard key for description
    
    See Also:
    
    Constant Field Values
  - INSTRUMENT
```
public static final String INSTRUMENT
```
    Standard key for instrument
    
    See Also:
    
    Constant Field Values
  - START_DATE
```
public static final String START_DATE
```
    Standard key for startDate
    
    See Also:
    
    Constant Field Values
  - END_DATE
```
public static final String END_DATE
```
    Standard key for endDate
    
    See Also:
    
    Constant Field Values
  - MODEL_NAME
```
public static final String MODEL_NAME
```
    Standard key for modelName
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final String TYPE
```
    Standard key for type
    
    See Also:
    
    Constant Field Values
  - HISTORY
```
public static final String HISTORY
```
    Standard key for History dataset
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTES
```
public static final List<String> ATTRIBUTES
```
    List of mandatory metadata entries in all products.
  - UNKNOWN
```
public static final String UNKNOWN
```
    Unknown string value.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Product
```
public Product()
```
    Constructs an empty product
  - Product
```
public Product(String description)
```
    Constructs a product with a description
    
    Parameters:
    
    description - the description
  - Product
```
public Product(Product copy)
```
    Constructs this as a deep copy of specified argument.
    
    Parameters:
    
    copy - original product.
- Method Detail
  - copy
```
public Product copy()
```
    Returns a deep copy of this Product.
    The copy has the same Product class instance containing a deep copy of meta-data datasets and history.
    If sub-classes override this method, they always have to call this method first.
```
     @Override
     public T copy() {
         T copy=(T)super.copy();
         :
         return copy;
     }
 
```
    Specified by:
    
    copy in interface Copyable<Product>
    
    Returns:
    
    a deep copy
  - setMeta
```
public void setMeta(MetaData newMeta)
```
    Changes the meta data. It keeps the description if the new meta data doesn't contain it.
    
    Specified by:
    
    setMeta in interface Attributable
    
    Overrides:
    
    setMeta in class AbstractComposite<Product>
    
    Parameters:
    
    newMeta - the new meta data
  - getHistory
```
public final History getHistory()
```
    Accesses the History of this product.
    
    Returns:
    
    the history of this product
  - setHistory
```
public final void setHistory(History history)
```
    Replaces the history of this product.
    
    Parameters:
    
    history - the history to replace
  - getDefault
```
public final Dataset getDefault()
```
    Convenience method that returns the first dataset belonging to this product.
    
    Returns:
    
    a Dataset.
    
    Throws:
    
    NoSuchElementException - if the product does not contain any dataset.
  - getDescription
```
public final String getDescription()
```
    Description copied from interface: Annotatable
    
    gets the description of this Annotatable object.
    
    Specified by:
    
    getDescription in interface Annotatable
    
    Overrides:
    
    getDescription in class AbstractAnnotatable<Product>
    
    Returns:
    
    short description. May be null.
  - setDescription
```
public final void setDescription(String newDescription)
```
    Changes the description of this product; a null description is converted to the string UNKNOWN
    
    Specified by:
    
    setDescription in interface Annotatable
    
    Overrides:
    
    setDescription in class AbstractAnnotatable<Product>
    
    Parameters:
    
    newDescription - the new description
  - getType
```
public final String getType()
```
    Returns the type of this product.
    
    Returns:
    
    the type
  - setType
```
public final void setType(String type)
```
    Changes the type of this product.
    
    Parameters:
    
    type - the type
  - getCreator
```
public final String getCreator()
```
    Returns the creator of this product.
    
    Returns:
    
    the creator
  - setCreator
```
public final void setCreator(String creator)
```
    Changes the creator of this product.
    
    Parameters:
    
    creator - the creation date
  - getCreationDate
```
public final FineTime getCreationDate()
```
    Returns the creation date of this product.
    
    Returns:
    
    the creation date
  - setCreationDate
```
public final void setCreationDate(FineTime creationDate)
```
    Changes the creation date of this product.
    
    Parameters:
    
    creationDate - the creation date
  - getInstrument
```
public final String getInstrument()
```
    Returns the instrument name of this product.
    
    Returns:
    
    the instrument
  - setInstrument
```
public final void setInstrument(String instrument)
```
    Changes the instrument name of this product.
    
    Parameters:
    
    instrument - the instrument name
  - getModelName
```
public final String getModelName()
```
    Returns the model name of this product.
    
    Returns:
    
    the model
  - setModelName
```
public final void setModelName(String modelName)
```
    Changes the model name of this product.
    
    Parameters:
    
    modelName - the model name
  - getStartDate
```
public final FineTime getStartDate()
```
    Returns the creation date of this product.
    
    Returns:
    
    the creation date
  - setStartDate
```
public final void setStartDate(FineTime startDate)
```
    Changes the start date of this product.
    
    Parameters:
    
    startDate - the start date
  - getEndDate
```
public final FineTime getEndDate()
```
    Returns the end date of this product.
    
    Returns:
    
    the end date
  - setEndDate
```
public final void setEndDate(FineTime endDate)
```
    Changes the end date of this product.
    
    Parameters:
    
    endDate - the end date
  - getOwner
```
public ProductOwner getOwner()
```
    Returns the product's owner; may be null.
    
    Returns:
    
    the owner
  - setOwner
```
public void setOwner(ProductOwner owner)
```
    Sets the product's owner; may be null.
    
    Parameters:
    
    owner - the owner
  - getFormatVersion
```
public final String getFormatVersion()
```
    Returns the format version of this product
    
    Returns:
    
    the format version of this product
  - setFormatVersion
```
public final void setFormatVersion(String formatv)
```
    Changes the format version of this product
    
    Parameters:
    
    formatv - the format version
  - contentsToString
```
protected String contentsToString()
```
    Description copied from class: AbstractAnnotatable
    
    Provides a formatted string with information common to all annotatables. Implementers can override this method, but should always add this implemenation to the returns string
    
    Overrides:
    
    contentsToString in class AbstractComposite<Product>
    
    Returns:
    
    the common data
  - addProductListener
```
public void addProductListener(ProductListener listener)
```
    Adds a listener to the product.
    Warning: The listener handler must be a class attribute in order to create an object hard reference. See DatasetBaseListener.
    
    Parameters:
    
    listener - the listener
  - removeProductListener
```
public void removeProductListener(ProductListener listener)
```
    Removes a listener to the product.
    
    Parameters:
    
    listener - the listener
  - accept
```
public void accept(DatasetVisitor visitor)
```
    Adds functionality through visitor pattern.
    
    Parameters:
    
    visitor - the added functionality
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getSets
```
public Map<String,Dataset> getSets()
```
    Description copied from class: AbstractComposite
    
    Provide access to the Map<String, Dataset>.
    
    Specified by:
    
    getSets in class AbstractComposite<Product>
    
    Returns:
    
    a map view of contained datasets
  - getDuration
```
public double getDuration()
```
    Return the duration in hours of a this Product. The difference between the startDate and endDate
    
    Returns:
    
    the duration in hours of a this Product.
  - getDurationText
```
public String getDurationText()
```
    Return the duration of this Product as a human friendly readable string
    
    Returns:
    
    the duration of this Product as a human.

Class Product

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class herschel.ia.dataset.AbstractComposite

Methods inherited from class herschel.ia.dataset.AbstractAnnotatable

Methods inherited from class java.lang.Object

Field Detail

FORMATV

FORMATV_DESCRIPTION

FORMATV_INIT_VALUE

CREATOR

CREATION_DATE

DESCRIPTION

INSTRUMENT

START_DATE

END_DATE

MODEL_NAME

TYPE

HISTORY

ATTRIBUTES

UNKNOWN

Constructor Detail

Product

Product

Product

Method Detail

copy

setMeta

getHistory

setHistory

getDefault

getDescription

setDescription

getType

setType

getCreator

setCreator

getCreationDate

setCreationDate

getInstrument

setInstrument

getModelName

setModelName

getStartDate

setStartDate

getEndDate

setEndDate

getOwner

setOwner

getFormatVersion

setFormatVersion

contentsToString

addProductListener

removeProductListener

accept

equals

hashCode

getSets

getDuration

getDurationText