HiRISE.HiReport.product

Class ProductNode

java.lang.Object

HiRISE.HiReport.product.ProductNode

Direct Known Subclasses:

StereoProductNode

public class ProductNode
extends java.lang.Object

Represents a product in a hierarchy. A product may have multiple files.

Constructor Summary

Constructors

Constructor and Description
ProductNode(HiProduct product) Create a new product node for the specified type of product
ProductNode(HiProduct product, java.lang.String ref) Create a new product node for the specified type of product

Method Summary

Modifier and Type	Method and Description
void	addProductFile(ProductFile file) Add a file to this node
ProductFile	getAbrowse() Convenience method to get the annotated browse file info if it exists (otherwise null)
boolean	getAvailable() Get the availability.
ProductFile	getBrowse() Convenience method to get the browse file info if it exists (otherwise null)
ProductFile	getColorThumb() Convenience method to get the color thumbnail file if it exists (otherwise null)
java.util.Date	getCreated() Get the creation date
java.lang.String	getDisplayName() Get the (non-unique) name of the product for display.
ProductFile	getFull() Convenience method to get the full file info if it exists (otherwise null)
java.lang.String	getName() Get the name of the product.
HiProduct	getProduct() Get the product enumerator instance
java.util.Map<ProductFileType,ProductFile>	getProductFiles() Get the files for this product
java.lang.String	getRef() Get the reference product ID (may be null)
ProductState	getState() Get the state of this product
java.lang.String	getStatus() Get the status, typically a pipeline name to indicate that the product was last sourced to the pipeline
ProductFile	getThumb() Convenience method to get the thumbnail file info if it exists (otherwise null)
void	setCreated(java.util.Date created) Set the product creation date
void	setState(ProductState state) Set the state of this product
void	setStatus(java.lang.String status) Set the status, e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProductNode

public ProductNode(HiProduct product)

Create a new product node for the specified type of product

Parameters:

product - type

ProductNode

public ProductNode(HiProduct product,
                   java.lang.String ref)

Create a new product node for the specified type of product

Parameters:

product - type

ref - reference product ID

Method Detail

getName

public java.lang.String getName()

Get the name of the product.

Returns:

short unique name

See Also:

Enum.toString()

getDisplayName

public java.lang.String getDisplayName()

Get the (non-unique) name of the product for display.

Returns:

display name

See Also:

HiProduct.getDisplayName()

getProduct

public HiProduct getProduct()

Get the product enumerator instance

Returns:

unique product type

addProductFile

public void addProductFile(ProductFile file)

Add a file to this node

Parameters:

file - reference to file for this product

getProductFiles

public java.util.Map<ProductFileType,ProductFile> getProductFiles()

Get the files for this product

Returns:

map from file type to file

getCreated

public java.util.Date getCreated()

Get the creation date

Returns:

date of creation

setCreated

public void setCreated(java.util.Date created)

Set the product creation date

Parameters:

created - date of creation

getFull

public ProductFile getFull()

Convenience method to get the full file info if it exists (otherwise null)

Returns:

full file reference or null TODO see if this is actually used

getAbrowse

public ProductFile getAbrowse()

Convenience method to get the annotated browse file info if it exists (otherwise null)

Returns:

full file reference or null TODO see if this is actually used

getBrowse

public ProductFile getBrowse()

Convenience method to get the browse file info if it exists (otherwise null)

Returns:

full file reference or null TODO see if this is actually used

getThumb

public ProductFile getThumb()

Convenience method to get the thumbnail file info if it exists (otherwise null)

Returns:

full file reference or null TODO see if this is actually used

getColorThumb

public ProductFile getColorThumb()

Convenience method to get the color thumbnail file if it exists (otherwise null)

Returns:

full file reference or null TODO see if this is actually used

getAvailable

public boolean getAvailable()

Get the availability. A product is considered available if any of its files have been proffered.

Returns:

true if available

getState

public ProductState getState()

Get the state of this product

Returns:

state

setState

public void setState(ProductState state)

Set the state of this product

Parameters:

state - current state

getStatus

public java.lang.String getStatus()

Get the status, typically a pipeline name to indicate that the product was last sourced to the pipeline

Returns:

status

setStatus

public void setStatus(java.lang.String status)

Set the status, e.g. a pipeline name to indicate that it was last entered into that pipeline.

Parameters:

status - pipeline name (or other identifier)

getRef

public java.lang.String getRef()

Get the reference product ID (may be null)

Returns:

referred product ID