gov.nih.nlm.umls.meta
Interface Mapping

All Superinterfaces:
Comparable, ConceptElement, ContentViewElement, SourceElement
All Known Implementing Classes:
MappingImpl

public interface Mapping
extends ConceptElement, ContentViewElement, SourceElement, Comparable

Represents information about a mapping from one kind of UMLS data to another. This could be cross-source mappings like those that appear in SNOMED, or it could be associated expressions.

Following is a UML Class diagram showing the neighborhood around Mapping

All data in a row of the MRMAP file is represented by this and by MapObject.

Author:
Brian Carlsen, Deborah Shapiro

Nested Class Summary
 
Nested classes inherited from class gov.nih.nlm.umls.meta.SourceElement
SourceElement.BySourceComparator, SourceElement.BySourceRestrictor
 
Method Summary
 AdditionalRelationshipLabel getAdditionalRelationshipLabel()
          Returns the AdditionalRelationshipLabel (RELA).
 AttributeName getAttributeName()
          Returns the AttributeName (MAPATN).
 String getAttributeValue()
          Returns the attribute value (MAPATV).
 MapObject getFrom()
          Returns the mapped from MapObject.
 String getId()
          Returns the unique identifier (MAPID).
 String getIdentifier()
          Returns the unique identifier (MAPID).
 String getKeyFields()
          Returns a String key which can be used by equals, compareTo, and hashCode methods.
 String getRank()
          Returns the rank (MAPRANK).
 RelationshipLabel getRel()
          Returns the RelationshipLabel (REL).
 AdditionalRelationshipLabel getRela()
          Returns the AdditionalRelationshipLabel (RELA).
 RelationshipLabel getRelationshipName()
          Returns the RelationshipLabel (REL).
 String getRes()
          Returns the human readable rule for use of mapping (MAPRES).
 String getRestriction()
          Returns the human readable rule for use of mapping (MAPRES).
 String getRule()
          Returns the machine processable rule for when to apply mapping (MAPRULE).
 String getSid()
          Returns the source asserted unique identifier (MAPSID).
 String getSourceIdentifier()
          Returns the source asserted unique identifier (MAPSID).
 String getSubsetId()
          Returns the subset identifier (SUBSETUI).
 String getSubsetIdentifier()
          Returns the subset identifier (SUBSETUI).
 MapObject getTo()
          Returns the mapped to MapObject.
 String getType()
          Returns the type of mapping (MAPTYPE).
 void setAdditionalRelationshipLabel(AdditionalRelationshipLabel rela)
          Sets the AdditionalRelationshipLabel (RELA).
 void setAttributeName(AttributeName atn)
          Sets the AttributeName (MAPATN).
 void setAttributeValue(String atv)
          Sets the attribute value (MAPATV).
 void setFrom(MapObject from)
          Sets the mapped from MapObject.
 void setId(String id)
          Sets the unique identifier (MAPID).
 void setIdentifier(String id)
          Sets the unique identifier (MAPID).
 void setRank(String rank)
          Sets the rank (MAPRANK).
 void setRel(RelationshipLabel rel)
          Sets the RelationshipLabel (REL).
 void setRela(AdditionalRelationshipLabel rela)
          Sets the AdditionalRelationshipLabel (RELA).
 void setRelationshipName(RelationshipLabel rel)
          Sets the RelationshipLabel (REL).
 void setRes(String res)
          Sets the human readable rule for use of mapping (MAPRES).
 void setRestriction(String res)
          Sets the human readable rule for use of mapping (MAPRES).
 void setRule(String rule)
          Sets the machine processable rule for when to apply mapping (MAPRULE).
 void setSid(String sid)
          Sets the source asserted unique identifier (MAPSID).
 void setSourceIdentifier(String sid)
          Sets the source asserted unique identifier (MAPSID).
 void setSubsetId(String subset)
          Sets the subset identifier (SUBSETUI).
 void setSubsetIdentifier(String subset)
          Sets the subset identifier (SUBSETUI).
 void setTo(MapObject to)
          Sets the mapped to MapObject.
 void setType(String type)
          Sets the type of mapping (MAPTYPE).
 
Methods inherited from interface gov.nih.nlm.umls.meta.ConceptElement
getConcept, setConcept
 
Methods inherited from interface gov.nih.nlm.umls.meta.ContentViewElement
getContentView, getCvf, setContentView, setCvf
 
Methods inherited from interface gov.nih.nlm.umls.meta.SourceElement
getSource, setSource
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getAdditionalRelationshipLabel

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

Returns:
the AdditionalRelationshipLabel

getRela

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

Returns:
the AdditionalRelationshipLabel

setAdditionalRelationshipLabel

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

Parameters:
rela - the AdditionalRelationshipLabel

setRela

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

Parameters:
rela - the AdditionalRelationshipLabel

getSubsetIdentifier

public String getSubsetIdentifier()
Returns the subset identifier (SUBSETUI).

Returns:
the subset identifier

setSubsetIdentifier

public void setSubsetIdentifier(String subset)
Sets the subset identifier (SUBSETUI).

Parameters:
subset - subset identifier

getSubsetId

public String getSubsetId()
Returns the subset identifier (SUBSETUI). This method is shorthand for getSubsetIdentifier().

Returns:
the subset identifier

setSubsetId

public void setSubsetId(String subset)
Sets the subset identifier (SUBSETUI). This method is shorthand for setSubsetIdentifier(String).

Parameters:
subset - subset identifier

getRank

public String getRank()
Returns the rank (MAPRANK).

Returns:
the rank

setRank

public void setRank(String rank)
Sets the rank (MAPRANK).

Parameters:
rank - priority

getSourceIdentifier

public String getSourceIdentifier()
Returns the source asserted unique identifier (MAPSID).

Returns:
the source asserted unique identifier

setSourceIdentifier

public void setSourceIdentifier(String sid)
Sets the source asserted unique identifier (MAPSID).

Parameters:
sid - source asserted unique identifier

getSid

public String getSid()
Returns the source asserted unique identifier (MAPSID). This method is shorthand for getSourceIdentifier().

Returns:
the source asserted unique identifier

setSid

public void setSid(String sid)
Sets the source asserted unique identifier (MAPSID). This method is shorthand for setSourceIdentifier(String).

Parameters:
sid - source asserted unique identifier

getIdentifier

public String getIdentifier()
Returns the unique identifier (MAPID).

Returns:
the unique identifier

setIdentifier

public void setIdentifier(String id)
Sets the unique identifier (MAPID).

Parameters:
id - unique identifier

getId

public String getId()
Returns the unique identifier (MAPID). This method is shorthand for getIdentifier().

Returns:
the unique identifier

setId

public void setId(String id)
Sets the unique identifier (MAPID). This method is shorthand for setIdentifier(String).

Parameters:
id - unique identifier

getRelationshipName

public RelationshipLabel getRelationshipName()
Returns the RelationshipLabel (REL).

Returns:
the RelationshipLabel

getRel

public RelationshipLabel getRel()
Returns the RelationshipLabel (REL). This is shorthand for getRelationshipName().

Returns:
the RelationshipLabel

setRelationshipName

public void setRelationshipName(RelationshipLabel rel)
Sets the RelationshipLabel (REL).

Parameters:
rel - the RelationshipLabel

setRel

public void setRel(RelationshipLabel rel)
Sets the RelationshipLabel (REL). This is shorthand for setRelationshipName(RelationshipLabel).

Parameters:
rel - the RelationshipLabel

getRule

public String getRule()
Returns the machine processable rule for when to apply mapping (MAPRULE).

Returns:
the map rule

setRule

public void setRule(String rule)
Sets the machine processable rule for when to apply mapping (MAPRULE).

Parameters:
rule - String

getRestriction

public String getRestriction()
Returns the human readable rule for use of mapping (MAPRES).

Returns:
the map restriction

setRestriction

public void setRestriction(String res)
Sets the human readable rule for use of mapping (MAPRES).

Parameters:
res - String

getRes

public String getRes()
Returns the human readable rule for use of mapping (MAPRES). This is shorthand for getRestriction().

Returns:
the human readable rule for use of mapping

setRes

public void setRes(String res)
Sets the human readable rule for use of mapping (MAPRES). This is shorthand for setRestriction(String).

Parameters:
res - the human readable rule for use of mapping

getType

public String getType()
Returns the type of mapping (MAPTYPE).

Returns:
the type of mapping

setType

public void setType(String type)
Sets the type of mapping (MAPTYPE).

Parameters:
type - String

getFrom

public MapObject getFrom()
Returns the mapped from MapObject.

Returns:
the mapped from MapObject

setFrom

public void setFrom(MapObject from)
Sets the mapped from MapObject.

Parameters:
from - the mapped from MapObject

getTo

public MapObject getTo()
Returns the mapped to MapObject.

Returns:
the mapped to MapObject

setTo

public void setTo(MapObject to)
Sets the mapped to MapObject.

Parameters:
to - the mapped to MapObject

getAttributeName

public AttributeName getAttributeName()
Returns the AttributeName (MAPATN).

Returns:
the AttributeName

setAttributeName

public void setAttributeName(AttributeName atn)
Sets the AttributeName (MAPATN).

Parameters:
atn - the AttributeName

getAttributeValue

public String getAttributeValue()
Returns the attribute value (MAPATV).

Returns:
the attribute value

setAttributeValue

public void setAttributeValue(String atv)
Sets the attribute value (MAPATV).

Parameters:
atv - the attribute value

getKeyFields

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

Returns:
a String composed from key Mapping fields


Copyright ©2005