org.apache.oodt.pcs.pedigree

Class Pedigree

java.lang.Object

org.apache.oodt.pcs.pedigree.Pedigree

All Implemented Interfaces:

PCSConfigMetadata, PCSMetadata

public class Pedigree
extends Object
implements PCSMetadata, PCSConfigMetadata

A class to provide pedigre tracking for PCS Products.

Version:

$Revision$

Author:

mattmann

Field Summary

Fields inherited from interface org.apache.oodt.pcs.metadata.PCSMetadata

APPLICATION_SUCCESS_FLAG, COLLECTION_LABEL, COMMENTS, DATA_PROVIDER, DATA_VERSION, END_DATE_TIME, EXECUTABLE_PATHNAMES, EXECUTABLE_VERSIONS, INPUT_FILES, JOB_ID, ON_DISK, OUTPUT_FILES, PGE_NAME, PROCESSING_LEVEL, PRODUCTION_DATE_TIME, PRODUCTION_LOCATION, PRODUCTION_LOCATION_CODE, START_DATE_TIME, SUB_TEST_TAG, TAPE_LOCATION, TASK_ID, TEST_COUNTER, TEST_DATE, TEST_LOCATION, TEST_TAG

Fields inherited from interface org.apache.oodt.pcs.metadata.PCSConfigMetadata

CLIENT_TRANSFER_SERVICE_FACTORY, CONF_FILE_BUILD, CONFIG_FILE_SCHEMA_PATH, CRAWLER_CLEANUP, CRAWLER_CRAWLDIRS, CRAWLING, FILE_MANAGER_URL, JAVA_EXT_DIR, JAVA_MAIN_CLASS, MAX_ALLOWABLE_GAP_MINUTES, NUM_JAVA_EXT_DIRS, PGE_CONFIG_FILE_NAME, PGE_CONFIG_FILE_PROPERTY_ADDER_CLASS, PGE_LOG_FILE_NAME, PGE_TASK_TYPE, PGE_TYPE_GDS_ADAPTOR, PGE_TYPE_GDS_PGE, RUNNING_PGE, SCF_FILE_MANAGER_URL, STAGING_INPUT, UNKNOWN, WORKFLOW_INST_ID, WORKFLOW_MANAGER_URL, WORKFLOW_MGR_URL

Constructor Summary

Constructors

Constructor and Description
Pedigree(FileManagerUtils fm, boolean listNotCat, List excludeList) Constructs a new Pedigree object that will connect to the file manager specified by the FileManagerUtils object passed in.
Pedigree(String fmUrlStr, boolean listNotCat, List excludeList) Constructs a new Pedigree object that will connect to the file manager at the given URL specified by the fmUrlStr string parameter.

Method Summary

Modifier and Type	Method and Description
PedigreeTree	doPedigree(Product orig, boolean upstream) Performs a full pedigree of the specified Product orig .
List	getDownstreamPedigreedProducts(Product orig) Returns the most direct ancestors (a List of Products) downstream from the given Product named orig.
List	getUpstreamPedigreedProducts(Product orig) Returns the most direct ancestors (a List of Products) upstream from the given Product named orig.
List	getWorkflowInstProds(String wInstId) Gets all associated Products with the provided WorkflowInstance identified by its ID (the wInstId string parameter).

Methods inherited from class java.lang.Object

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

Constructor Detail

Pedigree

public Pedigree(String fmUrlStr,
                boolean listNotCat,
                List excludeList)

Constructs a new Pedigree object that will connect to the file manager at the given URL specified by the fmUrlStr string parameter.

Parameters:

fmUrlStr - The String URL of the file manager to connect to.

listNotCat - Whether or not we should include non-cataloged products in the pedigree.

excludeList - A List of String ProductType names that should be excluded from the Pedigree.

Pedigree

public Pedigree(FileManagerUtils fm,
                boolean listNotCat,
                List excludeList)

Constructs a new Pedigree object that will connect to the file manager specified by the FileManagerUtils object passed in.

Parameters:

fm - The PCS interface to the File Manager.

listNotCat - Whether or not we should include non-cataloged products in the pedigree.

excludeList - A List of String ProductType names that should be excluded from the Pedigree.

Method Detail

doPedigree

public PedigreeTree doPedigree(Product orig,
                               boolean upstream)

Performs a full pedigree of the specified Product orig . If upstream is set to true, an upstream pedigree is performed, otherwise, a downstream pedigree is performed.

Parameters:

orig - The Product to perform a pedigree of.

upstream - Whether or not we should do an upstream (true) or downstream (false) pedigree.

Returns:

A PedigreeTree containing the Pedigree of a given product.

getUpstreamPedigreedProducts

public List getUpstreamPedigreedProducts(Product orig)

Returns the most direct ancestors (a List of Products) upstream from the given Product named orig.

Parameters:

orig - The Product to get direct upstream relatives of.

Returns:

A List of Products directly upstream from the given Product.

getDownstreamPedigreedProducts

public List getDownstreamPedigreedProducts(Product orig)

Returns the most direct ancestors (a List of Products) downstream from the given Product named orig.

Parameters:

orig - The Product to get direct downstream relatives of.

Returns:

A List of Products directly downstream from the given Product.

getWorkflowInstProds

public List getWorkflowInstProds(String wInstId)

Gets all associated Products with the provided WorkflowInstance identified by its ID (the wInstId string parameter).

Parameters:

wInstId - The ID of the WorkflowInstance to look up the Products for.

Returns:

A List of Products associated with the provided Workflow Instance ID.