com.linkedin.feathr.common.types

Enum FeatureType.BasicType

java.lang.Object

java.lang.Enum<FeatureType.BasicType>

com.linkedin.feathr.common.types.FeatureType.BasicType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FeatureType.BasicType>

Enclosing class:

FeatureType

@InternalApi
public static enum FeatureType.BasicType
extends java.lang.Enum<FeatureType.BasicType>

Enum for the top-level feature types supported by Feathr. The enum values conform to specific subtypes of FeatureType and FeatureValue. In the current API, if you see a FeatureType with .getBasicType() == NUMERIC, then you may assume the FeatureType is a NumericFeatureType and any FeatureValue associated with it is a NumericFeatureValue. Etc. This guarantee is mainly for convenience and clarity in the code within Feathr, and IT IS POSSIBLE THAT THIS GUARANTEE MIGHT NOT HOLD TRUE in subsequent versions, so external code outside of Feathr should not rely on it.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOOLEAN
CATEGORICAL
CATEGORICAL_SET
DENSE_VECTOR
NUMERIC
TENSOR
TERM_VECTOR

Method Summary

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

BOOLEAN

public static final FeatureType.BasicType BOOLEAN

NUMERIC

public static final FeatureType.BasicType NUMERIC

CATEGORICAL

public static final FeatureType.BasicType CATEGORICAL

CATEGORICAL_SET

public static final FeatureType.BasicType CATEGORICAL_SET

TERM_VECTOR

public static final FeatureType.BasicType TERM_VECTOR

DENSE_VECTOR

public static final FeatureType.BasicType DENSE_VECTOR

TENSOR

public static final FeatureType.BasicType TENSOR

Method Detail

values

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

Returns:

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

valueOf

public static FeatureType.BasicType 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