com.endeca.itl.cas.api

Enum MetricId

java.lang.Object

java.lang.Enum<MetricId>

com.endeca.itl.cas.api.MetricId

All Implemented Interfaces:

Serializable, Comparable<MetricId>

public enum MetricId
extends Enum<MetricId>

Enumeration of possible Metrics that may be returned from CAS Server. Each metric includes a user-friendly description and an indication of the type of the metric.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARCHIVED_DIRECTORIES_CRAWLED
ARCHIVED_DIRECTORIES_FILTERED
ARCHIVED_FILES_CRAWLED
ARCHIVED_FILES_FILTERED
CRAWL_FAILURE_REASON
CRAWL_MODE
CRAWL_STATE
CRAWL_STOP_CAUSE
DELETED_RECORDS
DIRECTORIES_CRAWLED
DIRECTORIES_FILTERED
DURATION_IN_SECONDS
END_TIME
FAILED_RECORDS
FAILED_TEXT_EXTRACTIONS
FILES_CRAWLED
FILES_FILTERED
NEW_OR_UPDATED_RECORDS
NONARCHIVED_DIRECTORIES_CRAWLED
NONARCHIVED_DIRECTORIES_FILTERED
NONARCHIVED_FILES_CRAWLED
NONARCHIVED_FILES_FILTERED
START_TIME
SUCCESSFUL_TEXT_EXTRACTIONS
SUCCESSFUL_TEXT_EXTRACTIONS_AFTER_RETRY
TOTAL_RECORDS

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription()
MetricType	getMetricType()
static MetricId	valueOf(String name) Returns the enum constant of this type with the specified name.
static MetricId[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CRAWL_MODE

public static final MetricId CRAWL_MODE

CRAWL_STATE

public static final MetricId CRAWL_STATE

CRAWL_STOP_CAUSE

public static final MetricId CRAWL_STOP_CAUSE

CRAWL_FAILURE_REASON

public static final MetricId CRAWL_FAILURE_REASON

FILES_CRAWLED

public static final MetricId FILES_CRAWLED

DIRECTORIES_CRAWLED

public static final MetricId DIRECTORIES_CRAWLED

ARCHIVED_FILES_CRAWLED

public static final MetricId ARCHIVED_FILES_CRAWLED

ARCHIVED_DIRECTORIES_CRAWLED

public static final MetricId ARCHIVED_DIRECTORIES_CRAWLED

NONARCHIVED_FILES_CRAWLED

public static final MetricId NONARCHIVED_FILES_CRAWLED

NONARCHIVED_DIRECTORIES_CRAWLED

public static final MetricId NONARCHIVED_DIRECTORIES_CRAWLED

FILES_FILTERED

public static final MetricId FILES_FILTERED

DIRECTORIES_FILTERED

public static final MetricId DIRECTORIES_FILTERED

ARCHIVED_FILES_FILTERED

public static final MetricId ARCHIVED_FILES_FILTERED

ARCHIVED_DIRECTORIES_FILTERED

public static final MetricId ARCHIVED_DIRECTORIES_FILTERED

NONARCHIVED_FILES_FILTERED

public static final MetricId NONARCHIVED_FILES_FILTERED

NONARCHIVED_DIRECTORIES_FILTERED

public static final MetricId NONARCHIVED_DIRECTORIES_FILTERED

SUCCESSFUL_TEXT_EXTRACTIONS

public static final MetricId SUCCESSFUL_TEXT_EXTRACTIONS

SUCCESSFUL_TEXT_EXTRACTIONS_AFTER_RETRY

public static final MetricId SUCCESSFUL_TEXT_EXTRACTIONS_AFTER_RETRY

FAILED_TEXT_EXTRACTIONS

public static final MetricId FAILED_TEXT_EXTRACTIONS

NEW_OR_UPDATED_RECORDS

public static final MetricId NEW_OR_UPDATED_RECORDS

DELETED_RECORDS

public static final MetricId DELETED_RECORDS

TOTAL_RECORDS

public static final MetricId TOTAL_RECORDS

FAILED_RECORDS

public static final MetricId FAILED_RECORDS

DURATION_IN_SECONDS

public static final MetricId DURATION_IN_SECONDS

START_TIME

public static final MetricId START_TIME

END_TIME

public static final MetricId END_TIME

Method Detail

values

public static MetricId[] 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 (MetricId c : MetricId.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MetricId 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

getDescription

public String getDescription()

getMetricType

public MetricType getMetricType()