net.sf.classifier4J
Interface ICategorisedClassifier

All Superinterfaces:

IClassifier

All Known Subinterfaces:

ITrainableClassifier

All Known Implementing Classes:

AbstractCategorizedTrainableClassifier

public interface ICategorisedClassifier

extends IClassifier

Author:

Nick Lothian, Peter Leschev

Field Summary

static java.lang.String

DEFAULT_CATEGORY

Fields inherited from interface net.sf.classifier4J.IClassifier

DEFAULT_CUTOFF, LOWER_BOUND, NEUTRAL_PROBABILITY, UPPER_BOUND

Method Summary

double	classify(java.lang.String category, java.lang.String input) Function to determine the probability string matches a criteria for a given category.
boolean	isMatch(java.lang.String category, java.lang.String input) Function to determine if a string matches a criteria for a given category

Methods inherited from interface net.sf.classifier4J.IClassifier

classify, isMatch, isMatch, setMatchCutoff

Field Detail

DEFAULT_CATEGORY

public static final java.lang.String DEFAULT_CATEGORY

See Also:

Constant Field Values

Method Detail

classify

public double classify(java.lang.String category,
                       java.lang.String input)
                throws ClassifierException

Function to determine the probability string matches a criteria for a given category.

Parameters:

category - the category to check against

input - the string to classify

Returns:

the likelyhood that this string is a match for this net.sf.classifier4J. 1 means 100% likely.

Throws:

ClassifierException - If a fatal problem occurs. For example, the database is unavailable.

isMatch

public boolean isMatch(java.lang.String category,
                       java.lang.String input)
                throws ClassifierException

Function to determine if a string matches a criteria for a given category

Parameters:

category - the category to check against

input - the string to classify

Returns:

true if the input string has a probability >= the cutoff probability of matching

Throws:

ClassifierException - If a fatal problem occurs. For example, the database is unavailable.