gov.nih.nlm.mms
Interface MetamorphoSysInputStream

All Superinterfaces:

Comparable, ConceptInputStream, Configurable, GUIConfigurable, LocalNullValueSupport, MetathesaurusInputStream, SubsetListener

All Known Implementing Classes:

NLMFileMetamorphoSysInputStream, OriginalMRMetamorphoSysInputStream, RichMRMetamorphoSysInputStream

public interface MetamorphoSysInputStream
extends MetathesaurusInputStream, GUIConfigurable, SubsetListener

Generically represents an input source for Metathesaurus data.

Author:

Deborah Shapiro

Method Summary

int	getChooserType() Indicates the type of file accepted by the file chooser.
int	getConceptProgress() Return an int between 0 and 100 indicating how far along the input stream is in reading Concepts.
int	getIndexProgress() Return an int between 0 and 100 indicating how far along the input stream is in reading IndexEntry elements.
boolean	hasFullContextData() Indicates whether this input source has full context data, such as that included in a MRCXT file.
boolean	isEfficientMode() Returns the mode in which subsetting will be run.
void	setEfficientMode(boolean efficient) Sets the subsetting mode to efficient.
boolean	validateSourcePath(String source_path) Validates the source path.
boolean	validateSourcePaths(String[] source_paths) Validates the source paths.
boolean	validateVersion(String path) Attempts to determine the version of the release being used and validate it against the version from the properties file.
boolean	validateVersions(String[] source_paths) For each source path it attempts to determine the version of the release being used and validate it against the version from the properties file.

Methods inherited from interface gov.nih.nlm.umls.io.MetathesaurusInputStream

getAmbiguousStringIdentifiers, getAmbiguousStringIdentifiersAsList, getAmbiguousTermIdentifiers, getAmbiguousTermIdentifiersAsList, readIndexEntry, readReleaseMetadata

Methods inherited from interface gov.nih.nlm.umls.io.ConceptInputStream

close, getWarnings, open, readConcept

Methods inherited from interface gov.nih.nlm.util.LocalNullValueSupport

getNullValue, isEmptyValue, setNullValue

Methods inherited from interface gov.nih.nlm.mms.GUIConfigurable

addDataChangeListener, getColor, getGUIConfigurableForValidationFailure, getHelpPanel, getName, getPanel, getTabDescription, getValidationErrors, getValidationWarnings, hasAdvancedOptions, hasDataChanged, removeDataChangeListener, resetDataChanged, setDataChanged, setPanelSelections, showOptions, validate

Methods inherited from interface gov.nih.nlm.mms.Configurable

getConfigurationDetails, getProperties, resetToDefaults, setConfiguration, setConfiguration, setProperties

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface gov.nih.nlm.mms.SubsetListener

beginInitializeCuiList, beginSubsetContent, endInitializeCuiList, endSubsetContent, setCuiList

Method Detail

getConceptProgress

int getConceptProgress()

Return an int between 0 and 100 indicating how far along the input stream is in reading Concepts. This information can be used for a progress monitor.

Specified by:

getConceptProgress in interface ConceptInputStream

Returns:

int representing percentage complete

getIndexProgress

int getIndexProgress()

Return an int between 0 and 100 indicating how far along the input stream is in reading IndexEntry elements. This information can be used for a progress monitor.

Specified by:

getIndexProgress in interface MetathesaurusInputStream

Returns:

int representing percentage complete

validateSourcePath

boolean validateSourcePath(String source_path)

Validates the source path. This involves checking that it both exists, is readable and that it has access to MR data.

Parameters:

source_path - path to be validated

Returns:

true if validation passes false otherwise

validateSourcePaths

boolean validateSourcePaths(String[] source_paths)

Validates the source paths. This involves checking that they both exist, are readable and that they have access to MR data.

Parameters:

source_paths - to be validated

Returns:

true if validation passes false otherwise

validateVersions

boolean validateVersions(String[] source_paths)

For each source path it attempts to determine the version of the release being used and validate it against the version from the properties file. If the version is determined to be a mismatch or if it cannot be determined, false is returned.

Parameters:

source_paths - to be validated

Returns:

true if validation passes false otherwise

validateVersion

boolean validateVersion(String path)

Attempts to determine the version of the release being used and validate it against the version from the properties file. If the version is determined to be a mismatch or if it cannot be determined, false is returned.

Parameters:

path - source path to be validated

Returns:

true if validation passes false otherwise

getChooserType

int getChooserType()

Indicates the type of file accepted by the file chooser.

Returns:

String

setEfficientMode

void setEfficientMode(boolean efficient)

Sets the subsetting mode to efficient. In the efficient mode, the "Initialize Cuis" phase of the subsetting only references MRCONSO and MRSTY.

Parameters:

efficient - true if subsetting should be run in efficient mode false if not

isEfficientMode

boolean isEfficientMode()

Returns the mode in which subsetting will be run. In the efficient mode, the "Initialize Cuis" phase of the subsetting only references MRCONSO and MRSTY.

Returns:

true if subsetting will be run in efficient mode false otherwise

hasFullContextData

boolean hasFullContextData()

Indicates whether this input source has full context data, such as that included in a MRCXT file.

Returns:

true if this input source has full context data; false otherwise.