org.LexGrid.LexBIG.DataModel.NCIHistory
Class NCIChangeEvent

java.lang.Object
  extended by org.LexGrid.LexBIG.DataModel.NCIHistory.NCIChangeEvent
All Implemented Interfaces:
java.io.Serializable

public class NCIChangeEvent
extends java.lang.Object
implements java.io.Serializable

A change event as documented in ftp://ftp1.nci.nih.gov/pub/cacore/EVS/ReadMe_history.txt. Note that date and time of the change event is recorded in the containing version. All change events for the same/date and time a recorded in the same verison.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
NCIChangeEvent()
           
 
Method Summary
 java.lang.String getConceptcode()
          Returns the value of field 'conceptcode'.
 java.lang.String getConceptName()
          Returns the value of field 'conceptName'.
 ChangeType getEditaction()
          Returns the value of field 'editaction'.
 java.util.Date getEditDate()
          Returns the value of field 'editDate'.
 java.lang.String getReferencecode()
          Returns the value of field 'referencecode'.
 java.lang.String getReferencename()
          Returns the value of field 'referencename'.
 void setConceptcode(java.lang.String conceptcode)
          Sets the value of field 'conceptcode'.
 void setConceptName(java.lang.String conceptName)
          Sets the value of field 'conceptName'.
 void setEditaction(ChangeType editaction)
          Sets the value of field 'editaction'.
 void setEditDate(java.util.Date editDate)
          Sets the value of field 'editDate'.
 void setReferencecode(java.lang.String referencecode)
          Sets the value of field 'referencecode'.
 void setReferencename(java.lang.String referencename)
          Sets the value of field 'referencename'.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NCIChangeEvent

public NCIChangeEvent()
Method Detail

getConceptName

public java.lang.String getConceptName()
Returns the value of field 'conceptName'. The field 'conceptName' has the following description: The current text name of the concept. Typed as conceptCode because it serves that function.

Returns:
the value of field 'ConceptName'.

getConceptcode

public java.lang.String getConceptcode()
Returns the value of field 'conceptcode'. The field 'conceptcode' has the following description: The unique, permanent, alphanumeric identifier of the concept

Returns:
the value of field 'Conceptcode'.

getEditDate

public java.util.Date getEditDate()
Returns the value of field 'editDate'. The field 'editDate' has the following description: The editDate of the change event.

Returns:
the value of field 'EditDate'.

getEditaction

public ChangeType getEditaction()
Returns the value of field 'editaction'. The field 'editaction' has the following description: The activity being recorded (create, modify, split, merge, retire)

Returns:
the value of field 'Editaction'.

getReferencecode

public java.lang.String getReferencecode()
Returns the value of field 'referencecode'. The field 'referencecode' has the following description: The identifier for a concept affected by or influencing the action, as detailed below

Returns:
the value of field 'Referencecode'.

getReferencename

public java.lang.String getReferencename()
Returns the value of field 'referencename'. The field 'referencename' has the following description: The current text name of the reference concept in all cases except concept name changes. For these, the referencename is the old name of the current concept. Reference codes are recorded in the following circumstances: Merges - In a merge, two concepts are merged into one. One of the two concepts survives and the other concept is retired. A merge history record is written for both of the concepts with a reference code of the surviving concept and a retire record is written for the concept that retires. In the case of A merging with B and A surviving, the history will appear as follows: C11111|A|merge|dd-mon-yy|C11111|A C22222|B|merge|dd-mon-yy|C11111|A C22222|B|retire|dd-mon-yy|(null)|(null) Splits - In a split, a single concept is split into two. The original concept survives and a new concept is generated. Two split records are written for the original concept with reference codes for the resulting concepts and a create history record is written for the new concept. In the case of A being split into A and B the history will appear as follows: C22222|B|create|dd-mon-yy|(null)|(null) C11111|A|split|dd-mon-yy|C22222|B C11111|A|split|dd-mon-yy|C11111|A Retires - In a retirement the concept is moved from it's old location in the tree hierarchy into the Retired_Kind. A retire record is written for the retiring concept with a reference code of the old superconcept. If a concept has multiple superconcepts, then a retire record is written for each reference. In the case of retiring concept A which has two superconcepts (B and C), the history will appear as follows: C11111|A|retire|dd-mon-yy|C22222|B C11111|A|retire|dd-mon-yy|C33333|C Concept Name Changes - When a history record is written, the current name of the concept is recorded in the history. We can match the conceptcode from the current Thesaurus against the conceptcodes in the history to determine if any conceptnames have changed. In the case of concept A having it's name changed to B, the history will appear as follows: C11111|B|modify|dd-mon-yy|(null)|A

Returns:
the value of field 'Referencename'.

setConceptName

public void setConceptName(java.lang.String conceptName)
Sets the value of field 'conceptName'. The field 'conceptName' has the following description: The current text name of the concept. Typed as conceptCode because it serves that function.

Parameters:
conceptName - the value of field 'conceptName'.

setConceptcode

public void setConceptcode(java.lang.String conceptcode)
Sets the value of field 'conceptcode'. The field 'conceptcode' has the following description: The unique, permanent, alphanumeric identifier of the concept

Parameters:
conceptcode - the value of field 'conceptcode'.

setEditDate

public void setEditDate(java.util.Date editDate)
Sets the value of field 'editDate'. The field 'editDate' has the following description: The editDate of the change event.

Parameters:
editDate - the value of field 'editDate'.

setEditaction

public void setEditaction(ChangeType editaction)
Sets the value of field 'editaction'. The field 'editaction' has the following description: The activity being recorded (create, modify, split, merge, retire)

Parameters:
editaction - the value of field 'editaction'.

setReferencecode

public void setReferencecode(java.lang.String referencecode)
Sets the value of field 'referencecode'. The field 'referencecode' has the following description: The identifier for a concept affected by or influencing the action, as detailed below

Parameters:
referencecode - the value of field 'referencecode'.

setReferencename

public void setReferencename(java.lang.String referencename)
Sets the value of field 'referencename'. The field 'referencename' has the following description: The current text name of the reference concept in all cases except concept name changes. For these, the referencename is the old name of the current concept. Reference codes are recorded in the following circumstances: Merges - In a merge, two concepts are merged into one. One of the two concepts survives and the other concept is retired. A merge history record is written for both of the concepts with a reference code of the surviving concept and a retire record is written for the concept that retires. In the case of A merging with B and A surviving, the history will appear as follows: C11111|A|merge|dd-mon-yy|C11111|A C22222|B|merge|dd-mon-yy|C11111|A C22222|B|retire|dd-mon-yy|(null)|(null) Splits - In a split, a single concept is split into two. The original concept survives and a new concept is generated. Two split records are written for the original concept with reference codes for the resulting concepts and a create history record is written for the new concept. In the case of A being split into A and B the history will appear as follows: C22222|B|create|dd-mon-yy|(null)|(null) C11111|A|split|dd-mon-yy|C22222|B C11111|A|split|dd-mon-yy|C11111|A Retires - In a retirement the concept is moved from it's old location in the tree hierarchy into the Retired_Kind. A retire record is written for the retiring concept with a reference code of the old superconcept. If a concept has multiple superconcepts, then a retire record is written for each reference. In the case of retiring concept A which has two superconcepts (B and C), the history will appear as follows: C11111|A|retire|dd-mon-yy|C22222|B C11111|A|retire|dd-mon-yy|C33333|C Concept Name Changes - When a history record is written, the current name of the concept is recorded in the history. We can match the conceptcode from the current Thesaurus against the conceptcodes in the history to determine if any conceptnames have changed. In the case of concept A having it's name changed to B, the history will appear as follows: C11111|B|modify|dd-mon-yy|(null)|A

Parameters:
referencename - the value of field 'referencename'.

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.