NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Description:

Returns list of Usage Context entities matching the name provided.

Input:

  • java.lang.String usageContextName - (Mandatory) Name of a Usage Context to match.
  • java.lang.String codeSystemNameOrURI - (Mandatory) Name or URI of code system that contains the Usage Context.
  • java.lang.String codeSystemVersion - (Optional) Version of code system that contains the Usage Context.
  • org.LexGrid.LexBIG.LexBIGService.CodedNodeSet.SearchDesignationOption option - (Optional) Indicates the designations to search (one of the enumerated type SearchDesignationOption).
  • java.lang.String matchAlgorithm - (Mandatory) Local name of the match algorithm - possible algorithms are returned in LexEVSCTS2.getSupportedSearchAlgorithmNames().
  • java.lang.String language - (Optional) Language of search string. If missing, uses the default language specified in the context.

Output:

java.util.List<org.LexGrid.concepts.Entity> - List of detailed Usage Context entities that match supplied name.

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Sample Call:

  • Step 1: Instantiate UsageContextQueryOperation if it is not done yet:
    Code Block
    org.lexevs.cts2.query.UsageContextQueryOperation ucQueryOp = new org.lexevs.cts2.LexEvsCTS2Impl().getQueryOperation().getUsageContextQueryOperation();
    
  • Step 2: Call getUsageContextEntitisWithName method by passing the name to search:
    Code Block
    java.util.List<org.LexGrid.concepts.Entity> usageContextEntities = ucQuery.getUsageContextEntitisWithName("code", "usageContextCodingScheme", null, null, "subString", null); |
    

...

Description:

Returns all the Usage Context entities found in supplied code system version.

Input:

  • java.lang.String codeSystemNameOrURI - (Mandatory) Name or URI of code system that contains the Usage Context.
  • java.lang.String codeSystemVersion - (Optional) Version of code system that contains the Usage Context.

Output:

java.util.List<org.LexGrid.concepts.Entity> - List of Usage Context entities found in supplied code system version.

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Sample Call:

  • Step 1: Instantiate UsageContextQueryOperation if it is not done yet:
    Code Block
    org.lexevs.cts2.query.UsageContextQueryOperation ucQueryOp = new org.lexevs.cts2.LexEvsCTS2Impl().getQueryOperation().getUsageContextQueryOperation();
    
  • Step 2: Call listAllUsageContextEntities to get all Usage Context entities:
    Code Block
    java.util.List<org.LexGrid.concepts.Entity> usageContexts = ucQuery.listAllUsageContextEntities("usageContextCodingScheme", "1.0"); 
    

...

Description:

Returns all the Usage Context identifiers found in supplied code system version.

Input:

  • java.lang.String codeSystemNameOrURI - (Mandatory) Name or URI of code system that contains the Usage Context.
  • java.lang.String codeSystemVersion - (Optional) Version of code system that contains the Usage Context.

Output:

java.util.List<String> - List of Usage Context identifiers found in supplied code system version.

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Sample Call:

  • Step 1: Instantiate UsageContextQueryOperation if it is not done yet:
    Code Block
    org.lexevs.cts2.query.UsageContextQueryOperation ucQueryOp = new org.lexevs.cts2.LexEvsCTS2Impl().getQueryOperation().getUsageContextQueryOperation();
    
  • Step 2: Call listAllUsageContextIds to get all Usage Context identifiers:
    Code Block
    java.util.List<java.lang.String> usageContextIds = ucQuery.listAllUsageContextIds("usageContextCodingScheme", "1.0"); 
    

...