|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LexEVSValueSetDefinitionServices
Value Set Definition Services.
Method Summary | |
---|---|
void |
exportValueSetDefinition(java.net.URI valueSetDefinitionURI,
java.lang.String valueSetDefinitionRevisionId,
java.lang.String xmlFullPathName,
boolean overwrite,
boolean failOnAllErrors)
Export value set definition to LexGrid canonical XML format. |
java.net.URI |
exportValueSetResolution(java.net.URI valueSetDefinitionURI,
java.lang.String valueSetDefinitionRevisionId,
java.net.URI exportDestination,
AbsoluteCodingSchemeVersionReferenceList csVersionList,
java.lang.String csVersionTag,
boolean overwrite,
boolean failOnAllErrors)
Exports contents of Value Set Definition as Coding Scheme in LexGrid canonical XML format. |
java.util.List<java.lang.String> |
getAllValueSetDefinitionsWithNoName()
Return the URI's of all unnamed value set definition(s). |
ResolvedValueSetCodedNodeSet |
getCodedNodeSetForValueSetDefinition(java.net.URI valueSetDefinitionURI,
java.lang.String valueSetDefinitionRevisionId,
AbsoluteCodingSchemeVersionReferenceList csVersionList,
java.lang.String csVersionTag)
Returns unresolved CodedNodeSet populated using definition entries in the value set definition. |
AbsoluteCodingSchemeVersionReferenceList |
getCodingSchemesInValueSetDefinition(java.net.URI valueSetDefinitionURI)
Returns list of coding scheme summary that is referenced by the supplied value set definition. |
LogEntry[] |
getLogEntries()
|
ValueSetDefinition |
getValueSetDefinition(java.net.URI valueSetDefinitionURI,
java.lang.String valueSetDefinitionRevisionId)
Returns value set definition for supplied value set definition URI. |
ResolvedValueSetCodedNodeSet |
getValueSetDefinitionEntitiesForTerm(java.lang.String term,
java.lang.String matchAlgorithm,
java.net.URI valueSetDefinitionURI,
AbsoluteCodingSchemeVersionReferenceList csVersionList,
java.lang.String versionTag)
Resolve the value set definition, restricting the matching values to entities the match the supplied term and match algorithm. |
java.util.List<java.lang.String> |
getValueSetDefinitionURIsForSupportedTagAndValue(java.lang.String supportedTag,
java.lang.String value,
java.lang.String uri)
Returns list of Value Set Definition URIs that contain supplied SupportedAttribute Tag and Value. |
java.util.List<java.lang.String> |
getValueSetDefinitionURIsWithCodingScheme(java.lang.String codingSchemename,
java.lang.String codingSchemeURI)
Returns list of Value Set Definition URIs that references supplied coding scheme. |
java.util.List<java.lang.String> |
getValueSetDefinitionURIsWithConceptDomain(java.lang.String conceptDomain,
java.lang.String codingSchemeURI)
Returns list of Value Set Definition URIs that are bound to supplied concept domain. |
java.util.List<java.lang.String> |
getValueSetDefinitionURIsWithConceptDomainAndUsageContext(java.lang.String conceptDomain,
java.util.List<java.lang.String> usageContexts,
java.lang.String codingSchemeURI)
Returns list of Value Set Definition URIs that are bound to supplied concept domain and in supplied usage context. |
java.util.List<java.lang.String> |
getValueSetDefinitionURIsWithUsageContext(java.util.List<java.lang.String> usageContexts,
java.lang.String codingSchemeURI)
Returns list of Value Set Definition URIs that can be used with in the supplied list of usage context. |
AbsoluteCodingSchemeVersionReference |
isEntityInValueSet(java.lang.String entityCode,
java.net.URI valueSetDefinitionURI,
java.lang.String valueSetDefinitionRevisionId,
java.lang.String versionTag)
Determine whether the supplied entity code is a valid entity code somewhere in the supplied value set definition. |
AbsoluteCodingSchemeVersionReference |
isEntityInValueSet(java.lang.String entityCode,
java.net.URI entityCodeNamespace,
java.net.URI valueSetDefinitionURI,
java.lang.String valueSetDefinitionRevisionId,
AbsoluteCodingSchemeVersionReferenceList csVersionList,
java.lang.String versionTag)
Determine whether the supplied entity code is valid in the suppled value set definition, when reconciled against the supplied set of coding scheme versions and/or version tags |
boolean |
isSubSet(java.net.URI childValueSetDefinitionURI,
java.net.URI parentValueSetDefinitionURI,
AbsoluteCodingSchemeVersionReferenceList csVersionList,
java.lang.String versionTag)
Check whether childValueDSetDefinitionURI is a child of parentValueSetDefinitionURI. |
boolean |
isValueSetDefinition(java.lang.String entityCode,
java.lang.String codingSchemeName,
CodingSchemeVersionOrTag csvt)
Determine if the supplied entity code is of type valueSetDefinition in supplied coding scheme and, if it is, return the true, otherwise return false. |
java.util.List<java.lang.String> |
listValueSetDefinitions(java.lang.String valueSetDefinitionName)
Return the URI's for the value set definition(s) for the supplied value set definition name. |
java.util.List<java.lang.String> |
listValueSetDefinitionURIs()
Lists all the value set definition URIs that are loaded in the system. |
java.util.List<java.lang.String> |
listValueSetsWithEntityCode(java.lang.String entityCode,
java.net.URI entityCodeNamespace,
AbsoluteCodingSchemeVersionReferenceList csVersionList,
java.lang.String versionTag)
Returns all the value set definition uris that contains supplied entity code. |
void |
loadValueSetDefinition(java.lang.String xmlFileLocation,
boolean failOnAllErrors)
Loads value set definition by reading XML file location supplied |
void |
loadValueSetDefinition(ValueSetDefinition vsdef,
java.lang.String systemReleaseURI,
Mappings mappings)
Loads supplied valueSetDefinition object |
void |
removeValueSetDefinition(java.net.URI valueSetDefinitionURI)
Removes supplied value set definition from the system. |
ResolvedValueSetDefinition |
resolveValueSetDefinition(java.net.URI valueSetDefinitionURI,
java.lang.String valueSetDefinitionRevisionId,
AbsoluteCodingSchemeVersionReferenceList csVersionList,
java.lang.String versionTag,
SortOptionList sortOptionList)
Resolve a value set definition using the supplied set of coding scheme versions. |
ResolvedValueSetDefinition |
resolveValueSetDefinition(ValueSetDefinition vsDef,
AbsoluteCodingSchemeVersionReferenceList csVersionList,
java.lang.String versionTag,
SortOptionList sortOptionList)
Resolve a value set definition provided using the supplied set of coding scheme versions. |
void |
validate(java.net.URI uri,
int validationLevel)
Perform validation of the candidate resource without loading data. |
Method Detail |
---|
void loadValueSetDefinition(ValueSetDefinition vsdef, java.lang.String systemReleaseURI, Mappings mappings) throws LBException
vsdef
- value set definition to loadsystemReleaseURI
- mappings
- - additional mappings passed from the value set definition container
LBException
void loadValueSetDefinition(java.lang.String xmlFileLocation, boolean failOnAllErrors) throws LBException
xmlFileLocation
- XML file containing value set definitionsfailOnAllErrors
-
java.lang.Exception
LBException
void validate(java.net.URI uri, int validationLevel) throws LBException
uri
- XML file containing value set definitionsvalidationLevel
- validate <int>
Supported levels of validation include:
0 = Verify document is well-formed
1 = Verify document is valid
LBParameterException
LBException
AbsoluteCodingSchemeVersionReference isEntityInValueSet(java.lang.String entityCode, java.net.URI valueSetDefinitionURI, java.lang.String valueSetDefinitionRevisionId, java.lang.String versionTag) throws LBException
entityCode
- - the entity code to search for. If the value set definition has a default coding scheme,
this will become the namespace
for the entity code. If not, any matching entity code will pass.valueSetDefinitionURI
- - the URI of the value set definition to searchvalueSetDefintionRevisionId
- - the version of the value set definitionversionTag
- - the version or tag (e.g. "devel", "production", etc.) to be used for all of the coding schemes searched.
LBException
AbsoluteCodingSchemeVersionReference isEntityInValueSet(java.lang.String entityCode, java.net.URI entityCodeNamespace, java.net.URI valueSetDefinitionURI, java.lang.String valueSetDefinitionRevisionId, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag) throws LBException
entityCode
- - the entity code to validate.entityCodeNamespace
- - the URI of the entity code namespace. If omitted, the default coding scheme namespace for the value domain
will be used, if it is present. Otherwise the first matching entity code, if any, will passvalueSetDefinitionURI
- - the URI of the value set definitionnvalueSetDefintionRevisionId
- - the version of the value set definitioncsVersionList
- - 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.
LBException
java.util.List<java.lang.String> listValueSetsWithEntityCode(java.lang.String entityCode, java.net.URI entityCodeNamespace, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag) throws LBException
entityCode
- - the entity code to validate.entityCodeNamespace
- - the URI of the entity code namespace. If omitted, the default coding scheme namespace for the value domain
will be used, if it is present. Otherwise the first matching entity code, if any, will passcsVersionList
- - 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.
LBException
ResolvedValueSetCodedNodeSet getCodedNodeSetForValueSetDefinition(java.net.URI valueSetDefinitionURI, java.lang.String valueSetDefinitionRevisionId, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String csVersionTag) throws LBException
valueSetDefinitionURI
- - the URI of the value set definitionvalueSetDefintionRevisionId
- - the version of the value set definitioncsVersionList
- - 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.csVersionTag
- - 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.
LBException
ResolvedValueSetDefinition resolveValueSetDefinition(java.net.URI valueSetDefinitionURI, java.lang.String valueSetDefinitionRevisionId, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag, SortOptionList sortOptionList) throws LBException
valueSetDefinitionURI
- value set definition URIvalueSetDefintionRevisionId
- - the version of the value set definitioncsVersionList
- list of coding scheme versions to use in resolution. IF the
value set definition uses a version that isn't mentioned in this list,
the resolve function will return the codingScheme and version
that was used as a default for the resolution.versionTag
- the tag (e.g. "devel", "production", ...) to be used to determine which coding scheme to be usedsortOptionList
- List of sort options to apply during resolution. If supplied,
the sort algorithms will be applied in the order provided. Any
algorithms not valid to be applied in context of node set
iteration, as specified in the sort extension description,
will result in a parameter exception. Available algorithms can
be retrieved through the LexBIGService getSortExtensions()
method after being defined to the LexBIGServiceManager
extension registry.
LBException
ResolvedValueSetDefinition resolveValueSetDefinition(ValueSetDefinition vsDef, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag, SortOptionList sortOptionList) throws LBException
valueSetDefinition
- value set definition objectcsVersionList
- list of coding scheme versions to use in resolution. IF the
value set definition uses a version that isn't mentioned in this list,
the resolve function will return the codingScheme and version
that was used as a default for the resolution.versionTag
- the tag (e.g. "devel", "production", ...) to be used to determine which coding scheme to be usedsortOptionList
- List of sort options to apply during resolution. If supplied,
the sort algorithms will be applied in the order provided. Any
algorithms not valid to be applied in context of node set
iteration, as specified in the sort extension description,
will result in a parameter exception. Available algorithms can
be retrieved through the LexBIGService getSortExtensions()
method after being defined to the LexBIGServiceManager
extension registry.
LBException
boolean isSubSet(java.net.URI childValueSetDefinitionURI, java.net.URI parentValueSetDefinitionURI, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag) throws LBException
childValueSetDefinitionURI
- child value set definition URIparentValueSetDefinitionURI
- parent value set definition URIcsVersionList
- list of coding scheme versions to use in resolution. IF the
value set definition uses a version that isn't mentioned in this list,
the resolve function will return the codingScheme and version
that was used as a default for the resolution.versionTag
- the tag (e.g. "devel", "production", ...) to be used to determine which coding scheme to be used
LBException
ValueSetDefinition getValueSetDefinition(java.net.URI valueSetDefinitionURI, java.lang.String valueSetDefinitionRevisionId) throws LBException
valueSetDefinitionURI
- value set definition URIvalueSetDefintionRevisionId
- the version of the value set definition
LBException
void exportValueSetDefinition(java.net.URI valueSetDefinitionURI, java.lang.String valueSetDefinitionRevisionId, java.lang.String xmlFullPathName, boolean overwrite, boolean failOnAllErrors) throws LBException
valueSetDefinitionURI
- value set definition URIvalueSetDefinitionRevisionId
- revision id of the value set definition to exportxmlFullPathName
- Location to save the definitionoverwrite
- True: to override the existing file.failOnAllErrors
- True: stops exporting if any error.
LBException
java.net.URI exportValueSetResolution(java.net.URI valueSetDefinitionURI, java.lang.String valueSetDefinitionRevisionId, java.net.URI exportDestination, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String csVersionTag, boolean overwrite, boolean failOnAllErrors) throws LBException
valueSetDefinitionURI
- value set definition URIvalueSetDefinitionRevisionId
- value set definition revision idexportDestination
- Location to save the definitioncsVersionList
- 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.csVersionTag
- the tag (e.g "devel", "production", ...) to be used to reconcile coding schemes when more than one is present.overwrite
- True: to override the existing file.failOnAllErrors
- True: stops exporting if any error.
LBException
java.util.List<java.lang.String> listValueSetDefinitions(java.lang.String valueSetDefinitionName) throws LBException
valueSetDefinitionName
-
LBException
java.util.List<java.lang.String> listValueSetDefinitionURIs()
java.util.List<java.lang.String> getAllValueSetDefinitionsWithNoName() throws LBException
LBException
ResolvedValueSetCodedNodeSet getValueSetDefinitionEntitiesForTerm(java.lang.String term, java.lang.String matchAlgorithm, java.net.URI valueSetDefinitionURI, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag) throws LBException
term
- - text to match. Format is specific to the match algorithmmatchAlgorithm
- - match algorithm to use. Must be the name of a supported match algorithmvalueSetDefinitionURI
- - value set definition to resolvecsVersionList
- - list of coding schemes and versions to resolve againstversionTag
- - version tag to use for resolving coding schemes
LBException
AbsoluteCodingSchemeVersionReferenceList getCodingSchemesInValueSetDefinition(java.net.URI valueSetDefinitionURI) throws LBException
valueSetDefinitionURI
-
LBException
boolean isValueSetDefinition(java.lang.String entityCode, java.lang.String codingSchemeName, CodingSchemeVersionOrTag csvt) throws LBException
entityCode
- codingSchemeName
- csvt
-
LBException
void removeValueSetDefinition(java.net.URI valueSetDefinitionURI) throws LBException
valueSetDefinitionURI
- URI of value set definition to remove
LBException
LogEntry[] getLogEntries()
java.util.List<java.lang.String> getValueSetDefinitionURIsForSupportedTagAndValue(java.lang.String supportedTag, java.lang.String value, java.lang.String uri)
supportedTag
- SupportedAttribute tag like SupportedCodingScheme, SupportedConceptDomain etc.value
- value of the supportedAttributeuri
-
java.util.List<java.lang.String> getValueSetDefinitionURIsWithCodingScheme(java.lang.String codingSchemename, java.lang.String codingSchemeURI)
codingSchemename
- name of the coding scheme
java.util.List<java.lang.String> getValueSetDefinitionURIsWithConceptDomain(java.lang.String conceptDomain, java.lang.String codingSchemeURI)
conceptDomain
- name/id of the conceptDomaincodingSchemeURI
- coding scheme URI to which the concept domain belongs to
java.util.List<java.lang.String> getValueSetDefinitionURIsWithUsageContext(java.util.List<java.lang.String> usageContexts, java.lang.String codingSchemeURI)
usageContexts
- list of usage contextcodingSchemeURI
- coding scheme URI to which the concept domain belongs to
java.util.List<java.lang.String> getValueSetDefinitionURIsWithConceptDomainAndUsageContext(java.lang.String conceptDomain, java.util.List<java.lang.String> usageContexts, java.lang.String codingSchemeURI)
conceptDomain
- name/id of the conceptDomainusageContexts
- list of usage context names/IDscodingSchemeURI
- coding scheme URI to which the concept domain belongs to
|
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. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |