org.xspan.interfaces.sael.core.Provenance Class Reference


Public Member Functions

 Provenance ()
void setCreator (String creatorId)
String getCreator ()
void setDate (String creationDate)
String getDate ()
void setDefinition (String freeText)
String getDefinition ()

Detailed Description

Class records provenance information for a single mapping between a SAEL id and another anatomical structure

Author:
kcm, xspan

Constructor & Destructor Documentation

org.xspan.interfaces.sael.core.Provenance.Provenance (   ) 
 

Member Function Documentation

String org.xspan.interfaces.sael.core.Provenance.getCreator (   ) 
 

method to return the creator of a mapping

Returns:
the id of the creator, a string, generally the person's name

String org.xspan.interfaces.sael.core.Provenance.getDate (   ) 
 

method to return the mapping's creation date

Returns:
a date in some string format

String org.xspan.interfaces.sael.core.Provenance.getDefinition (   ) 
 

method to return the associated free text, if it exists

Returns:
free text in String format

void org.xspan.interfaces.sael.core.Provenance.setCreator (  String  creatorId  ) 
 

method to set the creator of a mapping

Parameters:
creatorId some means of identifying the mapping's author

void org.xspan.interfaces.sael.core.Provenance.setDate (  String  creationDate  ) 
 

method to set when the mapping was created

Parameters:
creationDate the day the mapping was authored as a string, no agreed format yet?

void org.xspan.interfaces.sael.core.Provenance.setDefinition (  String  freeText  ) 
 

method to store any free-text the author wishes to associate with the mapping, e.g. an explanation?

Parameters:
freeText any string that the author wishes