org.LexGrid.LexBIG.Impl.History
Class NCIThesaurusHistoryServiceImpl

java.lang.Object
  extended by org.LexGrid.LexBIG.Impl.History.NCIThesaurusHistoryServiceImpl
All Implemented Interfaces:
java.io.Serializable, HistoryService

public class NCIThesaurusHistoryServiceImpl
extends java.lang.Object
implements HistoryService

The implementation of the history service against the custom NCI Thesaurus history file / table.

Version:
subversion $Revision: $ checked in on $Date: $
Author:
Dan Armbrust
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface org.LexGrid.LexBIG.History.HistoryService
metaURN
 
Constructor Summary
NCIThesaurusHistoryServiceImpl()
          This constructor is only here for Apache Axis to work correctly.
NCIThesaurusHistoryServiceImpl(java.lang.String urn)
           
 
Method Summary
 NCIChangeEventList getAncestors(ConceptReference conceptReference)
          Return the list of change events identifying the immediate ancestors of the given concept reference.
 SystemReleaseList getBaselines(java.util.Date releasedAfter, java.util.Date releasedBefore)
          Return a list of baselines supported by this service that were released on or after the first supplied date and were released on or before the second date.
 CodingSchemeVersionList getConceptChangeVersions(ConceptReference conceptReference, java.util.Date beginDate, java.util.Date endDate)
          Return a list of all of the coding scheme versions in which the supplied concept changed between the two supplied times (inclusive).
 CodingSchemeVersion getConceptCreationVersion(ConceptReference conceptReference)
          Return the coding scheme version in which the supplied concept was created.
 NCIChangeEventList getDescendants(ConceptReference conceptReference)
          Return the list of change events identifying the immediate descendants of the given concept reference.
 SystemRelease getEarliestBaseline()
          Return the earliest baseline version in the list.
 NCIChangeEventList getEditActionList(ConceptReference conceptReference, CodingSchemeVersion codingSchemeVersion)
          Return the list of available NCI-defined change events for the given concept and coding scheme version.
 NCIChangeEventList getEditActionList(ConceptReference conceptReference, java.util.Date beginDate, java.util.Date endDate)
          Return the list of available NCI-defined change events for the given concept and date range.
 NCIChangeEventList getEditActionList(ConceptReference conceptReference, java.net.URI releaseURN)
          Return the list of NCI-defined change events for the given concept and release; empty if not applicable.
 SystemRelease getLatestBaseline()
          Get the latest baseline in the list.
 SystemReleaseDetail getSystemRelease(java.net.URI releaseURN)
          Return detailed information about the particular system release.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NCIThesaurusHistoryServiceImpl

public NCIThesaurusHistoryServiceImpl()
This constructor is only here for Apache Axis to work correctly. It should not be used by anyone.


NCIThesaurusHistoryServiceImpl

public NCIThesaurusHistoryServiceImpl(java.lang.String urn)
                               throws LBParameterException
Throws:
LBParameterException
Method Detail

getBaselines

public SystemReleaseList getBaselines(java.util.Date releasedAfter,
                                      java.util.Date releasedBefore)
                               throws LBParameterException,
                                      LBInvocationException
Description copied from interface: HistoryService
Return a list of baselines supported by this service that were released on or after the first supplied date and were released on or before the second date. Returned baselines are arranged in sequential order, from earliest to latest.

Specified by:
getBaselines in interface HistoryService
Parameters:
releasedAfter - If present, only return baselines released on or after the supplied date.
releasedBefore - If present, only return baselines that were released before the specified date
Throws:
LBParameterException
LBInvocationException

getConceptCreationVersion

public CodingSchemeVersion getConceptCreationVersion(ConceptReference conceptReference)
                                              throws LBParameterException,
                                                     LBInvocationException
Description copied from interface: HistoryService
Return the coding scheme version in which the supplied concept was created.

Specified by:
getConceptCreationVersion in interface HistoryService
Parameters:
conceptReference - ConceptReference
Throws:
LBParameterException
LBInvocationException

getSystemRelease

public SystemReleaseDetail getSystemRelease(java.net.URI releaseURN)
                                     throws LBParameterException,
                                            LBInvocationException
Description copied from interface: HistoryService
Return detailed information about the particular system release.

Specified by:
getSystemRelease in interface HistoryService
Parameters:
releaseURN - The URN of the system release to retrieve.
Throws:
LBParameterException
LBInvocationException

getConceptChangeVersions

public CodingSchemeVersionList getConceptChangeVersions(ConceptReference conceptReference,
                                                        java.util.Date beginDate,
                                                        java.util.Date endDate)
                                                 throws LBParameterException,
                                                        LBInvocationException
Description copied from interface: HistoryService
Return a list of all of the coding scheme versions in which the supplied concept changed between the two supplied times (inclusive).

Specified by:
getConceptChangeVersions in interface HistoryService
Parameters:
conceptReference - The concept to pull the versions out of
beginDate - Begin date (inclusive) to check for version changes. If omitted, go to earliest recorded date
endDate - Last date to check for changes in (inclusive). If omitted include all dates past and including beginDate
Throws:
LBParameterException
LBInvocationException

getEarliestBaseline

public SystemRelease getEarliestBaseline()
                                  throws LBInvocationException
Description copied from interface: HistoryService
Return the earliest baseline version in the list.

Specified by:
getEarliestBaseline in interface HistoryService
Throws:
LBInvocationException

getEditActionList

public NCIChangeEventList getEditActionList(ConceptReference conceptReference,
                                            CodingSchemeVersion codingSchemeVersion)
                                     throws LBParameterException,
                                            LBInvocationException
Description copied from interface: HistoryService
Return the list of available NCI-defined change events for the given concept and coding scheme version.

Specified by:
getEditActionList in interface HistoryService
Parameters:
conceptReference - Optional concept to get the action list for. If omitted, all events for the given change set (represented by a coding scheme version) are returned.
codingSchemeVersion - Version to get the action list for
Throws:
LBParameterException
LBInvocationException

getLatestBaseline

public SystemRelease getLatestBaseline()
                                throws LBInvocationException
Description copied from interface: HistoryService
Get the latest baseline in the list.

Specified by:
getLatestBaseline in interface HistoryService
Throws:
LBInvocationException

getEditActionList

public NCIChangeEventList getEditActionList(ConceptReference conceptReference,
                                            java.util.Date beginDate,
                                            java.util.Date endDate)
                                     throws LBParameterException,
                                            LBInvocationException
Description copied from interface: HistoryService
Return the list of available NCI-defined change events for the given concept and date range.

Specified by:
getEditActionList in interface HistoryService
Parameters:
conceptReference - Optional concept to get the action list for. If omitted, all events for the given date range are returned.
beginDate - Begin date (inclusive) to check for version changes. If omitted, go to earliest recorded date.
endDate - Last date to check for changes in (inclusive). If omitted include all dates past and including beginDate.
Throws:
LBParameterException
LBInvocationException

getEditActionList

public NCIChangeEventList getEditActionList(ConceptReference conceptReference,
                                            java.net.URI releaseURN)
                                     throws LBParameterException,
                                            LBInvocationException
Description copied from interface: HistoryService
Return the list of NCI-defined change events for the given concept and release; empty if not applicable.

Specified by:
getEditActionList in interface HistoryService
Parameters:
conceptReference - Optional concept to get the action list for. If omitted the actions for all registered concepts for the specified system release are returned.
releaseURN - URN of the system release to retrieve the action list for.
Throws:
LBParameterException
LBInvocationException

getDescendants

public NCIChangeEventList getDescendants(ConceptReference conceptReference)
                                  throws LBParameterException,
                                         LBInvocationException
Description copied from interface: HistoryService
Return the list of change events identifying the immediate descendants of the given concept reference.

Specified by:
getDescendants in interface HistoryService
Parameters:
conceptReference - ConceptReference
Returns:
NCIChangeEventList
Throws:
LBParameterException
LBInvocationException

getAncestors

public NCIChangeEventList getAncestors(ConceptReference conceptReference)
                                throws LBParameterException,
                                       LBInvocationException
Description copied from interface: HistoryService
Return the list of change events identifying the immediate ancestors of the given concept reference.

Specified by:
getAncestors in interface HistoryService
Parameters:
conceptReference - ConceptReference
Returns:
NCIChangeEventList
Throws:
LBParameterException
LBInvocationException

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.