it.unimi.di.mg4j.index

Class DowncaseTermProcessor

java.lang.Object

it.unimi.di.mg4j.index.DowncaseTermProcessor

All Implemented Interfaces:

TermProcessor, FlyweightPrototype<TermProcessor>, Serializable

public class DowncaseTermProcessor
extends Object
implements TermProcessor

A term processor downcasing all characters.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
DowncaseTermProcessor	copy()
static TermProcessor	getInstance()
boolean	processPrefix(MutableString prefix) Processes the given prefix, leaving the result in the same mutable string.
boolean	processTerm(MutableString term) Processes the given term, leaving the result in the same mutable string.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static final TermProcessor getInstance()

processTerm

public boolean processTerm(MutableString term)

Description copied from interface: TermProcessor

Processes the given term, leaving the result in the same mutable string.

Specified by:

processTerm in interface TermProcessor

Parameters:

term - a mutable string containing the term to be processed, or null.

Returns:

true if the term is not null and should be indexed, false otherwise.

processPrefix

public boolean processPrefix(MutableString prefix)

Description copied from interface: TermProcessor

Processes the given prefix, leaving the result in the same mutable string.

This method is not used during the indexing phase, but rather at query time. If the user wants to specify a prefix query, it is sometimes necessary to transform the prefix (e.g., processPrefix(MutableString) downcasing it).

It is of course unlikely that this method returns false, as it is usually not possible to foresee which are the prefixes of indexable words. In case no natural transformation applies, this method should leave its argument unchanged.

Specified by:

processPrefix in interface TermProcessor

Parameters:

prefix - a mutable string containing a prefix to be processed, or null.

Returns:

true if the prefix is not null and there might be an indexed word starting with prefix, false otherwise.

toString

public String toString()

Overrides:

toString in class Object

copy

public DowncaseTermProcessor copy()

Specified by:

copy in interface TermProcessor

Specified by:

copy in interface FlyweightPrototype<TermProcessor>