gov.nih.nlm.nls.metamap

Interface PCM

All Superinterfaces:

MetaMapElement

All Known Implementing Classes:

PCMBase

public interface PCM
extends MetaMapElement

Interface for container for a Phrase, Candidates, and Mappings set.

Created: Thu May 21 17:44:31 2009

Version:

1.0

Author:

Willie Rogers

Method Summary

Modifier and Type	Method and Description
List<Ev>	getCandidateList() Return the Candidate (Ev) list associated with the Phrase.
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() Return the Phrase associated with set of Mappings and Candidates.

Method Detail

getPhrase

Phrase getPhrase()
          throws Exception

Return the Phrase associated with set of Mappings and Candidates.

Returns:

the Phrase instance.

Throws:

Exception

getCandidatesInstance

Candidates getCandidatesInstance()
                          throws Exception

Return the (Candidates) instance associated with the Phrase.

Returns:

a Candidates instance containing a List of candidate Ev instances.

Throws:

Exception

getCandidates

List<Ev> getCandidates()
                throws Exception

Deprecated.

Return the candidate (Ev) list associated with the Phrase.

Returns:

a List of Ev candidate Ev instances.

Throws:

Exception

getCandidateList

List<Ev> getCandidateList()
                   throws Exception

Return the Candidate (Ev) list associated with the Phrase.

Returns:

a List of Ev candidate Ev instances.

Throws:

Exception

getMappings

List<Map> getMappings()
               throws Exception

Deprecated.

Get list of Mapping instances associated with Phrase

Returns:

a List of Map instances.

Throws:

Exception

getMappingList

List<Mapping> getMappingList()
                      throws Exception

Return the Mapping list associated with the Phrase.

Returns:

a List of Mapping instances.

Throws:

Exception