com.jalios.jcms.search

Class NGramFingerPrint

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<java.lang.String,java.lang.Integer>

com.jalios.jcms.search.NGramFingerPrint

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Integer>

public class NGramFingerPrint
extends java.util.Hashtable<java.lang.String,java.lang.Integer>

A FingerPrint maps so called NGrams to their number of occurences in the corresponding text. It is able to categorize itself by comparing its FingerPrint with the FingerPrints of a collection of categories. See sdair-94-bc.pdf in the doc direcory of the jar-file for more information.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NGramFingerPrint()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Integer>	categorize(java.util.Collection<NGramFingerPrint> categories) categorizes the FingerPrint by computing the distance to the FingerPrints in the passed Collection. the category of the FingerPrint with the lowest distance is assigned to this FingerPrint.
void	create(java.lang.String text) fills the FingerPrint with all the NGrams and their numer of occurences in the passed text.
java.lang.String	getCategory() returns the category of the FingerPrint or "unknown" if the FingerPrint wasn't categorized yet.
java.util.Map<java.lang.String,java.lang.Integer>	getCategoryDistances()
int	getPosition(java.lang.String key) gets the position of the NGram passed to method in the FingerPrint. the NGrams are in descending order according to the number of occurences in the text which was used creating the FingerPrint.
void	load(java.lang.String ngram)
protected void	setCategory(java.lang.String category) sets the category of the FingerPrint
java.lang.String	toString() returns the FingerPrint as a String in the FingerPrint file-format

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NGramFingerPrint

public NGramFingerPrint()

Method Detail

load

public void load(java.lang.String ngram)

create

public void create(java.lang.String text)

fills the FingerPrint with all the NGrams and their numer of occurences in the passed text.

Parameters:

text - text to be analysed

categorize

public java.util.Map<java.lang.String,java.lang.Integer> categorize(java.util.Collection<NGramFingerPrint> categories)

categorizes the FingerPrint by computing the distance to the FingerPrints in the passed Collection. the category of the FingerPrint with the lowest distance is assigned to this FingerPrint.

Parameters:

categories -

getCategoryDistances

public java.util.Map<java.lang.String,java.lang.Integer> getCategoryDistances()

getPosition

public int getPosition(java.lang.String key)

gets the position of the NGram passed to method in the FingerPrint. the NGrams are in descending order according to the number of occurences in the text which was used creating the FingerPrint.

Parameters:

key - the NGram

Returns:

the position of the NGram in the FingerPrint

getCategory

public java.lang.String getCategory()

returns the category of the FingerPrint or "unknown" if the FingerPrint wasn't categorized yet.

Returns:

the category of the FingerPrint

toString

public java.lang.String toString()

returns the FingerPrint as a String in the FingerPrint file-format

Overrides:

toString in class java.util.Hashtable<java.lang.String,java.lang.Integer>

setCategory

protected void setCategory(java.lang.String category)

sets the category of the FingerPrint

Parameters:

category - the category