gov.nih.nlm.umls.meta
Interface ConceptMapping

All Superinterfaces:
Comparable
All Known Implementing Classes:
ConceptMappingImpl

public interface ConceptMapping
extends Comparable

Represents a mapping between two UMLS Concept identifiers. Generally the first identifier is a concept that no longer exists in the Metathesaurus and is being mapped to a Concept in the current version (and current subset).

Following is a UML Class diagram showing the neighborhood around ConceptMapping

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

Author:
Brian Carlsen, Deborah Shapiro

Method Summary
 AdditionalRelationshipLabel getAdditionalRelationshipLabel()
          Returns the AdditionalRelationshipLabel (RELA).
 String getConceptIdentifier()
          Returns the concept identifier for the first concept (CUI1).
 String getCui1()
          Returns the concept identifier for the first concept (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 getLastReleaseVersion()
          Returns the last release version in which the CUI1 was valid (VER).
 String getMapin()
          Returns the "in current subset" value (MAPIN).
 String getMapReason()
          Returns the reason for this ConceptMapping (MAPREASON).
 String getReason()
          Return the reason for this ConceptMapping.
 RelationshipLabel getRel()
          Returns the relationship between the two CUIs (REL).
 AdditionalRelationshipLabel getRela()
          Returns the AdditionalRelationshipLabel (RELA).
 RelationshipLabel getRelationship()
          Returns the relationship between the two CUIs (REL).
 String getRelativeConceptIdentifier()
          Returns the concept identifier for the second concept (CUI2).
 String getVer()
          Returns the last release version in which the CUI1 was valid (VER).
 boolean inCurrentSubset()
          Indicates whether or not this ConceptMapping is in the current subset (MAPIN).
 void setAdditionalRelationshipLabel(AdditionalRelationshipLabel rela)
          Sets the AdditionalRelationshipLabel (RELA).
 void setConceptIdentifier(String cui1)
          Sets concept identifier for the first concept (CUI1).
 void setCui1(String cui1)
          Sets concept identifier for the first concept (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 ConceptMapping is in the current subset (MAPIN).
 void setLastReleaseVersion(String ver)
          Sets the last release version in which the CUI1 was valid (VER).
 void setMapin(String mapin)
          Sets the "in current subset" value (MAPIN).
 void setMapReason(String reason)
          Sets the reason for this ConceptMapping (MAPREASON).
 void setReason(String reason)
          Set the reason for this ConceptMapping.
 void setRel(RelationshipLabel rel)
          Sets the relationship between the two CUIs (REL).
 void setRela(AdditionalRelationshipLabel rela)
          Sets the AdditionalRelationshipLabel (RELA).
 void setRelationship(RelationshipLabel rel)
          Sets the relationship between the two CUIs (REL).
 void setRelativeConceptIdentifier(String cui2)
          Sets the concept identifier for the second concept (CUI2).
 void setVer(String ver)
          Sets the last release version in which the CUI1 was valid (VER).
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getCui1

public String getCui1()
Returns the concept identifier for the first concept (CUI1). This method is shorthand for getConceptIdentifier().

Returns:
the concept identifier for the first concept

getConceptIdentifier

public String getConceptIdentifier()
Returns the concept identifier for the first concept (CUI1).

Returns:
the concept identifier for the first concept

setCui1

public void setCui1(String cui1)
Sets concept identifier for the first concept (CUI1). This method is shorthand for setConceptIdentifier(String).

Parameters:
cui1 - the concept identifier for the first concept

setConceptIdentifier

public void setConceptIdentifier(String cui1)
Sets concept identifier for the first concept (CUI1).

Parameters:
cui1 - the concept identifier for the first concept

getLastReleaseVersion

public String getLastReleaseVersion()
Returns the last release version in which the CUI1 was valid (VER).

Returns:
the last release version in which the CUI1 was valid

getVer

public String getVer()
Returns the last release version in which the CUI1 was valid (VER). This method is shortand for getLastReleaseVersion().

Returns:
the last release version in which the CUI1 was valid

setLastReleaseVersion

public void setLastReleaseVersion(String ver)
Sets the last release version in which the CUI1 was valid (VER).

Parameters:
ver - the last release version in which the CUI1 was valid

setVer

public void setVer(String ver)
Sets the last release version in which the CUI1 was valid (VER). This method is shorthand for (@link #setLastReleaseVersion(String)}.

Parameters:
ver - the last release version in which the CUI1 was valid

getRelationship

public RelationshipLabel getRelationship()
Returns the relationship between the two CUIs (REL).

Returns:
the relationship between the two CUIs

getRel

public RelationshipLabel getRel()
Returns the relationship between the two CUIs (REL). This method is shorthand for getRelationship().

Returns:
the relationship between the two CUIs

setRelationship

public void setRelationship(RelationshipLabel rel)
Sets the relationship between the two CUIs (REL).

Parameters:
rel - the relationship between the two CUIs

setRel

public void setRel(RelationshipLabel rel)
Sets the relationship between the two CUIs (REL). This method is shorthand for setRelationship(RelationshipLabel)

Parameters:
rel - the relationship between the two CUIs

getAdditionalRelationshipLabel

public AdditionalRelationshipLabel getAdditionalRelationshipLabel()
Returns the AdditionalRelationshipLabel (RELA).

Returns:
the AdditionalRelationshipLabel

getRela

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

Returns:
the AdditionalRelationshipLabel

setAdditionalRelationshipLabel

public void setAdditionalRelationshipLabel(AdditionalRelationshipLabel rela)
Sets the AdditionalRelationshipLabel (RELA).

Parameters:
rela - then AdditionalRelationshipLabel

setRela

public void setRela(AdditionalRelationshipLabel rela)
Sets the AdditionalRelationshipLabel (RELA). This method is shorthand for setAdditionalRelationshipLabel(AdditionalRelationshipLabel).

Parameters:
rela - then AdditionalRelationshipLabel

getCui2

public String getCui2()
Returns the concept identifier for the second concept (CUI2). This method is shorthand for getRelativeConceptIdentifier().

Returns:
the concept identifier for the second concept

setCui2

public void setCui2(String cui2)
Sets the concept identifier for the second concept (CUI2). This method is shorthand for setRelativeConceptIdentifier(String).

Parameters:
cui2 - the concept identifier for the second concept

getRelativeConceptIdentifier

public String getRelativeConceptIdentifier()
Returns the concept identifier for the second concept (CUI2).

Returns:
the concept identifier for the second concept

setRelativeConceptIdentifier

public void setRelativeConceptIdentifier(String cui2)
Sets the concept identifier for the second concept (CUI2).

Parameters:
cui2 - the concept identifier for the second concept

getMapin

public String getMapin()
Returns the "in current subset" value (MAPIN).

Returns:
the "in current subset" value

inCurrentSubset

public boolean inCurrentSubset()
Indicates whether or not this ConceptMapping is in the current subset (MAPIN).

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

setMapin

public void setMapin(String mapin)
Sets the "in current subset" value (MAPIN).

Parameters:
mapin - the "in current subset" value

setInCurrentSubset

public void setInCurrentSubset(boolean mapin)
Sets the flag indicating whether or not this ConceptMapping is in the current subset (MAPIN).

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

getMapReason

public String getMapReason()
Returns the reason for this ConceptMapping (MAPREASON).

Returns:
the reason for this ConceptMapping

setMapReason

public void setMapReason(String reason)
Sets the reason for this ConceptMapping (MAPREASON).

Parameters:
reason - the reason for this ConceptMapping

getReason

public String getReason()
Return the reason for this ConceptMapping.

Returns:
reason

setReason

public void setReason(String reason)
Set the reason for this ConceptMapping.

Parameters:
reason - reason for the mapping

getKeyFields

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

Returns:
a String composed from key ConceptMapping fields


Copyright ©2005