Page History
...
Interface Link | Description |
---|---|
This interface represents the core interface to a LexEVS service and acts as an entry point to other API components and services | |
A virtual graph where the edges represent associations and the nodes represent concept codes. A CodedNodeGraph describes a graph that can be combined with other graphs, queried or resolved into an actual graph rendering. | |
A coded node set represents a flat list of coded entries. | |
The service manager provides a single write and update access point for all of a service's content. The service manager allows new coding schemes to be validated and loaded, existing coding schemes to be retired and removed and the status of various coding schemes to be updated and changed. | |
Interface to perform system-wide query over optionally loaded metadata for loaded code systems and providers. | |
Authoring service interface for creating Mappings and Coding Scheme relationships | |
The LexBIGService interface is not an entry point for Value Sets and Pick Lists. For details, see the Value Set and Pick List Services section of this guide. |
JavaDocs for the LexEVS Service Interfaces:
Code Block |
---|
http://informatics.mayo.edu-LexGrid-downloads-LexEVS_60_JavaDocs-runtime_javadoc-org-LexGrid-LexBIG-LexBIGService-package-summary.html] |
Service Extensions
Provides registration and lookup for pluggable system features.
Interface Link | Description |
---|---|
Marks a class as an extension to the LexEVS application programming interface. This allows for centralized registration, lookup, and access to defined functions. | |
Allows registration and lookup of implementers for extensible pieces of the LexEVS architecture. |
Javadocs for LexEVS Extensions:
Code Block |
---|
http://informatics.mayo.edu-LexGrid-downloads-LexEVS_60_JavaDocs-runtime_javadoc-org-LexGrid-LexBIG-Extensions-package-summary.html]{ |
Query Extensions
Query Extensions
Query extensions provide the ability to further constrain or manage query results. For details on the LexEVS 6.0 Query Extension, Query extensions provide the ability to further constrain or manage query results. For details on the LexEVS 6.0 Query Extension, see the document section Query Services Extension.
Interface Link | Description |
---|---|
Allows for additional filtering of query results. | |
Allows for unique sorting of query results. This interface provides a comparator to evaluate order of any two given items from the result set. | |
Allows for unique search of query results. |
Javadocs for LexEVS Query Extensions:
Code Block |
---|
http://informatics.mayo.edu-LexGrid-downloads-LexEVS_60_JavaDocs-runtime_javadoc-org-LexGrid-LexBIG-Extensions-Query-package-summary.html] |
Load Extensions
Load Extensions
Load extensions are responsible for the validation and import of content to the LexEVS repository. Vocabularies Load extensions are responsible for the validation and import of content to the LexEVS repository. Vocabularies may be imported from a variety of formats including LexGrid canonical XML, NCI Thesaurus (OWL), and NCI MetaThesaurus (UMLS RRF). For details on LexEVS loaders and the Loader Framework, see the Loader Guide.
...
Interface Link | Description | |||||
---|---|---|---|---|---|---|
The loader interface validates and/or loads content for a service. | ||||||
Validates and/or loads content provided in the LexGrid canonical XML format. | ||||||
Validates and/or loads the complete NCI MetaThesaurus. Content is supplied in RRF format. Note: To load individual coding schemes, consider using the UMLS_Loader as an alternative. | ||||||
Validates and/or loads content provided in Open Biomedical Ontologies (OBO) text format. | ||||||
Validates and/or loads content provided in Web Ontology Language (OWL) XML format.
| ||||||
A loader for delimited text type files. Text files come in one of two formats: indented code/designation pair or indented code/designation/description triples. | ||||||
Load one or more coding schemes from UMLS RRF format stored in a SQL database. | ||||||
Validates and/or loads content provided in metadata xml format. The only requirement of the xml file is that it be a valid xml file | ||||||
A loader that takes the delimited NCI history file and applies it to a coding scheme. | ||||||
Load an OBO change history file. | ||||||
Load mappings between coding schemes from UMLS formatted MRMAP.RRF and MRSAT.RRF files. | ||||||
Loads representations sourced in the Classification Markup Language such as ICD-10 | ||||||
Loads the Radlex terminology from a Protege Frames formatted source. |
Javadocs for LexEVS Load Extensions:
Code Block |
---|
http://informatics.mayo.edu-LexGrid-downloads-LexEVS_60_JavaDocs-runtime_javadoc-org-LexGrid-LexBIG-Extensions-Load-package-summary.html] |
Export Extensions
Export Extensions
Export extensions are responsible for the export of content from the Export extensions are responsible for the export of content from the LexEVS repository to other representative vocabulary formats.
Interface Link | Description | ||
---|---|---|---|
Defines a class of object used to export content from the underlying LexGrid repository to another repository or file format. | |||
Exports content to LexGrid canonical XML format. | |||
Exports content to OBO text format.
| |||
Exports content to OWL XML format. |
Javadocs for LexEVS Export Extensions:
Code Block |
---|
http://informatics.mayo.edu-LexGrid-downloads-LexEVS_60_JavaDocs-runtime_javadoc-org-LexGrid-LexBIG-Extensions-Export-package-summary.html] |
Index Extensions
Index Extensions
Index extensions are built to optimize the finding, sorting and matching of query results. It is the responsibility of the Index extensions are built to optimize the finding, sorting and matching of query results. It is the responsibility of the loader to properly interpret each index it services by name, version, and provider.
Interface Link | Description |
---|---|
Identifies expected behavior and an associated loader to build and maintain a named index. Note that a single loader may be used to maintain multiple named indexes. | |
Manages registered index extensions. A single loader may be used to create and maintain multiple indexes over one or more coding schemes. |
Javadocs for LexEVS Index Exensions:
Code Block |
---|
http://informatics.mayo.edu-LexGrid-downloads-LexEVS_60_JavaDocs-runtime_javadoc-org-LexGrid-LexBIG-Extensions-Index-package-summary.html |
Generic Extensions
Generic Extensions
Generic extensions provides a mechanism to register application-specific extensions Generic extensions provides a mechanism to register application-specific extensions for reference and reuse.
Interface Link | Description |
---|---|
The generic extension class. Classes that implement this class are accessible via the LexBIGService interface. | |
Convenience methods to be implemented as a generic extension of the LexEVS API. | |
A grouping of Mapping Coding Scheme related functionality. | |
A grouping of Coding Scheme Supplement related functionality. |
Javadocs for LexEVS Generic Extensions:
Code Block |
---|
http://informatics.mayo.edu-LexGrid-downloads-LexEVS_60_JavaDocs-runtime_javadoc-org-LexGrid-LexBIG-Extensions-Generic-package-summary.html |
Utilities
Defines helper classes externalized by the LexEVS API.
Convenience Classes
Utilities
Defines helper classes externalized by the LexEVS API.
Convenience Classes
Info | ||
---|---|---|
| ||
Info | ||
| ||
It is highly recommended that all LexEVS programmers familiarize themselves with the classes contained in the |
...
Interface Link | Description |
---|---|
Helper class to ease creating common objects. | |
One-stop shopping for convenience methods that have been implemented against the LexEVS API. | |
Provides constants for use in the LexEVS API. | |
Provides centralized formatting of LexEVS Objects to String representations. | |
Provides utility methods for the LexEVS services. | |
Provides centralized formatting of LexEVS Value Set Object to String representations. |
...
...
...
...
...
...
Iterators
Iterators are used to provide controlled resolution of query results.
Interface Link | Description |
---|---|
Generic interface for flexible resolution of LexEVS objects | |
An iterator for retrieving resolved coding scheme references. |
Javadocs for LexEVS Iterator classes:
...
An iterator for retrieving resolved coding scheme references. |
Javadocs for LexEVS Iterator classes
Search Algorithms - Supported LexEVS Search Algorithms
Lucene Based Algorithms
See the Lucene Query Parser documentation for more information on these Lucene query expressions.
Code Block |
---|
Name: LuceneQuery
Version: 1.0
Description: Search with the Lucene query syntax.
See http://lucene.apache.org/java/2_3_2/queryparsersyntax.html
|
Code Block |
---|
Name: DoubleMetaphoneLuceneQuery Version: 1.0 Description: Search with the Lucene query syntax, using a 'sounds like' algorithm. A search for 'atack' will get a hit on 'attack' See http://lucene.apache.org/java/2_3_2/queryparsersyntax.html on 'attack' |
Code Block |
---|
Name: StemmedLuceneQuery
Version: 1.0
Description: Search with the Lucene query syntax, using stemmed terms.
A search for 'trees' will get a hit on 'tree'
See http://lucene.apache.org/java/2_3_2/queryparsersyntax.html
|
Code Block |
---|
Name: startsWith Version: 1.0 Description: Equivalent to 'term*' (case insensitive) |
...
Lucene Queries are well documented and can be very powerful. The uninitiated user may need some background on their use however. The user should start here with the official Lucene Query Parser documentation:
...
Keep in mind that some LexEVS queries such as "startsWith" and "contains" use wild card searches under the covers, so that use of wild cards in this context can cause errors in searches involving these search types.
...