org.apache.ctakes.dictionary.lookup2.util

Enum UmlsUserApprover

java.lang.Object

java.lang.Enum<UmlsUserApprover>

org.apache.ctakes.dictionary.lookup2.util.UmlsUserApprover

All Implemented Interfaces:

Serializable, Comparable<UmlsUserApprover>

public enum UmlsUserApprover
extends Enum<UmlsUserApprover>

Used to validate UMLS license / user.

TODO Authentication before download would be nice, or perhaps an encrypted download Author: SPF Affiliation: CHIP-NLP Date: 2/19/14

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Field Summary

Fields

Modifier and Type	Field and Description
static String	PASS_PARAM
static String	URL_PARAM
static String	USER_PARAM
static String	VENDOR_PARAM

Method Summary

Modifier and Type	Method and Description
static UmlsUserApprover	getInstance()
boolean	isValidUMLSUser(String umlsUrl, String vendor, String user, String pass) validate the UMLS license / user
boolean	isValidUMLSUser(org.apache.uima.UimaContext uimaContext, Properties properties) validate the UMLS license / user
static UmlsUserApprover	valueOf(String name) Returns the enum constant of this type with the specified name.
static UmlsUserApprover[]	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

INSTANCE

public static final UmlsUserApprover INSTANCE

Field Detail

URL_PARAM

public static final String URL_PARAM

See Also:

Constant Field Values

VENDOR_PARAM

public static final String VENDOR_PARAM

See Also:

Constant Field Values

USER_PARAM

public static final String USER_PARAM

See Also:

Constant Field Values

PASS_PARAM

public static final String PASS_PARAM

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getInstance

public static UmlsUserApprover getInstance()

isValidUMLSUser

public boolean isValidUMLSUser(org.apache.uima.UimaContext uimaContext,
                               Properties properties)

validate the UMLS license / user

Parameters:

uimaContext - contains information about the UMLS license / user

properties - -

Returns:

true if the server at umlsaddr approves of the vendor, user, password combination

isValidUMLSUser

public boolean isValidUMLSUser(String umlsUrl,
                               String vendor,
                               String user,
                               String pass)

validate the UMLS license / user

Parameters:

umlsUrl - -

vendor - -

user - -

pass - -

Returns:

true if the server at umlsaddr approves of the vendor, user, password combination