Package ch.privately.owas.nlp

Enum Class SensitiveInfoAnalyzer

java.lang.Object

java.lang.Enum<SensitiveInfoAnalyzer>

ch.privately.owas.nlp.SensitiveInfoAnalyzer

All Implemented Interfaces:

Serializable, Comparable<SensitiveInfoAnalyzer>, Constable

public enum SensitiveInfoAnalyzer
extends Enum<SensitiveInfoAnalyzer>

 Class to analyze a text for sensitive information.

 It is a good idea to test that the model is loaded before calling analyzeText().
 A simple use-case to test a text for sensitive information would be:


     public SensitiveInfoResult analyseForSensitiveInfo(String text) {
         if (SensitiveInfoAnalyzer.INSTANCE.isLoaded()) {
             return SensitiveInfoAnalyzer.INSTANCE.analyzeText(text);
         }
         return new SensitiveInfoResult();
     }
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Method Summary

Modifier and Type	Method	Description
SensitiveInfoResult	analyzeText(String text)	Analyze a text for sensitive information.
String	getVersion()
void	init()	Initialise the sensitive info analyzer by initialising matchers.
boolean	isLoaded()
static SensitiveInfoAnalyzer	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SensitiveInfoAnalyzer[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INSTANCE

public static final SensitiveInfoAnalyzer INSTANCE

Method Details

values

public static SensitiveInfoAnalyzer[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SensitiveInfoAnalyzer valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

init

public void init()

Initialise the sensitive info analyzer by initialising matchers.

isLoaded

public boolean isLoaded()

Returns:

true if the model is loaded.

getVersion

public String getVersion()

Returns:

The version of this model.

analyzeText

public SensitiveInfoResult analyzeText(String text)

Analyze a text for sensitive information. Catches sharing of UK postcode, UK phone numbers and email addresses.

Parameters:

text - The text to analyze.

Returns:

A SensitiveInfoResult encapsulating the result of the analysis.