gov.nih.nlm.nls.metamap

Class ResultImpl

java.lang.Object

gov.nih.nlm.nls.metamap.ResultImpl

All Implemented Interfaces:

Result

public class ResultImpl
extends Object
implements Result

An implemention of the Result interface, a container for the result of a MetaMap query.

Created: Wed May 20 13:50:35 2009

Version:

1.0

Author:

Willie Rogers

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	ResultImpl.AcronymsAbbrevsImpl aas(["ABC"*"American Broadcasting System" *[1,3,5,28]*[], "CBS"*"Columbia Broadcasting System" *[1,3,5,28]*[]]).
(package private) class	ResultImpl.NegationImpl
(package private) class	ResultImpl.UtteranceImpl

Field Summary

Fields

Modifier and Type	Field and Description
private static int	ACRONYMS_ABBREVS_INDEX
private static int	FIRST_UTTERANCE_INDEX
String	inputText
private se.sics.prologbeans.PBTerm	mmoTermList
private static int	NEGATIONLIST_INDEX

Constructor Summary

Constructors

Constructor and Description
ResultImpl() Creates a new ResultImpl instance.
ResultImpl(se.sics.prologbeans.PBTerm mmoTerm) Creates a new ResultImpl instance.
ResultImpl(se.sics.prologbeans.PBTerm mmoTerm, String theInputText) Creates a new ResultImpl instance.

Method Summary

Modifier and Type	Method and Description
List<AcronymsAbbrevs>	getAcronymsAbbrevs() Describe getAcronymsAbbrevs method here.
List<AcronymsAbbrevs>	getAcronymsAbbrevsList() Describe getAcronymsAbbrevsList method here.
String	getInputText() Get input text that produced this result.
String	getMachineOutput() Return the raw string representation of MetaMap machine output.
se.sics.prologbeans.PBTerm	getMMOPBlist() Return a prolog beans list of terms representing machine output.
List<Negation>	getNegationList() Describe getNegationList method here.
List<Negation>	getNegations() Describe getNegations method here.
private List<PCM>	getPCMList(int utterancePosition) Deprecated.
List<Utterance>	getUtteranceList() Describe getUtterances method here.
void	setInputText(String theInputText) Assign inputText that produced this result.
String	toString() Implementation of toString method for Result.
void	traverse(PrintStream out) Print machine output to stream.

Methods inherited from class java.lang.Object

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

Field Detail

mmoTermList

private se.sics.prologbeans.PBTerm mmoTermList

ACRONYMS_ABBREVS_INDEX

private static final int ACRONYMS_ABBREVS_INDEX

See Also:

Constant Field Values

NEGATIONLIST_INDEX

private static final int NEGATIONLIST_INDEX

See Also:

Constant Field Values

FIRST_UTTERANCE_INDEX

private static final int FIRST_UTTERANCE_INDEX

See Also:

Constant Field Values

inputText

public String inputText

Constructor Detail

ResultImpl

public ResultImpl()

Creates a new ResultImpl instance.

ResultImpl

public ResultImpl(se.sics.prologbeans.PBTerm mmoTerm)
           throws Exception

Creates a new ResultImpl instance.

Parameters:

mmoTerm - a prolog term containing MetaMap machine output.

Throws:

Exception

ResultImpl

public ResultImpl(se.sics.prologbeans.PBTerm mmoTerm,
                  String theInputText)
           throws Exception

Creates a new ResultImpl instance.

Parameters:

mmoTerm - a prolog term containing MetaMap machine output.

theInputText - the input text that produced this result.

Throws:

Exception

Method Detail

setInputText

public void setInputText(String theInputText)

Description copied from interface: Result

Assign inputText that produced this result.

Specified by:

setInputText in interface Result

Parameters:

theInputText - the input text that produced this result.

getInputText

public String getInputText()

Description copied from interface: Result

Get input text that produced this result.

Specified by:

getInputText in interface Result

Returns:

theInputText the input text that produced this result.

getMMOPBlist

public se.sics.prologbeans.PBTerm getMMOPBlist()

Description copied from interface: Result

Return a prolog beans list of terms representing machine output.

Specified by:

getMMOPBlist in interface Result

Returns:

prolog beans list of machine output terms

traverse

public void traverse(PrintStream out)

Description copied from interface: Result

Print machine output to stream.

Specified by:

traverse in interface Result

Parameters:

out - stream to send output.

getMachineOutput

public String getMachineOutput()

Description copied from interface: Result

Return the raw string representation of MetaMap machine output.

Specified by:

getMachineOutput in interface Result

Returns:

a String containing the result as MetaMap machine output.

getAcronymsAbbrevs

public final List<AcronymsAbbrevs> getAcronymsAbbrevs()
                                               throws Exception

Describe getAcronymsAbbrevs method here.

Specified by:

getAcronymsAbbrevs in interface Result

Returns:

a List of

Throws:

Exception

getAcronymsAbbrevsList

public final List<AcronymsAbbrevs> getAcronymsAbbrevsList()
                                                   throws Exception

Describe getAcronymsAbbrevsList method here.

Specified by:

getAcronymsAbbrevsList in interface Result

Returns:

a List of

Throws:

Exception

getNegations

public final List<Negation> getNegations()
                                  throws Exception

Describe getNegations method here.

Specified by:

getNegations in interface Result

Returns:

a List of Negation Instances.

Throws:

Exception

getNegationList

public final List<Negation> getNegationList()
                                     throws Exception

Describe getNegationList method here.

Specified by:

getNegationList in interface Result

Returns:

a List of Negation Instances.

Throws:

Exception

getUtteranceList

public List<Utterance> getUtteranceList()
                                 throws Exception

Describe getUtterances method here.

Specified by:

getUtteranceList in interface Result

Returns:

a list of Utterance terms

Throws:

Exception

getPCMList

private List<PCM> getPCMList(int utterancePosition)
                      throws Exception

Deprecated.

Return a list of PCM (Phrase/Candidate/Mapping) objects starting at start in machine output. It is recommended to use the Utterance implementation of getPCMList rather than this one.

Parameters:

utterancePosition - position of relevant utterance

Returns:

list of Phrase/Candidates/Mappings (PCM) objects

Throws:

Exception

toString

public String toString()

Implementation of toString method for Result.

Overrides:

toString in class Object