gov.nih.nlm.nls.lvg.Api
Class WordIndApi

java.lang.Object
  gov.nih.nlm.nls.lvg.Api.WordIndApi

public class WordIndApi
extends java.lang.Object

This class provides an API for norm.

History:

Version:

V-2006p

Author:

NLM NLS Development Team

Constructor Summary

WordIndApi()
Creates a WordIndApi object and initiate related data (default).

Method Summary

java.util.Vector	Mutate(LexItem in) A method to get the tokenized strings of an input LexItem
java.util.Vector	Mutate(java.lang.String inTerm) A method to get the tokenized strings of an input string
void	SetReserveCase(boolean reserveCaseFlag) A method to set the flag of reserve case after tokenization

Methods inherited from class java.lang.Object

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

Constructor Detail

WordIndApi

public WordIndApi()

Creates a WordIndApi object and initiate related data (default).

Method Detail

Mutate

public java.util.Vector Mutate(LexItem in)
                        throws java.lang.Exception

A method to get the tokenized strings of an input LexItem

Parameters:

in - an input LexItem to be mutated

Returns:

a Vector of LexItems with target strings are tokenized Strings

Throws:

java.lang.Exception

Mutate

public java.util.Vector Mutate(java.lang.String inTerm)
                        throws java.lang.Exception

A method to get the tokenized strings of an input string

Parameters:

inTerm - an input term in a string format to be mutated

Returns:

a Vector of tokenized Strings

Throws:

java.lang.Exception

SetReserveCase

public void SetReserveCase(boolean reserveCaseFlag)

A method to set the flag of reserve case after tokenization

Parameters:

reserveCaseFlag - an boolean flag of reserving case of tokens