gov.nih.nlm.umls.meta
Interface AtomMapping

All Superinterfaces:

Comparable

All Known Implementing Classes:

AtomMappingImpl

public interface AtomMapping
extends Comparable

Represents a mapping for a between two UMLS Atom identifiers. For the time being, we only represent changes in CUI values from one release to another, but eventually this data structure will represent things like "safe replacement".

Following is a UML Class diagram showing the neighborhood around AtomMapping

All data in a row of the MRAUI file is represented here.

Author:

Brian Carlsen

Method Summary

AdditionalRelationshipLabel	getAdditionalRelationshipLabel() Returns the AdditionalRelationshipLabel (RELA).
String	getAtomIdentifier() Returns the atom identifier for the first atom (AUI1).
String	getAui1() Returns the atom identifier for the first atom (AUI1).
String	getAui2() Returns the atom identifier for the second atom (AUI2).
String	getConceptIdentifier() Returns the concept identifier for the first atom (CUI1).
String	getCui1() Returns the concept identifier of the first atom as it was in the specified release version (CUI1).
String	getCui2() Returns the concept identifier for the second concept (CUI2).
String	getKeyFields() Returns a String key which can be used by equals, compareTo, and hashCode methods.
String	getMapin() Returns the "in current subset" value (MAPIN).
String	getMapReason() Returns the reason for this AtomMapping (MAPREASON).
RelationshipLabel	getRel() Returns the relationship between the two AUIs (REL).
AdditionalRelationshipLabel	getRela() Returns the AdditionalRelationshipLabel (RELA).
String	getRelatedAtomIdentifier() Returns the atom identifier for the second atom (AUI2).
String	getRelatedConceptIdentifier() Returns the concept identifier for the second concept (CUI2).
RelationshipLabel	getRelationshipLabel() Returns the relationship between the two AUIs (REL).
String	getReleaseVersion() Returns the release version in which the indicated change took place (VER).
String	getVer() Returns the release version in which the indicated change took place (VER).
boolean	inCurrentSubset() Indicates whether or not this AtomMapping is in the current subset (MAPIN).
void	setAdditionalRelationshipLabel(AdditionalRelationshipLabel rela) Sets the AdditionalRelationshipLabel (RELA).
void	setAtomIdentifier(String aui1) Sets atom identifier for the first atom (AUI1).
void	setAui1(String aui1) Sets atom identifier for the first atom (AUI1).
void	setAui2(String aui2) Sets atom identifier for the second atom (AUI2).
void	setConceptIdentifier(String cui1) Sets concept identifier for the first atom (CUI1).
void	setCui1(String cui1) Sets concept identifier for the first atom (CUI1).
void	setCui2(String cui2) Sets the concept identifier for the second concept (CUI2).
void	setInCurrentSubset(boolean mapin) Sets the flag indicating whether or not this AtomMapping is in the current subset (MAPIN).
void	setMapin(String mapin) Sets the "in current subset" value (MAPIN).
void	setMapReason(String reason) Sets the reason for this AtomMapping (MAPREASON).
void	setRel(RelationshipLabel rel) Sets the relationship between the two AUIs (REL).
void	setRela(AdditionalRelationshipLabel rela) Sets the AdditionalRelationshipLabel (RELA).
void	setRelatedAtomIdentifier(String aui2) Sets atom identifier for the second atom (AUI2).
void	setRelatedConceptIdentifier(String cui2) Sets the concept identifier for the second concept (CUI2).
void	setRelationshipLabel(RelationshipLabel rel) Sets the relationship between the two AUIs (REL).
void	setReleaseVersion(String ver) Sets the release version in which the indicated change took place (VER).
void	setVer(String ver) Sets the release version in which the indicated change took place (VER).

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getAui1

String getAui1()

Returns the atom identifier for the first atom (AUI1). This method is shorthand for getAtomIdentifier().

Returns:

the atom identifier for the first atom

getAtomIdentifier

String getAtomIdentifier()

Returns the atom identifier for the first atom (AUI1).

Returns:

the atom identifier for the first atom

setAui1

void setAui1(String aui1)

Sets atom identifier for the first atom (AUI1). This method is shorthand for setAtomIdentifier(String).

Parameters:

aui1 - the atom identifier for the first atom

setAtomIdentifier

void setAtomIdentifier(String aui1)

Sets atom identifier for the first atom (AUI1).

Parameters:

aui1 - the atom identifier for the first atom

getCui1

String getCui1()

Returns the concept identifier of the first atom as it was in the specified release version (CUI1). This method is shorthand for getConceptIdentifier().

Returns:

the concept identifier for the first atom

getConceptIdentifier

String getConceptIdentifier()

Returns the concept identifier for the first atom (CUI1).

Returns:

the concept identifier for the first atom

setCui1

void setCui1(String cui1)

Sets concept identifier for the first atom (CUI1). This method is shorthand for setConceptIdentifier(String).

Parameters:

cui1 - the concept identifier for the first atom

setConceptIdentifier

void setConceptIdentifier(String cui1)

Sets concept identifier for the first atom (CUI1).

Parameters:

cui1 - the concept identifier for the first atom

getReleaseVersion

String getReleaseVersion()

Returns the release version in which the indicated change took place (VER).

Returns:

the release version in which the indicated change took place

getVer

String getVer()

Returns the release version in which the indicated change took place (VER). This method is shortand for getReleaseVersion().

Returns:

the release version in which the indicated change took place

setReleaseVersion

void setReleaseVersion(String ver)

Sets the release version in which the indicated change took place (VER).

Parameters:

ver - the release version in which the indicated change took place

setVer

void setVer(String ver)

Sets the release version in which the indicated change took place (VER). This method is shorthand for (@link #setReleaseVersion(String)}.

Parameters:

ver - the release version in which the indicated change took place

getRelationshipLabel

RelationshipLabel getRelationshipLabel()

Returns the relationship between the two AUIs (REL).

Returns:

the relationship between the two AUIs

getRel

RelationshipLabel getRel()

Returns the relationship between the two AUIs (REL). This method is shorthand for getRelationshipLabel().

Returns:

the relationship between the two AUIs

setRelationshipLabel

void setRelationshipLabel(RelationshipLabel rel)

Sets the relationship between the two AUIs (REL).

Parameters:

rel - the relationship between the two AUIs

setRel

void setRel(RelationshipLabel rel)

Sets the relationship between the two AUIs (REL). This method is shorthand for setRelationshipLabel(RelationshipLabel)

Parameters:

rel - the relationship between the two AUIs

getAdditionalRelationshipLabel

AdditionalRelationshipLabel getAdditionalRelationshipLabel()

Returns the AdditionalRelationshipLabel (RELA).

Returns:

the AdditionalRelationshipLabel

getRela

AdditionalRelationshipLabel getRela()

Returns the AdditionalRelationshipLabel (RELA). This method is shorthand for getAdditionalRelationshipLabel().

Returns:

the AdditionalRelationshipLabel

setAdditionalRelationshipLabel

void setAdditionalRelationshipLabel(AdditionalRelationshipLabel rela)

Sets the AdditionalRelationshipLabel (RELA).

Parameters:

rela - then AdditionalRelationshipLabel

setRela

void setRela(AdditionalRelationshipLabel rela)

Sets the AdditionalRelationshipLabel (RELA). This method is shorthand for setAdditionalRelationshipLabel(AdditionalRelationshipLabel).

Parameters:

rela - then AdditionalRelationshipLabel

getAui2

String getAui2()

Returns the atom identifier for the second atom (AUI2). This method is shorthand for getRelatedAtomIdentifier().

Returns:

the atom identifier for the second atom

getRelatedAtomIdentifier

String getRelatedAtomIdentifier()

Returns the atom identifier for the second atom (AUI2).

Returns:

the atom identifier for the second atom

setAui2

void setAui2(String aui2)

Sets atom identifier for the second atom (AUI2). This method is shorthand for setAtomIdentifier(String).

Parameters:

aui2 - the atom identifier for the second atom

setRelatedAtomIdentifier

void setRelatedAtomIdentifier(String aui2)

Sets atom identifier for the second atom (AUI2).

Parameters:

aui2 - the atom identifier for the second atom

getCui2

String getCui2()

Returns the concept identifier for the second concept (CUI2). This method is shorthand for getRelatedConceptIdentifier().

Returns:

the concept identifier for the second concept

setCui2

void setCui2(String cui2)

Sets the concept identifier for the second concept (CUI2). This method is shorthand for setRelatedConceptIdentifier(String).

Parameters:

cui2 - the concept identifier for the second concept

getRelatedConceptIdentifier

String getRelatedConceptIdentifier()

Returns the concept identifier for the second concept (CUI2).

Returns:

the concept identifier for the second concept

setRelatedConceptIdentifier

void setRelatedConceptIdentifier(String cui2)

Sets the concept identifier for the second concept (CUI2).

Parameters:

cui2 - the concept identifier for the second concept

getMapin

String getMapin()

Returns the "in current subset" value (MAPIN).

Returns:

the "in current subset" value

inCurrentSubset

boolean inCurrentSubset()

Indicates whether or not this AtomMapping is in the current subset (MAPIN).

Returns:

boolean true if in current subset, boolean false if not in current subset

setMapin

void setMapin(String mapin)

Sets the "in current subset" value (MAPIN).

Parameters:

mapin - the "in current subset" value

setInCurrentSubset

void setInCurrentSubset(boolean mapin)

Sets the flag indicating whether or not this AtomMapping is in the current subset (MAPIN).

Parameters:

mapin - boolean true if in current subset, boolean false if not in current subset

getMapReason

String getMapReason()

Returns the reason for this AtomMapping (MAPREASON).

Returns:

the reason for this AtomMapping

setMapReason

void setMapReason(String reason)

Sets the reason for this AtomMapping (MAPREASON).

Parameters:

reason - the reason for this AtomMapping

getKeyFields

String getKeyFields()

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

Returns:

a String composed from key AtomMapping fields