com.factual.engine.api

Enum VisitSensitivity

java.lang.Object

java.lang.Enum<VisitSensitivity>

com.factual.engine.api.VisitSensitivity

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<VisitSensitivity>

public enum VisitSensitivity
extends java.lang.Enum<VisitSensitivity>

Used to control some qualities of generated visits.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MEDIUM_RECALL Medium visit geolocation accuracy, medium detection precision, excludes shorter-length visits, medium detection recall.
PRECISION_OPTIMIZED Higher visit geolocation accuracy, higher detection precision, excludes short- and medium-length visits, lower detection recall.
RECALL_OPTIMIZED Lower visit geolocation accuracy, lower detection precision, includes shorter-length visits, higher detection recall.
UNKNOWN_SENSITIVITY An internal error could produce UNKNOWN_SENSITIVITY.

Method Summary

Modifier and Type	Method and Description
int	getValue()
static VisitSensitivity	getVisitSensitivity(int val)
static VisitSensitivity	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static VisitSensitivity[]	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

UNKNOWN_SENSITIVITY

public static final VisitSensitivity UNKNOWN_SENSITIVITY

An internal error could produce UNKNOWN_SENSITIVITY.

RECALL_OPTIMIZED

public static final VisitSensitivity RECALL_OPTIMIZED

Lower visit geolocation accuracy, lower detection precision, includes shorter-length visits, higher detection recall. This is the default.

MEDIUM_RECALL

public static final VisitSensitivity MEDIUM_RECALL

Medium visit geolocation accuracy, medium detection precision, excludes shorter-length visits, medium detection recall.

PRECISION_OPTIMIZED

public static final VisitSensitivity PRECISION_OPTIMIZED

Higher visit geolocation accuracy, higher detection precision, excludes short- and medium-length visits, lower detection recall.

Method Detail

values

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

Returns:

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

valueOf

public static VisitSensitivity valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getValue

public int getValue()

getVisitSensitivity

public static VisitSensitivity getVisitSensitivity(int val)