gov.nih.nlm.umls.io
Interface MetathesaurusInputStream

All Superinterfaces:
ConceptInputStream
All Known Subinterfaces:
MetamorphoSysInputStream
All Known Implementing Classes:
OriginalMRMetamorphoSysInputStream, OriginalMRMetathesaurusInputStream, RichMRMetamorphoSysInputStream, RichMRMetathesaurusInputStream

public interface MetathesaurusInputStream
extends ConceptInputStream

Generically represents a way of reading the entire Metathesaurus from some input source. This source can be MR Files, update MR Files, a database, or pretty much anything else that can be defined by one or more "locations" or "paths".

Author:
Deborah Shapiro

Method Summary
 String[] getAmbiguousStringIdentifiers()
          Returns the complete list of suis from the AMBIGSUI list.
 List getAmbiguousStringIdentifiersAsList()
          Returns the complete list of suis from the AMBIGSUI list.
 String[] getAmbiguousTermIdentifiers()
          Returns the complete list of terms from the AMBIGLUI list.
 List getAmbiguousTermIdentifiersAsList()
          Returns the complete list of terms from the AMBIGLUI list.
 int getIndexProgress()
          Returns the percentage of the IndexEntry objects that have been processed.
 IndexEntry readIndexEntry()
          Read an IndexEntry from the input stream and return it.
 ReleaseMetadata readReleaseMetadata()
          Read the ReleaseMetadata from the input stream and return it.
 
Methods inherited from interface gov.nih.nlm.umls.io.ConceptInputStream
close, getConceptProgress, open, readConcept
 

Method Detail

readIndexEntry

public IndexEntry readIndexEntry()
                          throws IOException
Read an IndexEntry from the input stream and return it. This method should provide the mapping between the input files and IndexEntry objects. Futhermore, it should be implemented like a stream, in the sense that only the content for the next IndexEntry should be read into memory.

Returns:
the next IndexEntry
Throws:
IOException - if there is a problem reading the index entry

readReleaseMetadata

public ReleaseMetadata readReleaseMetadata()
                                    throws IOException
Read the ReleaseMetadata from the input stream and return it.

Returns:
the ReleaseMetadata for this input stream
Throws:
IOException - if there is a problem reading the release metadata

getIndexProgress

public int getIndexProgress()
Returns the percentage of the IndexEntry objects that have been processed.

Returns:
the percentage of the IndexEntry objects that have been processed

getAmbiguousStringIdentifiers

public String[] getAmbiguousStringIdentifiers()
                                       throws IOException
Returns the complete list of suis from the AMBIGSUI list. They will be used in calculating entries for the output AMBIGSUI list.

Returns:
list of suis
Throws:
IOException

getAmbiguousStringIdentifiersAsList

public List getAmbiguousStringIdentifiersAsList()
                                         throws IOException
Returns the complete list of suis from the AMBIGSUI list. They will be used in calculating entries for the output AMBIGSUI list.

Returns:
list of suis
Throws:
IOException

getAmbiguousTermIdentifiers

public String[] getAmbiguousTermIdentifiers()
                                     throws IOException
Returns the complete list of terms from the AMBIGLUI list. They will be used in calculating entries for the output AMBIGLUI list.

Returns:
list of terms
Throws:
IOException

getAmbiguousTermIdentifiersAsList

public List getAmbiguousTermIdentifiersAsList()
                                       throws IOException
Returns the complete list of terms from the AMBIGLUI list. They will be used in calculating entries for the output AMBIGLUI list.

Returns:
list of terms
Throws:
IOException


Copyright ©2005