gov.nih.nlm.nls.lexAccess.Api

Class LexAccessApiResult

java.lang.Object

gov.nih.nlm.nls.lexAccess.Api.LexAccessApiResult

public class LexAccessApiResult
extends java.lang.Object

This class provides a java object for the result from LexAccess. It includes the text format and html format of the retrieved lexical records; and the total number of retrieved lexical records.

History:

Version:

V-2016

Author:

NLM NLS Development Team

Constructor Summary

Constructors

Constructor and Description
LexAccessApiResult() Creates a default lexAccess result object

Method Summary

Modifier and Type	Method and Description
java.util.Vector<java.lang.String>	GetBases() Get the Base for the lexical records.
java.util.Vector<java.lang.String>	GetBases(java.lang.String separator) Get the Base with EUI and category information for the lexical records.
java.util.Vector<java.lang.String>	GetInflVars() Get the inflectional variants for the lexical records.
java.util.Vector<java.lang.String>	GetInflVars(java.lang.String separator) Get the inflectional variants for the lexical records.
java.util.Vector<gov.nih.nlm.nls.lexCheck.Lib.LexRecord>	GetJavaObjs() Get the java Objects for the lexical records.
java.util.Vector<java.lang.String>	GetSpellingVars() Get the spelling variants for the lexical records.
java.util.Vector<java.lang.String>	GetSpellingVars(java.lang.String separator) Get the spelling variants for the lexical records.
java.lang.String	GetText() Get the text for the lexical records.
int	GetTotalRecordNumber() Get the total number of the lexical records.
java.lang.String	GetXml() Get the Xml for the lexical records.
void	SetJavaObjs(java.util.Vector<gov.nih.nlm.nls.lexCheck.Lib.LexRecord> lexReocrdObjs) Set the java Objects for the lexical records.
void	SetText(java.lang.String text) Set the text for the lexical records.

Methods inherited from class java.lang.Object

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

Constructor Detail

LexAccessApiResult

public LexAccessApiResult()

Creates a default lexAccess result object

Method Detail

SetJavaObjs

public void SetJavaObjs(java.util.Vector<gov.nih.nlm.nls.lexCheck.Lib.LexRecord> lexReocrdObjs)

Set the java Objects for the lexical records.

Parameters:

lexReocrdObjs - a collection of lexical record java objects

SetText

public void SetText(java.lang.String text)

Set the text for the lexical records.

Parameters:

text - text of the lexical records

GetText

public java.lang.String GetText()

Get the text for the lexical records.

Returns:

text of the lexical records in String

GetJavaObjs

public java.util.Vector<gov.nih.nlm.nls.lexCheck.Lib.LexRecord> GetJavaObjs()

Get the java Objects for the lexical records.

Returns:

collection of lexical record java objects

GetXml

public java.lang.String GetXml()

Get the Xml for the lexical records.

Returns:

xml of the lexical records in String

GetBases

public java.util.Vector<java.lang.String> GetBases()

Get the Base for the lexical records.

Returns:

a collection of String - base of the lexical records

GetBases

public java.util.Vector<java.lang.String> GetBases(java.lang.String separator)

Get the Base with EUI and category information for the lexical records.

Parameters:

separator - string

Returns:

a collection of base of the lexical records

GetSpellingVars

public java.util.Vector<java.lang.String> GetSpellingVars()

Get the spelling variants for the lexical records.

Returns:

a collection of spelling variants of the lexical records

GetSpellingVars

public java.util.Vector<java.lang.String> GetSpellingVars(java.lang.String separator)

Get the spelling variants for the lexical records.

Parameters:

separator - string

Returns:

a collection of spelling variants of the lexical records

GetInflVars

public java.util.Vector<java.lang.String> GetInflVars()

Get the inflectional variants for the lexical records.

Returns:

a collection of inflectional vatiants of the lexical records

GetInflVars

public java.util.Vector<java.lang.String> GetInflVars(java.lang.String separator)

Get the inflectional variants for the lexical records.

Parameters:

separator - the separator character (string)

Returns:

a collection of details of inflectional vatiants

GetTotalRecordNumber

public int GetTotalRecordNumber()

Get the total number of the lexical records.

Returns:

total number of the lexical records