gov.nih.nlm.umls.meta
Interface ComponentHistory

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

public interface ComponentHistory
extends Comparable, ConceptElement, ContentViewElement, SourceElement

Represents source-asserted history information.

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

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
 String getChangeKey()
          Returns the change key which identifies what changed (CHANGEKEY).
 String getChangeType()
          Returns the change type which identifies what changed (CHANGETYPE).
 String getChangeValue()
          Returns the new value for what changed (CHANGEVALUE).
 String getIdentifier()
          Returns the unique identifier (UI).
 String getKeyFields()
          Returns a String key which can be used by equals, compareTo, and hashCode methods.
 String getReason()
          Returns the reason for the change (REASON).
 String getSver()
          Returns the release date or version number of a source (SVER).
 String getUi()
          Returns the unique identifier (UI).
 String getVersion()
          Returns the release date or version number of a source (SVER).
 void setChangeKey(String changekey)
          Sets the change key to identify what changed (CHANGEKEY).
 void setChangeType(String changetype)
          Sets the change type to identify what changed (CHANGETYPE).
 void setChangeValue(String changeval)
          Sets the new value for what changed (CHANGEVALUE).
 void setIdentifier(String ui)
          Sets the unique identifier (UI).
 void setReason(String reason)
          Sets the reason for the change (REASON).
 void setSver(String sver)
          Sets the release date or version number of a source (SVER).
 void setUi(String ui)
          Sets the unique identifier (UI).
 void setVersion(String sver)
          Sets the release date or version number of a source (SVER).
 
Methods inherited from interface java.lang.Comparable
compareTo
 
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
 

Method Detail

getVersion

public String getVersion()
Returns the release date or version number of a source (SVER).

Returns:
the release date or version number of a source

getSver

public String getSver()
Returns the release date or version number of a source (SVER). This is shorthand for getVersion().

Returns:
the release date or version number of a source

setVersion

public void setVersion(String sver)
Sets the release date or version number of a source (SVER).

Parameters:
sver - the release date or version number of a source

setSver

public void setSver(String sver)
Sets the release date or version number of a source (SVER). This is shorthand for setVersion(String).

Parameters:
sver - the release date or version number of a source

getChangeKey

public String getChangeKey()
Returns the change key which identifies what changed (CHANGEKEY).

Returns:
the change key

setChangeKey

public void setChangeKey(String changekey)
Sets the change key to identify what changed (CHANGEKEY).

Parameters:
changekey - the change key

getChangeValue

public String getChangeValue()
Returns the new value for what changed (CHANGEVALUE).

Returns:
the change value

setChangeValue

public void setChangeValue(String changeval)
Sets the new value for what changed (CHANGEVALUE).

Parameters:
changeval - the change value

getChangeType

public String getChangeType()
Returns the change type which identifies what changed (CHANGETYPE).

Returns:
the change type

setChangeType

public void setChangeType(String changetype)
Sets the change type to identify what changed (CHANGETYPE).

Parameters:
changetype - the change type

getReason

public String getReason()
Returns the reason for the change (REASON).

Returns:
the reason

setReason

public void setReason(String reason)
Sets the reason for the change (REASON).

Parameters:
reason - reason for the changed

getUi

public String getUi()
Returns the unique identifier (UI). This is shorthand for getIdentifier().

Returns:
the unique identifier

getIdentifier

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

Returns:
the unique identifier

setIdentifier

public void setIdentifier(String ui)
Sets the unique identifier (UI).

Parameters:
ui - the new value

setUi

public void setUi(String ui)
Sets the unique identifier (UI). This is shorthand for setIdentifier(String).

Parameters:
ui - the unique identifier

getKeyFields

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

Returns:
a String composed from key Atom fields


Copyright ©2005