org.apache.oodt.cas.filemgr.structs

Class Product

java.lang.Object

org.apache.oodt.cas.filemgr.structs.Product

public class Product
extends Object

Version:

$Revision$

A Product is a set of files, or a heirarchical, directory structure that should be ingested into the Catalog.

Author:

mattmann, bfoster

Field Summary

Fields

Modifier and Type	Field and Description
static String	STATUS_RECEIVED
static String	STATUS_TRANSFER
static String	STRUCTURE_FLAT
static String	STRUCTURE_HIERARCHICAL
static String	STRUCTURE_STREAM

Constructor Summary

Constructors

Constructor and Description
Product() Default Constructor
Product(InputStream is)
Product(String name, ProductType pType, String structure, String transferStatus, List<Reference> refs) Constructs a new Product with the specified parameters.

Method Summary

Modifier and Type	Method and Description
static Product	getDefaultFlatProduct(String name, String defaultProductTypeId)
String	getProductId()
String	getProductName()
String	getProductReceivedTime()
List<Reference>	getProductReferences()
String	getProductStructure()
ProductType	getProductType()
Reference	getRootRef()
String	getTransferStatus()
void	setProductId(String productId)
void	setProductName(String productName)
void	setProductRecievedTime(String productReceivedTime) Set time product was ingested.
void	setProductReferences(List<Reference> references)
void	setProductStructure(String productStructure)
void	setProductType(ProductType productType)
void	setRootRef(Reference rootRef)
void	setTransferStatus(String transferStatus)
Document	toXML()

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_TRANSFER

public static final String STATUS_TRANSFER

See Also:

Constant Field Values

STATUS_RECEIVED

public static final String STATUS_RECEIVED

See Also:

Constant Field Values

STRUCTURE_FLAT

public static final String STRUCTURE_FLAT

See Also:

Constant Field Values

STRUCTURE_HIERARCHICAL

public static final String STRUCTURE_HIERARCHICAL

See Also:

Constant Field Values

STRUCTURE_STREAM

public static final String STRUCTURE_STREAM

See Also:

Constant Field Values

Constructor Detail

Product

public Product()

Default Constructor

Product

public Product(InputStream is)
        throws InstantiationException

Throws:

InstantiationException

Product

public Product(String name,
               ProductType pType,
               String structure,
               String transferStatus,
               List<Reference> refs)

Constructs a new Product with the specified parameters.

Parameters:

name - The Product's name.

pType - The Product's ProductType.

structure - The structure of the product: either Hierarchical, or Flat.

transferStatus - The status of this product's transfer to the DataStore: TRANSFERING, or RECEIVED would work

refs - A List of References pointing to the items that make up this product.

Method Detail

getProductType

public ProductType getProductType()

Returns:

Returns the productType.

setProductType

public void setProductType(ProductType productType)

Parameters:

productType - The productType to set.

getProductStructure

public String getProductStructure()

Returns:

Returns the productStructure.

setProductStructure

public void setProductStructure(String productStructure)

Parameters:

productStructure - The productStructure to set.

getProductReferences

public List<Reference> getProductReferences()

Returns:

Returns the references.

setProductReferences

public void setProductReferences(List<Reference> references)

Parameters:

references - The references to set.

getProductName

public String getProductName()

Returns:

Returns the productName.

setProductName

public void setProductName(String productName)

Parameters:

productName - The productName to set.

getProductId

public String getProductId()

Returns:

Returns the productId.

setProductId

public void setProductId(String productId)

Parameters:

productId - The productId to set.

getTransferStatus

public String getTransferStatus()

Returns:

Returns the transferStatus.

setTransferStatus

public void setTransferStatus(String transferStatus)

Parameters:

transferStatus - The transferStatus to set.

getRootRef

public Reference getRootRef()

Returns:

the rootRef

setRootRef

public void setRootRef(Reference rootRef)

Parameters:

rootRef - the rootRef to set

getDefaultFlatProduct

public static Product getDefaultFlatProduct(String name,
                                            String defaultProductTypeId)

toXML

public Document toXML()
               throws UnsupportedEncodingException,
                      FileManagerException

Throws:

UnsupportedEncodingException

FileManagerException

setProductRecievedTime

public void setProductRecievedTime(String productReceivedTime)

Set time product was ingested.

Parameters:

productRecievedTime -

getProductReceivedTime

public String getProductReceivedTime()