com.cososys.sensitivityio.sdc.wrapper

Class LocalClassifier

java.lang.Object

com.cososys.sensitivityio.sdc.wrapper.base.LocalClassifierBase

com.cososys.sensitivityio.sdc.wrapper.LocalClassifier

public final class LocalClassifier
extends LocalClassifierBase

Wrapper class for Classifier. This class handles simple classification of files, string and buffers.

Constructor Summary

Constructors

Constructor and Description
LocalClassifier() Constructor.

Method Summary

Modifier and Type	Method and Description
void	cancelClassifier() Cancels the classifier and the classification in progress.
boolean	classifyBuffer(byte[] buffer, java.lang.String fileName) Executes a buffer classification.
boolean	classifyFile(java.io.File file) Executes a file classification.
boolean	classifyString(java.lang.String string) Executes a string classification.
void	destroy() Destroys the classifier.
void	loadSettings(java.io.File settingsFile) Loads the settings from a file.
void	loadSettings(java.lang.String settings) Loads the settings from a string.

Methods inherited from class com.cososys.sensitivityio.sdc.wrapper.base.LocalClassifierBase

isLicenseLoaded, isSettingsLoaded, loadLicense, loadLicense

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LocalClassifier

public LocalClassifier()

Constructor.

Method Detail

classifyFile

public boolean classifyFile(java.io.File file)
                     throws InvalidArgumentException,
                            java.io.FileNotFoundException,
                            InvalidLicenseException,
                            LicenseExpiredException,
                            LicenseException,
                            SettingsException,
                            java.io.IOException,
                            UnsupportedMimeTypeException,
                            NoKnownDataException,
                            java.lang.Exception

Executes a file classification.

Parameters:

file - The file to be classified.

Returns:

True if the file is corporate, else false.

Throws:

InvalidArgumentException - If file parameter is null.

java.io.FileNotFoundException - If the file does not exist.

InvalidLicenseException - If the license is invalid.

LicenseExpiredException - If the license is expired.

LicenseException - If the license is not loaded.

SettingsException - If the settings are invalid or not loaded.

java.io.IOException - If there was an error reading the file.

UnsupportedMimeTypeException - If this type of file cannot be classified.

NoKnownDataException - If this file cannot be classified.

java.lang.Exception - Generic exception.

classifyString

public boolean classifyString(java.lang.String string)
                       throws InvalidArgumentException,
                              InvalidLicenseException,
                              LicenseExpiredException,
                              LicenseException,
                              SettingsException,
                              NoKnownDataException,
                              java.lang.Exception

Executes a string classification.

Parameters:

string - The string to be classified.

Returns:

True if the file is corporate, else false.

Throws:

InvalidArgumentException - If string parameter is null or empty.

InvalidLicenseException - If the license is invalid.

LicenseExpiredException - If the license is expired.

LicenseException - If the license is not loaded.

SettingsException - If the settings are invalid or not loaded.

NoKnownDataException - If this file cannot be classified.

java.lang.Exception - Generic exception.

classifyBuffer

public boolean classifyBuffer(byte[] buffer,
                              java.lang.String fileName)
                       throws InvalidArgumentException,
                              InvalidLicenseException,
                              LicenseExpiredException,
                              LicenseException,
                              SettingsException,
                              NoKnownDataException,
                              java.lang.Exception

Executes a buffer classification.

Parameters:

buffer - The buffer to be classified.

fileName - If you classify the buffer from a file, specify the file name.

Returns:

True if the file is corporate, else false.

Throws:

InvalidLicenseException - If the license is invalid.

LicenseExpiredException - If the license is expired.

LicenseException - If the license is not loaded.

SettingsException - If the settings are invalid or not loaded.

NoKnownDataException - If this file cannot be classified.

java.lang.Exception - Generic exception.

InvalidArgumentException

loadSettings

public void loadSettings(java.io.File settingsFile)
                  throws SettingsException,
                         InvalidArgumentException,
                         java.io.FileNotFoundException,
                         java.io.IOException,
                         java.lang.Exception

Loads the settings from a file.

Parameters:

settingsFile - The file containing the settings.

Throws:

InvalidArgumentException - If settingsFile argument is null.

SettingsException - If there was an error loading the settings.

java.io.FileNotFoundException - If the settings file does not exist.

java.io.IOException - If there was an error reading the file.

java.lang.Exception - Generic exception.

loadSettings

public void loadSettings(java.lang.String settings)
                  throws SettingsException,
                         InvalidArgumentException,
                         java.lang.Exception

Loads the settings from a string.

Parameters:

settings - The string containing the settings.

Throws:

InvalidArgumentException - If settings argument is null or empty.

SettingsException - If there was an error loading the settings.

java.lang.Exception - Generic exception.

cancelClassifier

public void cancelClassifier()

Cancels the classifier and the classification in progress. After canceling the classifier, the LocalClassifier cannot be used again.

destroy

public void destroy()

Destroys the classifier. You should call this when not using the classifier anymore to avoid memory leaks.