gov.nih.nlm.nls.metamap

Class PCMBase

java.lang.Object

gov.nih.nlm.nls.metamap.PCMBase

All Implemented Interfaces:

MetaMapElement, PCM

public class PCMBase
extends Object
implements PCM

Implementation of container for a Phrase, Candidates, and Mappings set (PCM).

Created: Thu May 21 17:50:44 2009

Version:

1.0

Author:

Willie Rogers

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	PCMBase.CandidatesImpl
(package private) class	PCMBase.EvImpl
(package private) class	PCMBase.MappingImpl
(package private) class	PCMBase.MatchMapImpl

Field Summary

Fields

Modifier and Type	Field and Description
(package private) se.sics.prologbeans.PBTerm	candidatesTerm
(package private) se.sics.prologbeans.PBTerm	mappingsTerm
(package private) se.sics.prologbeans.PBTerm	phraseTerm

Constructor Summary

Constructors

Constructor and Description
PCMBase(se.sics.prologbeans.PBTerm aPhraseTerm, se.sics.prologbeans.PBTerm aCandidatesTerm, se.sics.prologbeans.PBTerm aMappingsTerm) Creates a new PCMBase instance.

Method Summary

Modifier and Type	Method and Description
List<Ev>	getCandidateList() get candidates list
List<Ev>	getCandidates() Deprecated.
Candidates	getCandidatesInstance() Return the Candidates instance associated with the Phrase.
List<Mapping>	getMappingList() Return the Mapping list associated with the Phrase.
List<Map>	getMappings() Deprecated.
Phrase	getPhrase() Get Phrase associated with Utterance.

Methods inherited from class java.lang.Object

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

Field Detail

phraseTerm

se.sics.prologbeans.PBTerm phraseTerm

candidatesTerm

se.sics.prologbeans.PBTerm candidatesTerm

mappingsTerm

se.sics.prologbeans.PBTerm mappingsTerm

Constructor Detail

PCMBase

public PCMBase(se.sics.prologbeans.PBTerm aPhraseTerm,
               se.sics.prologbeans.PBTerm aCandidatesTerm,
               se.sics.prologbeans.PBTerm aMappingsTerm)

Creates a new PCMBase instance.

Method Detail

getPhrase

public final Phrase getPhrase()
                       throws Exception

Get Phrase associated with Utterance.

Specified by:

getPhrase in interface PCM

Returns:

a Phrase value

Throws:

Exception

getCandidatesInstance

public Candidates getCandidatesInstance()
                                 throws Exception

Return the Candidates instance associated with the Phrase.

Specified by:

getCandidatesInstance in interface PCM

Returns:

a Candidates instances containing a List of candidate Ev instances.

Throws:

Exception

getCandidates

public final List<Ev> getCandidates()
                             throws Exception

Deprecated.

get candidates list

Specified by:

getCandidates in interface PCM

Returns:

a List value

Throws:

Exception

getCandidateList

public final List<Ev> getCandidateList()
                                throws Exception

get candidates list

Specified by:

getCandidateList in interface PCM

Returns:

a List value

Throws:

Exception

getMappings

public final List<Map> getMappings()
                            throws Exception

Deprecated.

Get list of Mapping instances associated with Phrase

Specified by:

getMappings in interface PCM

Returns:

a List value

Throws:

Exception - if an error occurs

getMappingList

public final List<Mapping> getMappingList()
                                   throws Exception

Return the Mapping list associated with the Phrase.

Specified by:

getMappingList in interface PCM

Returns:

a List value

Throws:

Exception - if an error occurs