com.netrics.likeit

Class NetricsCharmap

java.lang.Object

com.netrics.likeit.NetricsCharmap

public class NetricsCharmap
extends java.lang.Object

This class contains the definition of a character map that can be used while searching.

It is used to specify which characters should be considered equivalent when searching.

See Also:

NetricsServerInterface.cmapcreate(com.netrics.likeit.NetricsCharmap)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	Punctuation The name of the predefined punctuation sensitive character map.
static java.lang.String	Standard The name of the predefined default character map.

Constructor Summary

Constructors

Constructor and Description
NetricsCharmap(java.lang.String name) Specify the name of the character map.

Method Summary

Methods

Modifier and Type	Method and Description
void	foldCase() Equate upper case, title case and lower case.
void	foldDiacritics() Equate characters with diacritics with their normal cognates.
void	mapChars(char[] fromchars, char[] tochars) Use this method to equate any character with any other.
void	mapPunctuation(char c) Map all punctuation characters to a specific character.
void	mapWhitespace(char c) Map all whitespace characters to a specific character.

Methods inherited from class java.lang.Object

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

Field Detail

Standard

public static final java.lang.String Standard

The name of the predefined default character map.

See Also:

Constant Field Values

Punctuation

public static final java.lang.String Punctuation

The name of the predefined punctuation sensitive character map.

See Also:

Constant Field Values

Constructor Detail

NetricsCharmap

public NetricsCharmap(java.lang.String name)

Specify the name of the character map.

The name will be used when loading the data to tie a character map to a field.

Parameters:

name - Name of the character map.

Method Detail

foldCase

public void foldCase()

Equate upper case, title case and lower case.

foldDiacritics

public void foldDiacritics()

Equate characters with diacritics with their normal cognates.

mapWhitespace

public void mapWhitespace(char c)

Map all whitespace characters to a specific character.

This is often used to equate tabs, non-breaking page spaces, etc to the space character. Note: mapping whitespace to any character other than the standard blank character will significantly alter the scoring of data as all data will be considered a single token.

Parameters:

c - The character to map to

mapPunctuation

public void mapPunctuation(char c)

Map all punctuation characters to a specific character.

This is often used to equate hyphen, slash, period, comma, etc to the space character.

Parameters:

c - The character to map to

mapChars

public void mapChars(char[] fromchars,
            char[] tochars)

Use this method to equate any character with any other.

A character at index x in the from array will be mapped to the character at position x in the to array. Each pair of characters will be considered equivalent for the purposes of matching.

Mappings defined here will supercede the character class mappings defined by foldCase, foldDiacritics, mapWhitespace and mapPunctuation. Thus if you wanted to map all punctuation marks except the pound (#) character you could do so by calling mapPunctuation and mapChars with the pound character mapped to itself.

Parameters:

fromchars - The characters to map from.

tochars - The characters to map to