lumis.service.analytics.usersegmentation.enums

Enum UserMonitorFieldsCSVEnum

java.lang.Object

java.lang.Enum<UserMonitorFieldsCSVEnum>

lumis.service.analytics.usersegmentation.enums.UserMonitorFieldsCSVEnum

All Implemented Interfaces:

Serializable, Comparable<UserMonitorFieldsCSVEnum>

public enum UserMonitorFieldsCSVEnum
extends Enum<UserMonitorFieldsCSVEnum>

A enum to organize the options field for CSV Download User Segmentation.

Since:

11.1.0

Version:

$Revision: 22640 $ $Date: 2019-04-05 21:31:52 +0000 (Fri, 05 Apr 2019) $

Enum Constant Summary

Enum Constants

Enum Constant and Description
CREATEDDATETIME_DATETIME
EMAIL_TOKEN
FRIENDLYID
GROUPS_ALIASES
GROUPS_IDS
LOGIN
NAME_FIRST_TOKEN
NAME_FULL_TOKEN
NAME_LAST_TOKEN
NAME_MIDDLE_TOKEN
PORTALUSERID
VISITORID

Field Summary

Fields

Modifier and Type	Field and Description
DocumentTypeField	documentType

Method Summary

Modifier and Type	Method and Description
int	getComparatorOrder() Create a index integer to helps the sort Comparable for class {link FieldReportCSV}
static int	getComparatorOrder(String fullIdElasticSearchField) Create a index integer to helps the sort Comparable for class {link FieldReportCSV}
String	getLabel(IResource resource) Get localized label for the field.
static String	getLabel(String fullIdElasticSearchField, IResource resource) Get localized label for the field.
static UserMonitorFieldsCSVEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static UserMonitorFieldsCSVEnum[]	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

NAME_FULL_TOKEN

public static final UserMonitorFieldsCSVEnum NAME_FULL_TOKEN

EMAIL_TOKEN

public static final UserMonitorFieldsCSVEnum EMAIL_TOKEN

FRIENDLYID

public static final UserMonitorFieldsCSVEnum FRIENDLYID

LOGIN

public static final UserMonitorFieldsCSVEnum LOGIN

NAME_FIRST_TOKEN

public static final UserMonitorFieldsCSVEnum NAME_FIRST_TOKEN

NAME_MIDDLE_TOKEN

public static final UserMonitorFieldsCSVEnum NAME_MIDDLE_TOKEN

NAME_LAST_TOKEN

public static final UserMonitorFieldsCSVEnum NAME_LAST_TOKEN

CREATEDDATETIME_DATETIME

public static final UserMonitorFieldsCSVEnum CREATEDDATETIME_DATETIME

PORTALUSERID

public static final UserMonitorFieldsCSVEnum PORTALUSERID

GROUPS_ALIASES

public static final UserMonitorFieldsCSVEnum GROUPS_ALIASES

GROUPS_IDS

public static final UserMonitorFieldsCSVEnum GROUPS_IDS

VISITORID

public static final UserMonitorFieldsCSVEnum VISITORID

Field Detail

documentType

public final DocumentTypeField documentType

Method Detail

values

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

Returns:

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

valueOf

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

getLabel

public String getLabel(IResource resource)
                throws PortalException

Get localized label for the field.

Parameters:

resource - resource of strings.

Returns:

the localized label.

Throws:

PortalException

Since:

11.1.0

getLabel

public static String getLabel(String fullIdElasticSearchField,
                              IResource resource)
                       throws PortalException

Get localized label for the field.

Parameters:

fullIdElasticSearchField - documentType elasticsearch field

resource - resource of strings.

Returns:

the localized label.

Throws:

PortalException

Since:

11.1.0

getComparatorOrder

public static int getComparatorOrder(String fullIdElasticSearchField)

Create a index integer to helps the sort Comparable for class {link FieldReportCSV}

Parameters:

fullIdElasticSearchField - request field code

Returns:

a integer to sort field.

Since:

11.1.0

getComparatorOrder

public int getComparatorOrder()

Create a index integer to helps the sort Comparable for class {link FieldReportCSV}

Returns:

a integer to sort field.

Since:

11.1.0