PgeTaskMetKeys (Apache OODT 1.2-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<PgeTaskMetKeys>
- - org.apache.oodt.cas.pge.metadata.PgeTaskMetKeys

All Implemented Interfaces:

Serializable, Comparable<PgeTaskMetKeys>
```
public enum PgeTaskMetKeys
extends Enum<PgeTaskMetKeys>
```
PGETaskInstance Reserved Metadata keys.

Author:

bfoster (Brian Foster)

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ACTION_IDS` The IDs of the `CrawlerAction`s in the to run.
`ATTEMPT_INGEST_ALL` If set to true then will attempt to ingest all Product's even if one fails.
`CONFIG_FILE_PATH` Path to CAS-PGE's configuration file.
`CRAWLER_CONFIG_FILE` Path to Crawler Spring XML config file.
`CRAWLER_CRAWL_FOR_DIRS` If set to true the crawler will crawl for directories instead of files.
`CRAWLER_RECUR` If set to true the crawler will perform a deep crawl for files.
`DUMP_METADATA` List of `ConfigFilePropertyAdder`s classpaths to be run.
`FILE_STAGER` `FileStager`s classpath.
`INGEST_CLIENT_TRANSFER_SERVICE_FACTORY` The `DataTransferFactory` used for product ingestion.
`INGEST_FILE_MANAGER_URL` CAS File Manager URL used for product ingestion.
`LOG_FILENAME_PATTERN` The java logger `FileHandler` pattern (only for filename though).
`MET_FILE_EXT` Identifies the metadata file name extension to use when CAS-PGE is running in legacy mode and generating metadata files for the StdProductCrawler.
`MIME_EXTRACTOR_REPO` Path to AutoDetectProductCrawler's MimeExtractorRepo XML config.
`NAME` PGE Name used to create the execution script file name and name the Java Logger.
`PGE_CONFIG_BUILDER` CAS-PGE's ConfigBuilder classpath.
`PGE_RUNTIME` Set by CAS-PGE to the number of milliseconds it took CAS-PGE to run.
`PROPERTY_ADDERS` List of `ConfigFilePropertyAdder`s classpaths to be run.
`QUERY_CLIENT_TRANSFER_SERVICE_FACTORY` The `DataTransferFactory` used for product staging.
`QUERY_FILE_MANAGER_URL` CAS File Manager URL used for queries.
`REQUIRED_METADATA` List of metadata keys required for Product ingest.
`WORKFLOW_MANAGER_URL` CAS Workflow Manager URL to which CAS-PGE should update it's status and metadata.

Field Summary

Fields
Modifier and Type Field and Description

static String USE_LEGACY_PROPERTY

Fields
Modifier and Type	Field and Description
`static String`	`USE_LEGACY_PROPERTY`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PgeTaskMetKeys`	`getByName(String name)`
`String`	`getName()`
`boolean`	`isVector()`
`String`	`toString()`
`static PgeTaskMetKeys`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static PgeTaskMetKeys[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

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

- Enum Constant Detail
  - NAME
```
public static final PgeTaskMetKeys NAME
```
    PGE Name used to create the execution script file name and name the Java Logger.
  - CONFIG_FILE_PATH
```
public static final PgeTaskMetKeys CONFIG_FILE_PATH
```
    Path to CAS-PGE's configuration file.
  - PGE_CONFIG_BUILDER
```
public static final PgeTaskMetKeys PGE_CONFIG_BUILDER
```
    CAS-PGE's ConfigBuilder classpath.
  - LOG_FILENAME_PATTERN
```
public static final PgeTaskMetKeys LOG_FILENAME_PATTERN
```
    The java logger FileHandler pattern (only for filename though).
  - PROPERTY_ADDERS
```
public static final PgeTaskMetKeys PROPERTY_ADDERS
```
    List of ConfigFilePropertyAdders classpaths to be run.
  - FILE_STAGER
```
public static final PgeTaskMetKeys FILE_STAGER
```
    FileStagers classpath.
  - DUMP_METADATA
```
public static final PgeTaskMetKeys DUMP_METADATA
```
    List of ConfigFilePropertyAdders classpaths to be run.
  - PGE_RUNTIME
```
public static final PgeTaskMetKeys PGE_RUNTIME
```
    Set by CAS-PGE to the number of milliseconds it took CAS-PGE to run.
  - WORKFLOW_MANAGER_URL
```
public static final PgeTaskMetKeys WORKFLOW_MANAGER_URL
```
    CAS Workflow Manager URL to which CAS-PGE should update it's status and metadata.
  - QUERY_FILE_MANAGER_URL
```
public static final PgeTaskMetKeys QUERY_FILE_MANAGER_URL
```
    CAS File Manager URL used for queries.
  - INGEST_FILE_MANAGER_URL
```
public static final PgeTaskMetKeys INGEST_FILE_MANAGER_URL
```
    CAS File Manager URL used for product ingestion.
  - QUERY_CLIENT_TRANSFER_SERVICE_FACTORY
```
public static final PgeTaskMetKeys QUERY_CLIENT_TRANSFER_SERVICE_FACTORY
```
    The DataTransferFactory used for product staging.
  - INGEST_CLIENT_TRANSFER_SERVICE_FACTORY
```
public static final PgeTaskMetKeys INGEST_CLIENT_TRANSFER_SERVICE_FACTORY
```
    The DataTransferFactory used for product ingestion.
  - CRAWLER_CONFIG_FILE
```
public static final PgeTaskMetKeys CRAWLER_CONFIG_FILE
```
    Path to Crawler Spring XML config file.
  - ACTION_IDS
```
public static final PgeTaskMetKeys ACTION_IDS
```
    The IDs of the CrawlerActions in the to run.
  - CRAWLER_CRAWL_FOR_DIRS
```
public static final PgeTaskMetKeys CRAWLER_CRAWL_FOR_DIRS
```
    If set to true the crawler will crawl for directories instead of files.
  - CRAWLER_RECUR
```
public static final PgeTaskMetKeys CRAWLER_RECUR
```
    If set to true the crawler will perform a deep crawl for files.
  - MIME_EXTRACTOR_REPO
```
public static final PgeTaskMetKeys MIME_EXTRACTOR_REPO
```
    Path to AutoDetectProductCrawler's MimeExtractorRepo XML config.
  - REQUIRED_METADATA
```
public static final PgeTaskMetKeys REQUIRED_METADATA
```
    List of metadata keys required for Product ingest.
  - ATTEMPT_INGEST_ALL
```
public static final PgeTaskMetKeys ATTEMPT_INGEST_ALL
```
    If set to true then will attempt to ingest all Product's even if one fails. If false, will bail ingest after first failed Product ingest.
  - MET_FILE_EXT
```
public static final PgeTaskMetKeys MET_FILE_EXT
```
    Identifies the metadata file name extension to use when CAS-PGE is running in legacy mode and generating metadata files for the StdProductCrawler. If not set, will default in CAS-PGE to .met. Note, there is no new version of this property, it only exists in legacy mode, but an attempt is made to provide a new path style/grouped version of the key for forward compat.
- Field Detail
  - USE_LEGACY_PROPERTY
```
public static final String USE_LEGACY_PROPERTY
```
    See Also:
    
    Constant Field Values
- Method Detail
  - values
```
public static PgeTaskMetKeys[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (PgeTaskMetKeys c : PgeTaskMetKeys.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PgeTaskMetKeys valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getName
```
public String getName()
```
  - isVector
```
public boolean isVector()
```
  - getByName
```
public static PgeTaskMetKeys getByName(String name)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<PgeTaskMetKeys>

Enum PgeTaskMetKeys

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NAME

CONFIG_FILE_PATH

PGE_CONFIG_BUILDER

LOG_FILENAME_PATTERN

PROPERTY_ADDERS

FILE_STAGER

DUMP_METADATA

PGE_RUNTIME

WORKFLOW_MANAGER_URL

QUERY_FILE_MANAGER_URL

INGEST_FILE_MANAGER_URL

QUERY_CLIENT_TRANSFER_SERVICE_FACTORY

INGEST_CLIENT_TRANSFER_SERVICE_FACTORY

CRAWLER_CONFIG_FILE

ACTION_IDS

CRAWLER_CRAWL_FOR_DIRS

CRAWLER_RECUR

MIME_EXTRACTOR_REPO

REQUIRED_METADATA

ATTEMPT_INGEST_ALL

MET_FILE_EXT

Field Detail

USE_LEGACY_PROPERTY

Method Detail

values

valueOf

getName

isVector

getByName

toString