gov.nih.nlm.umls.meta
Interface ReleaseMetadata

All Superinterfaces:

Comparable

All Known Implementing Classes:

ReleaseMetadataImpl

public interface ReleaseMetadata
extends Comparable

Represents information about a release of the Metathesaurus. Corresponds to release.dat, plus some data in MRSAB, MRRANK, MRDOC, MRCUI, MRAUI.

Author:

Brian Carlsen, Deborah Shapiro

Method Summary

void	addAncillaryFile(String file_name, Reader reader) Adds ancillary file to a list of ancillary files.
void	addAtomMapping(AtomMapping cm) Adds the specified AtomMapping.
void	addChangeFile(String file_name, Reader reader) Adds change file to a list of change files.
void	addConceptMapping(ConceptMapping cm) Adds the specified ConceptMapping.
void	addCUIRemovedFromSubset(String cui) Add SUBX cui to list of cuis removed from subset.
void	addMetadata(MetaDescription md) Adds the specified MetaDescription.
void	addSourceMetaDescription(SourceMetaDescription smd) Adds the specified SourceMetaDescription.
void	clearAtomMappings() Removes all AtomMappings.
void	clearConceptMappings() Removes all ConceptMappings.
void	clearMetadata() Removes all MetaDescriptions.
void	clearSourceMetaDescription() Removes all SourceMetaDescriptions.
Reader	getAncillaryFile(String file_name) Returns a Reader over the specified ancillary file.
String[]	getAncillaryFileNames() Returns a String[] of all the ancillary file names.
AtomMapping[]	getAtomMappings() Returns all AtomMappings.
List	getAtomMappingsAsList() Returns all AtomMappings as a List.
Reader	getChangeFile(String file_name) Returns the Reader for the given CHANGE file.
String[]	getChangeFileNames() Returns a String[] of all the file names in the CHANGE directory.
ConceptMapping[]	getConceptMappings() Returns all ConceptMappings.
List	getConceptMappingsAsList() Returns all ConceptMappings as a List.
String[]	getCUIsRemovedFromSubset() List of SUBX cuis.
String	getKeyFields() Returns a String key which can be used by equals, compareTo, and hashCode methods.
MetaDescription[]	getMetadata() Returns MetaDescriptions in the current subset.
List	getMetadataAsList() Returns MetaDescription in the current subset as a List.
Date	getReleaseDate() Returns the release Date.
String	getReleaseDescription() Returns the release description.
String	getReleaseVersion() Returns the release version.
SourceMetaDescription[]	getSourceMetadata() Returns SourceMetaDescriptions in the current subset.
List	getSourceMetadataAsList() Returns SourceMetaDescription in the current subset as a List.
SourceTermType[]	getSourceTermTypePrecedence() Returns all SourceTermTypes in rank order.
List	getSourceTermTypePrecedenceAsList() Returns all SourceTermTypes in rank order as a List.
void	removeAtomMapping(AtomMapping cm) Removes the specified AtomMapping.
void	removeConceptMapping(ConceptMapping cm) Removes the specified ConceptMapping.
void	removeMetadata(MetaDescription md) Removes the specified MetaDescription.
void	removeSourceMetaDescription(SourceMetaDescription smd) Removes the specified SourceMetaDescription.
void	setAtomMappings(AtomMapping[] cm) Sets the AtomMappings.
void	setAtomMappings(List cm) Sets the AtomMappings.
void	setConceptMappings(ConceptMapping[] cm) Sets the ConceptMappings.
void	setConceptMappings(List cm) Sets the ConceptMappings.
void	setMetadata(List docs) Sets MetaDescriptions in the current subset.
void	setMetadata(MetaDescription[] docs) Sets MetaDescription in the current subset.
void	setReleaseDate(Date rd) Sets the release Date.
void	setReleaseDescription(String rd) Sets the release description.
void	setReleaseVersion(String rv) Sets the release version.
void	setSourceMetadata(List sabs) Sets SourceMetaDescriptions in the current subset.
void	setSourceMetadata(SourceMetaDescription[] sabs) Sets SourceMetaDescription in the current subset.
void	setSourceTermTypePrecedence(List sab_ttys) Sets all SourceTermTypes in rank order.
void	setSourceTermTypePrecedence(SourceTermType[] sab_ttys) Sets all SourceTermTypes in rank order.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getReleaseVersion

String getReleaseVersion()

Returns the release version.

Returns:

tbe release version

setReleaseVersion

void setReleaseVersion(String rv)

Sets the release version.

Parameters:

rv - tbe release version

getReleaseDate

Date getReleaseDate()

Returns the release Date.

Returns:

tbe release Date.

setReleaseDate

void setReleaseDate(Date rd)

Sets the release Date.

Parameters:

rd - tbe release Date

getReleaseDescription

String getReleaseDescription()

Returns the release description.

Returns:

tbe relase description

setReleaseDescription

void setReleaseDescription(String rd)

Sets the release description.

Parameters:

rd - tbe release description

getSourceMetadata

SourceMetaDescription[] getSourceMetadata()

Returns SourceMetaDescriptions in the current subset.

Returns:

an array of all SourceMetaDescription in the current subset

getSourceMetadataAsList

List getSourceMetadataAsList()

Returns SourceMetaDescription in the current subset as a List.

Returns:

SourceMetaDescription in the current subset as a List

setSourceMetadata

void setSourceMetadata(SourceMetaDescription[] sabs)

Sets SourceMetaDescription in the current subset.

Parameters:

sabs - the SourceMetaDescription in the current subset

setSourceMetadata

void setSourceMetadata(List sabs)

Sets SourceMetaDescriptions in the current subset.

Parameters:

sabs - a List of SourceMetaDescriptions in the current subset

addSourceMetaDescription

void addSourceMetaDescription(SourceMetaDescription smd)

Adds the specified SourceMetaDescription.

Parameters:

smd - the SourceMetaDescription to be added

removeSourceMetaDescription

void removeSourceMetaDescription(SourceMetaDescription smd)

Removes the specified SourceMetaDescription.

Parameters:

smd - the SourceMetaDescription to be removed

clearSourceMetaDescription

void clearSourceMetaDescription()

Removes all SourceMetaDescriptions.

getConceptMappings

ConceptMapping[] getConceptMappings()

Returns all ConceptMappings.

Returns:

an array of all ConceptMappings

getConceptMappingsAsList

List getConceptMappingsAsList()

Returns all ConceptMappings as a List.

Returns:

all ConceptMappings

setConceptMappings

void setConceptMappings(ConceptMapping[] cm)

Sets the ConceptMappings.

Parameters:

cm - the ConceptMappings

setConceptMappings

void setConceptMappings(List cm)

Sets the ConceptMappings.

Parameters:

cm - a List of the ConceptMappings

addConceptMapping

void addConceptMapping(ConceptMapping cm)

Adds the specified ConceptMapping.

Parameters:

cm - the ConceptMapping to be added

removeConceptMapping

void removeConceptMapping(ConceptMapping cm)

Removes the specified ConceptMapping.

Parameters:

cm - the ConceptMapping to be removed

clearConceptMappings

void clearConceptMappings()

Removes all ConceptMappings.

getCUIsRemovedFromSubset

String[] getCUIsRemovedFromSubset()

List of SUBX cuis.

Returns:

array of SUBX cuis

addCUIRemovedFromSubset

void addCUIRemovedFromSubset(String cui)

Add SUBX cui to list of cuis removed from subset.

Parameters:

cui - String

getAtomMappings

AtomMapping[] getAtomMappings()

Returns all AtomMappings.

Returns:

an array of all AtomMappings

getAtomMappingsAsList

List getAtomMappingsAsList()

Returns all AtomMappings as a List.

Returns:

all AtomMappings

setAtomMappings

void setAtomMappings(AtomMapping[] cm)

Sets the AtomMappings.

Parameters:

cm - the AtomMappings

setAtomMappings

void setAtomMappings(List cm)

Sets the AtomMappings.

Parameters:

cm - a List of the AtomMappings

addAtomMapping

void addAtomMapping(AtomMapping cm)

Adds the specified AtomMapping.

Parameters:

cm - the AtomMapping to be added

removeAtomMapping

void removeAtomMapping(AtomMapping cm)

Removes the specified AtomMapping.

Parameters:

cm - the AtomMapping to be removed

clearAtomMappings

void clearAtomMappings()

Removes all AtomMappings.

getSourceTermTypePrecedence

SourceTermType[] getSourceTermTypePrecedence()

Returns all SourceTermTypes in rank order.

Returns:

an array of all SourceTermTypes in rank order

getSourceTermTypePrecedenceAsList

List getSourceTermTypePrecedenceAsList()

Returns all SourceTermTypes in rank order as a List.

Returns:

all SourceTermTypes in rank order as a List

setSourceTermTypePrecedence

void setSourceTermTypePrecedence(SourceTermType[] sab_ttys)

Sets all SourceTermTypes in rank order.

Parameters:

sab_ttys - an array of all SourceTermTypes in rank order

setSourceTermTypePrecedence

void setSourceTermTypePrecedence(List sab_ttys)

Sets all SourceTermTypes in rank order.

Parameters:

sab_ttys - a List of all SourceTermTypes in rank order

getMetadata

MetaDescription[] getMetadata()

Returns MetaDescriptions in the current subset.

Returns:

an array of all MetaDescriptions in the current subset

getMetadataAsList

List getMetadataAsList()

Returns MetaDescription in the current subset as a List.

Returns:

MetaDescription in the current subset as a List

setMetadata

void setMetadata(MetaDescription[] docs)

Sets MetaDescription in the current subset.

Parameters:

docs - the MetaDescription in the current subset

setMetadata

void setMetadata(List docs)

Sets MetaDescriptions in the current subset.

Parameters:

docs - a List of MetaDescriptions in the current subset

addMetadata

void addMetadata(MetaDescription md)

Adds the specified MetaDescription.

Parameters:

md - the MetaDescription to be added

removeMetadata

void removeMetadata(MetaDescription md)

Removes the specified MetaDescription.

Parameters:

md - the MetaDescription to be removed

clearMetadata

void clearMetadata()

Removes all MetaDescriptions.

getChangeFileNames

String[] getChangeFileNames()

Returns a String[] of all the file names in the CHANGE directory.

Returns:

array of all the file names in the CHANGE directory

getChangeFile

Reader getChangeFile(String file_name)

Returns the Reader for the given CHANGE file.

Parameters:

file_name - CHANGE file

Returns:

Reader for the given CHANGE file

getAncillaryFileNames

String[] getAncillaryFileNames()

Returns a String[] of all the ancillary file names.

Returns:

array of all the ancillary file names

getAncillaryFile

Reader getAncillaryFile(String file_name)

Returns a Reader over the specified ancillary file.

Parameters:

file_name - ancillary file

Returns:

a Reader over the specified ancillary file

addChangeFile

void addChangeFile(String file_name,
                   Reader reader)

Adds change file to a list of change files.

Parameters:

file_name - name of change file

reader - a Reader over the file

addAncillaryFile

void addAncillaryFile(String file_name,
                      Reader reader)

Adds ancillary file to a list of ancillary files.

Parameters:

file_name - name of ancillary file

reader - a Reader over the file

getKeyFields

String getKeyFields()

Returns a String key which can be used by equals, compareTo, and hashCode methods.

Returns:

a String composed from key ReleaseMetadata fields.