org.lexgrid.valuesets
Interface LexEVSPickListDefinitionServices

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
LexEVSPickListDefinitionServicesImpl

public interface LexEVSPickListDefinitionServices
extends java.io.Serializable

PickList Services Interface.

Author:
Sridhar Dwarkanath

Method Summary
 void exportPickListDefinition(java.lang.String pickListId, java.lang.String xmlFolderLocation, boolean overwrite, boolean failOnAllErrors)
          Exports the pick list definition in LexGrid XML format.
 LogEntry[] getLogEntries()
           
 PickListDefinition getPickListDefinitionById(java.lang.String pickListId)
          Returns pickList definition for supplied pickListId.
 java.util.List<java.lang.String> getPickListDefinitionIdForValueSetDefinitionUri(java.net.URI valueSetDefURI)
          Returns all the pickList definition id's that represents supplied value set definition URI.
 java.util.List<java.lang.String> getPickListIdsForSupportedTagAndValue(java.lang.String supportedTag, java.lang.String value)
          Returns all the pickListIds that contain supplied supported tag and value.
 java.net.URI getPickListValueSetDefinition(java.lang.String pickListId)
          Returns an URI of the represented value set definition of the pickList.
 java.util.Map<java.lang.String,java.lang.String> getReferencedPLDefinitions(java.lang.String valueSet, java.lang.Boolean extractPickListName)
          Return the map set of pick list id and pick list name that references value set definition URI
 java.util.Map<java.lang.String,java.lang.String> getReferencedPLDefinitions(java.lang.String entityCode, java.lang.String entityCodeNameSpace, java.lang.String propertyId, java.lang.Boolean extractPickListName)
          Return the map set of pick list id and pick list name that references given entityCode, namespace and optionally propertyId
 java.util.List<java.lang.String> listPickListIds()
          Returns list of pickListIds that are available in the system.
 void loadPickList(PickListDefinition pldef, java.lang.String systemReleaseURI, Mappings mappings)
          Loads supplied PickListDefinition object
 void loadPickList(java.lang.String xmlFileLocation, boolean failOnAllErrors)
          Loads pick list by reading XML file location supplied
 void removePickList(java.lang.String pickListId)
          Removes pick list definition from the system that matches supplied pickListId.
 ResolvedPickListEntryList resolvePickList(PickListDefinition pickList, boolean sortByText, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag)
          Resolves pick list definition object supplied against supplied coding scheme version list.
 ResolvedPickListEntryList resolvePickList(java.lang.String pickListId, boolean sortByText, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag)
          Resolves pickList definition for supplied pickListId.
 ResolvedPickListEntryList resolvePickList(java.lang.String pickListId, java.lang.Integer sortType, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag)
          Resolves pickList definition for supplied pickListId.
 PickListDefinition resolvePickListByRevision(java.lang.String pickListId, java.lang.String revisionId, java.lang.Integer sortOrder)
           
 ResolvedPickListEntryList resolvePickListForTerm(java.lang.String pickListId, java.lang.String term, java.lang.String matchAlgorithm, java.lang.String language, java.lang.String[] context, boolean sortByText, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag)
          Resolves pickList definition for supplied arguments.
 void validate(java.net.URI uri, int valicationLevel)
           
 

Method Detail

getPickListDefinitionById

PickListDefinition getPickListDefinitionById(java.lang.String pickListId)
                                             throws LBException
Returns pickList definition for supplied pickListId.

Parameters:
pickListId - pickListId of a pickListDefinition
Returns:
PickListDefinition object.
Throws:
LBException

getPickListDefinitionIdForValueSetDefinitionUri

java.util.List<java.lang.String> getPickListDefinitionIdForValueSetDefinitionUri(java.net.URI valueSetDefURI)
                                                                                 throws LBException
Returns all the pickList definition id's that represents supplied value set definition URI.

Parameters:
valueSetDefURI - URI of an value set definition
Returns:
List of Pick List Definition Id's that represents supplied valueSetDefURI.
Throws:
LBException

getPickListValueSetDefinition

java.net.URI getPickListValueSetDefinition(java.lang.String pickListId)
                                           throws LBException
Returns an URI of the represented value set definition of the pickList.

Parameters:
pickListId -
Returns:
valueSetDefURI
Throws:
LBException

listPickListIds

java.util.List<java.lang.String> listPickListIds()
                                                 throws LBException
Returns list of pickListIds that are available in the system.

Returns:
list of available pickListIds
Throws:
LBException

loadPickList

void loadPickList(PickListDefinition pldef,
                  java.lang.String systemReleaseURI,
                  Mappings mappings)
                  throws LBException
Loads supplied PickListDefinition object

Parameters:
pldef - pick list to load
systemReleaseURI -
mappings -
Throws:
LBException

loadPickList

void loadPickList(java.lang.String xmlFileLocation,
                  boolean failOnAllErrors)
                  throws LBException
Loads pick list by reading XML file location supplied

Parameters:
xmlFileLocation - XML file containing pick list definitions
failOnAllErrors -
Throws:
LBException

removePickList

void removePickList(java.lang.String pickListId)
                    throws LBException
Removes pick list definition from the system that matches supplied pickListId.

Parameters:
pickListId - id of pickList to remove
Throws:
LBException

resolvePickList

ResolvedPickListEntryList resolvePickList(java.lang.String pickListId,
                                          boolean sortByText,
                                          AbsoluteCodingSchemeVersionReferenceList csVersionList,
                                          java.lang.String versionTag)
                                          throws LBException
Resolves pickList definition for supplied pickListId.

Parameters:
pickListId - pickListId of a pickListDefinition.
sortByText - If True; the resolved pickListEntries will be sorted by text in ascending order.
csVersionList - - a list of coding scheme URI's and versions to be used. These will be used only if they are present in the service. If absent, the most recent version will be used instead.
versionTag - - the tag (e.g "devel", "production", ...) to be used to reconcile coding schemes when more than one is present. Note that non-tagged versions will be used if the tagged version is missing.
Returns:
Resolved PickListEntries.
Throws:
LBException

resolvePickList

ResolvedPickListEntryList resolvePickList(java.lang.String pickListId,
                                          java.lang.Integer sortType,
                                          AbsoluteCodingSchemeVersionReferenceList csVersionList,
                                          java.lang.String versionTag)
                                          throws LBException
Resolves pickList definition for supplied pickListId.

Parameters:
pickListId - pickListId of a pickListDefinition.
sortByText - If 1-Ascending, 2-Descending, and 3-Custom;
csVersionList - - a list of coding scheme URI's and versions to be used. These will be used only if they are present in the service. If absent, the most recent version will be used instead.
versionTag - - the tag (e.g "devel", "production", ...) to be used to reconcile coding schemes when more than one is present. Note that non-tagged versions will be used if the tagged version is missing.
Returns:
Resolved PickListEntries.
Throws:
LBException

resolvePickList

ResolvedPickListEntryList resolvePickList(PickListDefinition pickList,
                                          boolean sortByText,
                                          AbsoluteCodingSchemeVersionReferenceList csVersionList,
                                          java.lang.String versionTag)
                                          throws LBException
Resolves pick list definition object supplied against supplied coding scheme version list.

Parameters:
pickList - pickListDefinition object.
sortByText - If True; the resolved pickListEntries will be sorted by text in ascending order.
csVersionList - - a list of coding scheme URI's and versions to be used. These will be used only if they are present in the service. If absent, the most recent version will be used instead.
versionTag - - the tag (e.g "devel", "production", ...) to be used to reconcile coding schemes when more than one is present. Note that non-tagged versions will be used if the tagged version is missing.
Returns:
Resolved PickListEntries.
Throws:
LBException

resolvePickListForTerm

ResolvedPickListEntryList resolvePickListForTerm(java.lang.String pickListId,
                                                 java.lang.String term,
                                                 java.lang.String matchAlgorithm,
                                                 java.lang.String language,
                                                 java.lang.String[] context,
                                                 boolean sortByText,
                                                 AbsoluteCodingSchemeVersionReferenceList csVersionList,
                                                 java.lang.String versionTag)
                                                 throws LBException
Resolves pickList definition for supplied arguments.

Parameters:
pickListId - pickListId of a pickListDefinition. This is required argument.
term - Term to restrict. This is required argument.
matchAlgorithm - Optional, match algorithm to use.
language - Optional, language to restrict.
context - Optional, list of context to restrict.
sortByText - If True; the resolved pickListEntries will be sorted by text in ascending order.
csVersionList - - a list of coding scheme URI's and versions to be used. These will be used only if they are present in the service. If absent, the most recent version will be used instead.
versionTag - - the tag (e.g "devel", "production", ...) to be used to reconcile coding schemes when more than one is present. Note that non-tagged versions will be used if the tagged version is missing.
Returns:
Resolved PickListEntries.
Throws:
LBException

validate

void validate(java.net.URI uri,
              int valicationLevel)
              throws LBException
Parameters:
uri - XML file containing pickList definitions
valicationLevel - validate <int> Perform validation of the candidate resource without loading data. Supported levels of validation include: 0 = Verify document is well-formed 1 = Verify document is valid
Throws:
LBException

getReferencedPLDefinitions

java.util.Map<java.lang.String,java.lang.String> getReferencedPLDefinitions(java.lang.String entityCode,
                                                                            java.lang.String entityCodeNameSpace,
                                                                            java.lang.String propertyId,
                                                                            java.lang.Boolean extractPickListName)
                                                                            throws LBException
Return the map set of pick list id and pick list name that references given entityCode, namespace and optionally propertyId

Parameters:
entityCode - referenced entityCode
entityCodeNameSpace - referenced entityCodeNamespace
propertyId - Optional propertyId
extractPickListName - true means pick list name will be extracted in the map set.
Returns:
Mapset of pick list id and pick list name
Throws:
LBException

getReferencedPLDefinitions

java.util.Map<java.lang.String,java.lang.String> getReferencedPLDefinitions(java.lang.String valueSet,
                                                                            java.lang.Boolean extractPickListName)
                                                                            throws LBException
Return the map set of pick list id and pick list name that references value set definition URI

Parameters:
valueSet - URI of value set definition
extractPickListName - true means pick list name will be extracted in the map set
Returns:
Mapset of pick list id and pick list name
Throws:
LBException

getPickListIdsForSupportedTagAndValue

java.util.List<java.lang.String> getPickListIdsForSupportedTagAndValue(java.lang.String supportedTag,
                                                                       java.lang.String value)
Returns all the pickListIds that contain supplied supported tag and value.

Parameters:
supportedTag - like SupportedCodingScheme, SupportedAssociation etc.
value - value to look for
Returns:
list of pickListIds that contains supportedTag with value.

exportPickListDefinition

void exportPickListDefinition(java.lang.String pickListId,
                              java.lang.String xmlFolderLocation,
                              boolean overwrite,
                              boolean failOnAllErrors)
                              throws LBException
Exports the pick list definition in LexGrid XML format.

Parameters:
pickListId - id of pick list definition to export
xmlFolderLocation - destination location
overwrite -
failOnAllErrors -
Throws:
LBException

getLogEntries

LogEntry[] getLogEntries()

resolvePickListByRevision

PickListDefinition resolvePickListByRevision(java.lang.String pickListId,
                                             java.lang.String revisionId,
                                             java.lang.Integer sortOrder)
                                             throws LBRevisionException
Throws:
LBRevisionException

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.