gov.nih.nci.evs.query
Interface EVSQuery

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

public interface EVSQuery
extends java.io.Serializable

EVSQuery interface describes the methods that can be implemented to access the Enterprise Vocabulary Service.


Field Summary
static long serialVersionUID
           
 
Method Summary
 void addSecurityToken(java.lang.String vocabularyName, SecurityToken token)
          Adds the specified security token and vocabulary information
 void containsInverseRole(java.lang.String vocabularyName, java.lang.String roleName, java.lang.String roleValue, java.lang.String conceptName)
          Checks if the specified concept has the specified inverse role and role value.
 void containsRole(java.lang.String vocabularyName, java.lang.String roleName, java.lang.String roleValue, java.lang.String conceptName)
          Checks if the specified concept has the specified role and role value.
 void fetchDTSProperties(java.lang.String vocabularyName, java.lang.String conceptName)
          Gets the properties of a given concept from the specified namespace
 void fetchTermAssociations(java.lang.String vocabularyName, java.lang.String conceptName)
          Fetchs term association data for a given concept from the specified namespace
 void getAllAssociationTypes(java.lang.String vocabularyName)
          Gets all associationTypes from a given namespace
 void getAllConceptAssociationQualifierTypes(java.lang.String vocabularyName)
          Retrievs the name of all concecpt association quailifer types from the specified namespace
 void getAllConceptAssociationTypes(java.lang.String vocabularyName)
          Retrievs the name of all concecpt association types from the specified namespace
 void getAllConceptPropertyQualifierTypes(java.lang.String vocabularyName)
          Retrievs the name of all concecpt property qualifier types from the specified namespace
 void getAllConceptPropertyTypes(java.lang.String vocabularyName)
          Retrievs the name of all concecpt property types from the specified namespace
 void getAllLicenses(java.lang.String vocabularyName, java.lang.String condition)
          Gets all licenses from the specified namespace
 void getAllPropertyTypes(java.lang.String vocabularyName)
          Gets all the property types from a specified namespace
 void getAllQualifierTypes(java.lang.String vocabularyName)
          Gets all qualifier types from the specified namespace
 void getAllRoleNames(java.lang.String vocabularyName)
          Gets all the role names from the specified namespace
 void getAllSilos(java.lang.String vocabularyName)
          Gets all the Silos from a specified namespace
 void getAllSubConceptCodes(java.lang.String vocabularyName, java.lang.String conceptCode)
          Gets all the sub concept codes for the specified concept from a given namespace
 void getAllSubConceptNames(java.lang.String vocabularyName, java.lang.String conceptName)
          Gets all the sub concept names for the specified concept from a given namespace
 void getAllSynonymTypes(java.lang.String vocabularyName)
          Gets all synonym types from a given namespace
 void getAllTermAssociationQualifierTypes(java.lang.String vocabularyName)
          Gets all the term-association qualifier types from a given namespace
 void getAllTermPropertyQualifierTypes(java.lang.String vocabularyName)
          Gets all the term-property qualifier types from a given namespace
 void getAllTermPropertyTypes(java.lang.String vocabularyName)
          Gets all the term-property types from a given namespace
 void getAllVocabularies()
          Returns a list of populated Vocabulary objects from the EVS server via the ApplicationService
 void getAncestors(java.lang.String vocabularyName, java.lang.String code, boolean flag, java.lang.String iBaseLineDate, java.lang.String fBaseLineDate)
          Gets the ancestor concept codes of the specified concept.
 void getAssociationCollectionbyCode(java.lang.String vocabularyName, java.lang.String conceptCode)
          Gets associations for the specified concept.
 void getAtomCollectionbyCui(java.lang.String cui)
           
 void getBroaderConcepts(java.lang.String conceptCode)
          Gets all the broader MetaThesaurus concepts for a given concept The relationship between these concepts are of type "RB" (Related Broader)
 void getBroaderConcepts(java.lang.String conceptCode, java.lang.String sourceAbbr)
          Gets all the broader MetaThesaurusConcepts for a given concept from the specified source.
 void getChildConcepts(java.lang.String vocabularyName, java.lang.String conceptName, boolean inputFlag)
          Gets a child DescLogicConcept for a given concept name
 void getChildConcepts(java.lang.String vocabularyName, java.lang.String conceptName, boolean inputFlag, int ASDIndex)
          Gets a child DescLogicConcept for a given concept name
 void getChildren(java.lang.String conceptCode, java.lang.String sourceAbbr)
          Gets all the child MetaThesaurusConcepts for a given conncept in the specified source
 void getCodeActionChildren(java.lang.String vocabularyName, java.lang.String conceptCode, java.lang.String baseLineDate, java.lang.String action)
          Gets child concept codes for the specified concept.
 void getCodeActionParents(java.lang.String vocabularyName, java.lang.String conceptCode, java.lang.String baseLineDate)
          Gets parent concept codes for the specified concept.
 void getConceptByName(java.lang.String vocabularyName, java.lang.String conceptName)
          Gets a DescLogicConcept for the specified conceptName.
 void getConceptCodeByName(java.lang.String vocabularyName, java.lang.String conceptName)
          Gets the code of the specified concept.
 void getConceptEditAction(java.lang.String vocabularyName, java.lang.String code)
          Gets all EditAction of the specified concept.
 void getConceptEditAction(java.lang.String vocabularyName, java.lang.String code, java.util.Date editActionDate)
          Gets all EditAction of the specified concept.
 void getConceptEditActionDates(java.lang.String vocabularyName, java.lang.String code, java.lang.String action)
          Gets EditActionDate that match with the given concept code and edit action.
 void getConceptNameByCode(java.lang.String vocabularyName, java.lang.String conceptCode)
          Deprecated. - The preferred method is getDescLogicConceptNameByCode
 void getConceptsByCategories(java.lang.String conceptCode, java.lang.String category)
          Gets the concepts of specified category for the given metathesaurus concept
 void getConceptsBySource(java.lang.String sourceAbbr)
          Deprecated. - Vocabulary Sources hosts large number of concept information. This method retrieves all the concepts from a Source. If all the concepts were not returned prior a time limit specified on the server this method tends to die.
 void getConceptWithPropertyMatching(java.lang.String vocabularyName, java.lang.String propertyName, java.lang.String propertyValue, int matchLimit)
          Gets all the concept names that matches the argument pattern of a property.
 void getConceptWithSiloMatching(java.lang.String vocabularyName, java.lang.String searchTerm, int matchLimit)
          Gets all the concept names from the Silos that matches the pattern.
 void getConceptWithSiloMatching(java.lang.String vocabularyName, java.lang.String searchTerm, int matchLimit, java.lang.String siloName)
          Gets all the concept names from the Silos that matches the pattern.
 void getDefinitionCollectionbyCui(java.lang.String cui)
           
 void getDescendants(java.lang.String vocabularyName, java.lang.String code, boolean flag, java.lang.String iBaseLineDate, java.lang.String fBaseLineDate)
          Gets the descendant concept codes of the specified conceptCode.
 void getDescLogicConcept(java.lang.String vocabularyName, java.lang.String conceptName, boolean inputFlag)
          Gets a DescLogicConcept for a valid conceptName or concept code
 void getDescLogicConceptNameByCode(java.lang.String vocabularyName, java.lang.String conceptCode)
          Gets Concept name for the given concept code
 void getEdgePropertiesbyCode(java.lang.String vocabularyName, java.lang.String conceptCode)
          Gets get Semantic Types for the specified concept.
 void getHasChildrenbyCode(java.lang.String vocabularyName, java.lang.String cui)
           
 void getHasParentsbyCode(java.lang.String vocabularyName, java.lang.String cui)
           
 void getHistoryCollectionbyDescLogicConceptCode(java.lang.String descLogicConceptCode)
           
 void getHistoryEndDate(java.lang.String vocabularyName)
           
 void getHistoryRecordbyCode(java.lang.String vocabularyName, java.lang.String conceptCode)
           
 void getHistoryRecords(java.lang.String vocabularyName, java.lang.String conceptCode)
          Gets List of HistoryRecords for a given concept code
 void getHistoryRecords(java.lang.String vocabularyName, java.lang.String initialDate, java.lang.String finalDate)
          Gets List of HistoryRecords
 void getHistoryRecords(java.lang.String vocabularyName, java.lang.String initialDate, java.lang.String finalDate, java.lang.String conceptCode)
          Gets List of HistoryRecords
 void getHistoryStartDate(java.lang.String vocabularyName)
           
 void getInverseAssociationCollectionbyCode(java.lang.String vocabularyName, java.lang.String conceptCode)
           
 void getInverseRoleCollectionbyCode(java.lang.String vocabularyName, java.lang.String conceptCode)
           
 void getMetaConceptNameByCode(java.lang.String conceptCode)
          gets MetaThesaurusConcept name
 void getMetaConceptsForAllSources()
          Deprecated.  
 void getMetaSources()
          Get all MetaThesaurus Sources
 void getNarrowerConcepts(java.lang.String conceptCode)
          Gets narrower MetaThesaurus concepts for the specified concept The relationship between these concepts are of type "RN" (Related Narrower)
 void getNarrowerConcepts(java.lang.String conceptCode, java.lang.String sourceAbbr)
          Gets narrower MetaThesaurus concepts for the specified concept from a given source The relationship between these concepts are of type "RN" (Related Narrower)
 void getParent(java.lang.String conceptCode, java.lang.String sourceAbbr)
          Gets all the Parent MetaThesaurusConcepts for a given concept from the specified source.
 void getParentConcepts(java.lang.String vocabularyName, java.lang.String conceptName, boolean inputFlag)
          Gets a parent DescLogicConcept for a given concept name
 void getParentConcepts(java.lang.String vocabularyName, java.lang.String conceptName, boolean inputFlag, int ASDIndex)
          Gets a parent DescLogicConcept for a given concept name
 void getPropertiesByConceptName(java.lang.String vocabularyName, java.lang.String conceptName)
          Gets the names and values of properties owned by the specified concept.
 void getPropertyCollectionbyCode(java.lang.String vocabularyName, java.lang.String conceptCode)
           
 void getPropertyCollectionbyName(java.lang.String name)
           
 void getPropertyValues(java.lang.String vocabularyName, java.lang.String conceptName, java.lang.String propertyName)
          Gets the values of a property owned by a concept
 void getQualifierCollectionbyName(java.lang.String name)
           
 void getRelatedConcepts(java.lang.String conceptCode)
          Gets all related metathesaurus concepts for a given metaconcept
 void getRelatedConcepts(java.lang.String conceptCode, java.lang.String sourceAbbr)
          Gets all the related metathesaurus concepts for a given metaconcept from the specified source
 void getRelatedConcepts(java.lang.String conceptCode, java.lang.String sourceAbbr, java.lang.String relation)
          Gets the related metathesaurus concepts for a given metaconcept from the specified source
 void getRoleCollectionbyCode(java.lang.String vocabularyName, java.lang.String conceptCode)
           
 void getRolesByConceptName(java.lang.String vocabularyName, java.lang.String conceptName)
          Gets the roles owned by the specified concept.
 void getRootConcepts(java.lang.String vocabularyName, boolean allAttributes)
          Retrieves all root DescLogicConcept objects
 void getSecurityTokenbyName(java.lang.String name)
           
 void getSemanticTypeCollectionbyCui(java.lang.String cui)
           
 void getSemanticTypes()
          Gets all semantic types from metaphrase
 void getSemanticTypeVectorbyCode(java.lang.String vocabularyName, java.lang.String cui)
           
 void getSiloCollectionbyName(java.lang.String name)
           
 void getSourcebyCode(java.lang.String vocabularyName, java.lang.String conceptCode)
          Gets source for the specified concept.
 void getSourcebyDefinition(java.lang.String definition)
           
 void getSourceCollectionbyCui(java.lang.String cui)
           
 void getSubConcepts(java.lang.String vocabularyName, java.lang.String conceptName, java.lang.Boolean inputFlag, java.lang.Boolean outputFlag)
          Gets the codes, or the names, of all subconcepts of the specified concept
 void getSuperConcepts(java.lang.String vocabularyName, java.lang.String conceptname, java.lang.Boolean inputFlag, java.lang.Boolean outputFlag)
          Gets the codes (or the names) of all superconcepts of the specified concept.
 void getSynonymCollectionbyCui(java.lang.String cui)
           
 void getTree(java.lang.String vocabularyName, java.lang.String rootName, boolean direction, boolean isaFlag, int attributes, int levels, java.util.Vector roles)
          Generates a DefaultMutableTreeNode for the specified rootName
Eeach node is a DescLogicConcept instance
 void getTree(java.lang.String vocabularyName, java.lang.String rootName, boolean direction, boolean isaFlag, int attributes, java.lang.String levels, java.util.Vector roles)
          Generates a DefaultMutableTreeNode for the specified rootName
Eeach node is a DescLogicConcept instance
 void getTreeNodebyCode(java.lang.String vocabularyName, java.lang.String conceptCode)
          Gets TreeNode for the specified concept.
 void getVocabularybyCode(java.lang.String vocabularyName, java.lang.String conceptCode)
           
 void getVocabularyByName(java.lang.String vocabularyName)
          Returns the specified vocabulary in a List
 void getVocabularyHost(java.lang.String vocabularyName)
          Gets the host of a vocabulary server
 void getVocabularyNames()
          Gets vocabulary names from EVS
 void getVocabularyPort(java.lang.String vocabularyName)
          Gets the port of a vocabulary server
 void getVocabularyVersion(java.lang.String vocabularyName)
          Returns a list of versions for the given vocabulary in the knowledgebase.
 void hasChildren(java.lang.String vocabularyName, java.lang.String conceptName)
          Returns true if the specified concept has a child concept
 void hasParents(java.lang.String vocabularyName, java.lang.String conceptName)
          Returns true if the specified concept has a parent concept
 void isRetired(java.lang.String vocabularyName, java.lang.String code)
          Checks if the specified concept is retired or not.
 void isSubConcept(java.lang.String vocabularyName, java.lang.String code1, java.lang.String code2)
          Checks if the first concept is a subconcept of the second concept
 void searchByLoincId(java.lang.String code, java.lang.String sourceAbbr)
          Deprecated. - The preferred method is searchSourceByCode
 void searchDescLogicConcepts(java.lang.String vocabularyName, java.lang.String searchTerm, int limit)
          Search DescLogicConcepts
 void searchDescLogicConcepts(java.lang.String vocabularyName, java.lang.String searchTerm, int limit, int matchOption, java.lang.String matchType, int ASDIndex)
          Performs a search for a DescLogicConcept
 void searchMetaThesaurus(java.lang.String cui)
          Search concepts in MetaThesaurus
 void searchMetaThesaurus(java.lang.String searchTerm, int limit, java.lang.String source, boolean cui, boolean shortResponse, boolean score)
          Searches for concepts in the specified MetaThesaurus source.
 void searchSourceByAtomCode(java.lang.String code, java.lang.String sourceAbbr)
          Search the specified vocabulary for a given atom code
 void searchSourceByCode(java.lang.String code, java.lang.String sourceAbbr)
          Deprecated. - The preferred method is searchSourceByAtomCode
 void validateToken(java.lang.String vocabularyName, SecurityToken token)
          Validates the security token aganist a vocabulary
 

Field Detail

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values
Method Detail

addSecurityToken

void addSecurityToken(java.lang.String vocabularyName,
                      SecurityToken token)
                      throws java.lang.Exception
Adds the specified security token and vocabulary information

Throws:
java.lang.Exception

validateToken

void validateToken(java.lang.String vocabularyName,
                   SecurityToken token)
Validates the security token aganist a vocabulary


getTree

void getTree(java.lang.String vocabularyName,
             java.lang.String rootName,
             boolean direction,
             boolean isaFlag,
             int attributes,
             java.lang.String levels,
             java.util.Vector roles)
Generates a DefaultMutableTreeNode for the specified rootName
Eeach node is a DescLogicConcept instance

Parameters:
vocabularyName -
rootName - - RootNode of the tree
direction - - a boolean value (true if traverse down)
isaFlag - - a boolean value (true if relationship is child)
attributes - - Sets the AttributeSetDescriptor value for the root node.
levels - - the depth of the tree
roles - - the names of role relationships

getTree

void getTree(java.lang.String vocabularyName,
             java.lang.String rootName,
             boolean direction,
             boolean isaFlag,
             int attributes,
             int levels,
             java.util.Vector roles)
Generates a DefaultMutableTreeNode for the specified rootName
Eeach node is a DescLogicConcept instance

Parameters:
vocabularyName -
rootName - - RootNode of the tree
direction - - a boolean value (true if traverse down)
isaFlag - - a boolean value (true if relationship is child)
attributes - - Sets the AttributeSetDescriptor value for the root node.
levels - - the depth of the tree
roles - - the names of role relationships

searchDescLogicConcepts

void searchDescLogicConcepts(java.lang.String vocabularyName,
                             java.lang.String searchTerm,
                             int limit)
Search DescLogicConcepts

Parameters:
vocabularyName - - Specifies the namespace
searchTerm - - Specifies the search term
limit - - Specifies the maximum limit of the search results

searchDescLogicConcepts

void searchDescLogicConcepts(java.lang.String vocabularyName,
                             java.lang.String searchTerm,
                             int limit,
                             int matchOption,
                             java.lang.String matchType,
                             int ASDIndex)
                             throws java.lang.Exception
Performs a search for a DescLogicConcept

Parameters:
vocabularyName -
searchTerm - - Specifies the search term
limit - - Specifies the maximum limit of search results
matchOption - - Specifies the match option Example: option values
0 - MATCH_BY_NAME
1 - MATCH_BY_ROLE
2 - MATCH_BY_PROPERTY
3 - MATCH_BY_SILO
4 - MATCH_BY_ASSOCIATION
5 - MATCH_BY_SYNONYM
6 - MATCH_BY_INVERSE_ROLE
7 - MATCH_BY_INVERSE_ASSOCIATION
8 - MATCH_BY_ROLE_PROPERTY
matchType - - Depends on the match options (not all the time)
If match option is 0 match type should be ""
If match option is 1 match type should be role name
If match option is 2 match type should be property name
If match option is 3 match type should be ""
If match option is 4 match type should be association name
If match option is 5 match type should be a synonym name
If match option is 6 match type should be role name
If match option is 7 match type should be a association name
If match option is 8 match type should be a ""
ASDIndex - - Takes an integer ranging from 0-3
0 - WITH_NO_ATTRIBUTES
1 - WITH_ALL_ATTRIBUTES
2 - WITH_ALL_ROLES
3 - WITH_ALL_PROPERTIES
Throws:
java.lang.Exception

getConceptWithPropertyMatching

void getConceptWithPropertyMatching(java.lang.String vocabularyName,
                                    java.lang.String propertyName,
                                    java.lang.String propertyValue,
                                    int matchLimit)
Gets all the concept names that matches the argument pattern of a property.

Parameters:
vocabularyName - - specifies the namespace
propertyName - - all returned concepts should have the value of this Property
propertyValue - - pattern for searching
matchLimit - - number of records to get

getConceptWithSiloMatching

void getConceptWithSiloMatching(java.lang.String vocabularyName,
                                java.lang.String searchTerm,
                                int matchLimit)
Gets all the concept names from the Silos that matches the pattern.

Parameters:
vocabularyName - - specifies the namespace
searchTerm - - specifies the search string
matchLimit - - number of records to get

getConceptWithSiloMatching

void getConceptWithSiloMatching(java.lang.String vocabularyName,
                                java.lang.String searchTerm,
                                int matchLimit,
                                java.lang.String siloName)
Gets all the concept names from the Silos that matches the pattern.

Parameters:
vocabularyName - - specifies the namespace
searchTerm - - specifies the search string
matchLimit - - number of records to get
siloName - - specifies the name of the Silo

getDescLogicConceptNameByCode

void getDescLogicConceptNameByCode(java.lang.String vocabularyName,
                                   java.lang.String conceptCode)
Gets Concept name for the given concept code

Parameters:
vocabularyName - - specifies the vocabulary
conceptCode - - specifies the concept code

isSubConcept

void isSubConcept(java.lang.String vocabularyName,
                  java.lang.String code1,
                  java.lang.String code2)
Checks if the first concept is a subconcept of the second concept

Parameters:
vocabularyName - - specifies the namespace
code1 - - the name of the first concept
code2 - - the name of the second concept

isRetired

void isRetired(java.lang.String vocabularyName,
               java.lang.String code)
Checks if the specified concept is retired or not.

Parameters:
vocabularyName -
code - - conceptCode

getDescendants

void getDescendants(java.lang.String vocabularyName,
                    java.lang.String code,
                    boolean flag,
                    java.lang.String iBaseLineDate,
                    java.lang.String fBaseLineDate)
Gets the descendant concept codes of the specified conceptCode. The search extends to a final baseline date starting from an initial baseline date. The search is based on a boolean value(flag). If the value is true, the method only searches for the active concepts at the final baseline date. If the value is false, the method searches for all descendant concepts, whether active or retired.

Parameters:
vocabularyName -
code - - concept code
flag - - boolean value to specify the search type
iBaseLineDate - - initial baseline date
fBaseLineDate - - final baseline date

getPropertyValues

void getPropertyValues(java.lang.String vocabularyName,
                       java.lang.String conceptName,
                       java.lang.String propertyName)
Gets the values of a property owned by a concept

Parameters:
vocabularyName -
conceptName -
propertyName -

getAncestors

void getAncestors(java.lang.String vocabularyName,
                  java.lang.String code,
                  boolean flag,
                  java.lang.String iBaseLineDate,
                  java.lang.String fBaseLineDate)
Gets the ancestor concept codes of the specified concept. The search extends to a final baseline date starting from an initial baseline date. The search is based on a boolean value. If the value is true, the method only searches for the active concepts at the initial baseline date. If the value is false, the method searches for all ancestor concepts, whether active or retired.

Parameters:
vocabularyName -
code -
flag -
iBaseLineDate - - Initial baseline date "MM/DD/YYYY"
fBaseLineDate - - Final baseline date "MM/DD/YYYY"

getSubConcepts

void getSubConcepts(java.lang.String vocabularyName,
                    java.lang.String conceptName,
                    java.lang.Boolean inputFlag,
                    java.lang.Boolean outputFlag)
Gets the codes, or the names, of all subconcepts of the specified concept

Parameters:
vocabularyName -
conceptName - - code or the specified concept name
inputFlag - - a Boolean true - if inputFlag is a concept code; false - if it is a concept name
outputFlag - - a Boolean true - if returned value is a concept code ; false - if it is a concept name.

getSuperConcepts

void getSuperConcepts(java.lang.String vocabularyName,
                      java.lang.String conceptname,
                      java.lang.Boolean inputFlag,
                      java.lang.Boolean outputFlag)
Gets the codes (or the names) of all superconcepts of the specified concept.

Parameters:
vocabularyName -
conceptname -
inputFlag - - a Boolean true - if inputFlag is a concept code; false - if it is a concept name
outputFlag - - a Boolean true - if returned value is a concept code ; false - if it is a concept name.

getRolesByConceptName

void getRolesByConceptName(java.lang.String vocabularyName,
                           java.lang.String conceptName)
Gets the roles owned by the specified concept.

Parameters:
vocabularyName -
conceptName -

getPropertiesByConceptName

void getPropertiesByConceptName(java.lang.String vocabularyName,
                                java.lang.String conceptName)
Gets the names and values of properties owned by the specified concept.

Parameters:
vocabularyName -
conceptName -

getVocabularyNames

void getVocabularyNames()
Gets vocabulary names from EVS


getAllVocabularies

void getAllVocabularies()
Returns a list of populated Vocabulary objects from the EVS server via the ApplicationService


getVocabularyByName

void getVocabularyByName(java.lang.String vocabularyName)
Returns the specified vocabulary in a List


getConceptCodeByName

void getConceptCodeByName(java.lang.String vocabularyName,
                          java.lang.String conceptName)
Gets the code of the specified concept.

Parameters:
vocabularyName -
conceptName -

getConceptByName

void getConceptByName(java.lang.String vocabularyName,
                      java.lang.String conceptName)
Gets a DescLogicConcept for the specified conceptName.

Parameters:
vocabularyName -
conceptName -

getVocabularyHost

void getVocabularyHost(java.lang.String vocabularyName)
Gets the host of a vocabulary server

Parameters:
vocabularyName -

getVocabularyPort

void getVocabularyPort(java.lang.String vocabularyName)
Gets the port of a vocabulary server

Parameters:
vocabularyName -

getVocabularyVersion

void getVocabularyVersion(java.lang.String vocabularyName)
Returns a list of versions for the given vocabulary in the knowledgebase.

Parameters:
vocabularyName -

getConceptEditAction

void getConceptEditAction(java.lang.String vocabularyName,
                          java.lang.String code)
Gets all EditAction of the specified concept. A EditAction contains a edit date and an editing action. The method searches for all editing actions and the corresponding editing dates on the specified concept.

Parameters:
vocabularyName -
code -

getConceptEditAction

void getConceptEditAction(java.lang.String vocabularyName,
                          java.lang.String code,
                          java.util.Date editActionDate)
Gets all EditAction of the specified concept. A EditAction contains a edit date and an editing action. The method searches for all editing actions and the corresponding editing dates on the specified concept.

Parameters:
vocabularyName -
code -
editActionDate -

getConceptEditActionDates

void getConceptEditActionDates(java.lang.String vocabularyName,
                               java.lang.String code,
                               java.lang.String action)
Gets EditActionDate that match with the given concept code and edit action.

Parameters:
vocabularyName -
code - - concept code
action - - edit action

getRootConcepts

void getRootConcepts(java.lang.String vocabularyName,
                     boolean allAttributes)
Retrieves all root DescLogicConcept objects

Parameters:
vocabularyName -
allAttributes - - true, if all attributes are retrieved; false, if no attribute is retrieved.

searchMetaThesaurus

void searchMetaThesaurus(java.lang.String searchTerm,
                         int limit,
                         java.lang.String source,
                         boolean cui,
                         boolean shortResponse,
                         boolean score)
Searches for concepts in the specified MetaThesaurus source. If the concept code is used as the searchTerm, the cui boolean value should be true

Parameters:
searchTerm - - CUI or search string
limit - - maximum records
source - - source abbreviation
cui - - a boolean value - true, if the searchTerm is CUI, - false, otherwise
shortResponse - - a boolean value
score - - a boolean value

searchMetaThesaurus

void searchMetaThesaurus(java.lang.String cui)
Search concepts in MetaThesaurus

Parameters:
cui - - Concept Unique Identifier

searchByLoincId

void searchByLoincId(java.lang.String code,
                     java.lang.String sourceAbbr)
Deprecated. - The preferred method is searchSourceByCode

Search the specified vocabulary for a given code

Parameters:
code - - Concepts unique identifier within the given source
sourceAbbr - - specifies the source abbreviation

searchSourceByAtomCode

void searchSourceByAtomCode(java.lang.String code,
                            java.lang.String sourceAbbr)
Search the specified vocabulary for a given atom code

Parameters:
code - - Concepts unique identifier within the given source
sourceAbbr - - specifies the source abbreviation *

searchSourceByCode

void searchSourceByCode(java.lang.String code,
                        java.lang.String sourceAbbr)
Deprecated. - The preferred method is searchSourceByAtomCode

Search the specified vocabulary for a given code

Parameters:
code - - Concepts unique identifier within the given source
sourceAbbr - - specifies the source abbreviation

getSemanticTypes

void getSemanticTypes()
Gets all semantic types from metaphrase


getConceptsBySource

void getConceptsBySource(java.lang.String sourceAbbr)
Deprecated. - Vocabulary Sources hosts large number of concept information. This method retrieves all the concepts from a Source. If all the concepts were not returned prior a time limit specified on the server this method tends to die.

Gets MetaThesaurusConcepts for the specified source

Parameters:
sourceAbbr - - specifies the source abbreviation

getMetaConceptsForAllSources

void getMetaConceptsForAllSources()
Deprecated. 

Returns MetaThesaurus concepts for all Sources


getMetaConceptNameByCode

void getMetaConceptNameByCode(java.lang.String conceptCode)
gets MetaThesaurusConcept name

Parameters:
conceptCode - - specifies the concept code

getMetaSources

void getMetaSources()
Get all MetaThesaurus Sources


getChildren

void getChildren(java.lang.String conceptCode,
                 java.lang.String sourceAbbr)
Gets all the child MetaThesaurusConcepts for a given conncept in the specified source

Parameters:
conceptCode - - specifies the concept code
sourceAbbr - - specifies the source abbreviation

getParent

void getParent(java.lang.String conceptCode,
               java.lang.String sourceAbbr)
Gets all the Parent MetaThesaurusConcepts for a given concept from the specified source. The relationship between these concepts are of type "PAR" (Parent)

Parameters:
conceptCode - - specifies the concept code
sourceAbbr - - specifies the source abbreviation

getBroaderConcepts

void getBroaderConcepts(java.lang.String conceptCode)
Gets all the broader MetaThesaurus concepts for a given concept The relationship between these concepts are of type "RB" (Related Broader)

Parameters:
conceptCode - - specifies the concept code

getBroaderConcepts

void getBroaderConcepts(java.lang.String conceptCode,
                        java.lang.String sourceAbbr)
Gets all the broader MetaThesaurusConcepts for a given concept from the specified source. The relationship between these concepts are of type "RB" (Related Broader)

Parameters:
conceptCode - - specifies the concept code
sourceAbbr - - specifies the source abbreviation

getNarrowerConcepts

void getNarrowerConcepts(java.lang.String conceptCode)
Gets narrower MetaThesaurus concepts for the specified concept The relationship between these concepts are of type "RN" (Related Narrower)

Parameters:
conceptCode - - specifies the concept code

getNarrowerConcepts

void getNarrowerConcepts(java.lang.String conceptCode,
                         java.lang.String sourceAbbr)
Gets narrower MetaThesaurus concepts for the specified concept from a given source The relationship between these concepts are of type "RN" (Related Narrower)

Parameters:
conceptCode - - specifies the concept code

getRelatedConcepts

void getRelatedConcepts(java.lang.String conceptCode)
Gets all related metathesaurus concepts for a given metaconcept

Parameters:
conceptCode - - specifies the concept code

getRelatedConcepts

void getRelatedConcepts(java.lang.String conceptCode,
                        java.lang.String sourceAbbr)
Gets all the related metathesaurus concepts for a given metaconcept from the specified source

Parameters:
conceptCode - - specifies the concept code
sourceAbbr - - specifies the source abbreviation

getRelatedConcepts

void getRelatedConcepts(java.lang.String conceptCode,
                        java.lang.String sourceAbbr,
                        java.lang.String relation)
Gets the related metathesaurus concepts for a given metaconcept from the specified source

Parameters:
conceptCode - - specifies the concept code
sourceAbbr - - specifies the source abbreviation
relation - - Specifies the relation of a second concept to the first concept
RB - Related Broader, RN - Related Narrower, RO - Related Other, RL - Related Alike,
PAR - Parent, CHD - Child, SIB - Sibling, AQ - Allowed Qualifier (MeSH only), QB - Qualified By (MeSH Only)

getConceptsByCategories

void getConceptsByCategories(java.lang.String conceptCode,
                             java.lang.String category)
Gets the concepts of specified category for the given metathesaurus concept

Parameters:
conceptCode - - specifies the concept code
category - - one of "Medications", "Procedures", "Laboratory", "Diagnosis"

containsInverseRole

void containsInverseRole(java.lang.String vocabularyName,
                         java.lang.String roleName,
                         java.lang.String roleValue,
                         java.lang.String conceptName)
Checks if the specified concept has the specified inverse role and role value.

Parameters:
vocabularyName - - Specifies the namespace
roleName - - role name
roleValue - - role value
conceptName - - concpet name

containsRole

void containsRole(java.lang.String vocabularyName,
                  java.lang.String roleName,
                  java.lang.String roleValue,
                  java.lang.String conceptName)
Checks if the specified concept has the specified role and role value.

Parameters:
vocabularyName - - Specifies the namespace
roleName - - role name
roleValue - - role value
conceptName - - concept name

getAllAssociationTypes

void getAllAssociationTypes(java.lang.String vocabularyName)
Gets all associationTypes from a given namespace

Parameters:
vocabularyName - - Specifies the namespace

getAllConceptAssociationQualifierTypes

void getAllConceptAssociationQualifierTypes(java.lang.String vocabularyName)
Retrievs the name of all concecpt association quailifer types from the specified namespace

Parameters:
vocabularyName - - Specifies the namespace

getAllConceptAssociationTypes

void getAllConceptAssociationTypes(java.lang.String vocabularyName)
Retrievs the name of all concecpt association types from the specified namespace

Parameters:
vocabularyName - - Specifies the namespace

getAllConceptPropertyQualifierTypes

void getAllConceptPropertyQualifierTypes(java.lang.String vocabularyName)
Retrievs the name of all concecpt property qualifier types from the specified namespace

Parameters:
vocabularyName - - Specifies the namespace

getAllConceptPropertyTypes

void getAllConceptPropertyTypes(java.lang.String vocabularyName)
Retrievs the name of all concecpt property types from the specified namespace

Parameters:
vocabularyName - - Specifies the namespace

getAllLicenses

void getAllLicenses(java.lang.String vocabularyName,
                    java.lang.String condition)
Gets all licenses from the specified namespace

Parameters:
vocabularyName - - Specifies the namespace
condition - - Specifies the value for a condition parameter

getAllPropertyTypes

void getAllPropertyTypes(java.lang.String vocabularyName)
Gets all the property types from a specified namespace

Parameters:
vocabularyName - - specfifies the namespace

getAllSilos

void getAllSilos(java.lang.String vocabularyName)
Gets all the Silos from a specified namespace

Parameters:
vocabularyName - - specfifies the namespace

getAllQualifierTypes

void getAllQualifierTypes(java.lang.String vocabularyName)
Gets all qualifier types from the specified namespace

Parameters:
vocabularyName - - Specifies the namespace

getAllRoleNames

void getAllRoleNames(java.lang.String vocabularyName)
Gets all the role names from the specified namespace

Parameters:
vocabularyName - - Specifies the namespace

getAllSubConceptCodes

void getAllSubConceptCodes(java.lang.String vocabularyName,
                           java.lang.String conceptCode)
Gets all the sub concept codes for the specified concept from a given namespace

Parameters:
vocabularyName - - Specifies the namespace
conceptCode - - Specifies the concept code

getAllSubConceptNames

void getAllSubConceptNames(java.lang.String vocabularyName,
                           java.lang.String conceptName)
Gets all the sub concept names for the specified concept from a given namespace

Parameters:
vocabularyName - - Specifies the namespace
conceptName - - Specifies the concept name

getAllSynonymTypes

void getAllSynonymTypes(java.lang.String vocabularyName)
Gets all synonym types from a given namespace

Parameters:
vocabularyName - - Specifies the namespace

getAllTermAssociationQualifierTypes

void getAllTermAssociationQualifierTypes(java.lang.String vocabularyName)
Gets all the term-association qualifier types from a given namespace

Parameters:
vocabularyName - - Specifies the namespace

getAllTermPropertyQualifierTypes

void getAllTermPropertyQualifierTypes(java.lang.String vocabularyName)
Gets all the term-property qualifier types from a given namespace

Parameters:
vocabularyName - - Specifies the namespace

getAllTermPropertyTypes

void getAllTermPropertyTypes(java.lang.String vocabularyName)
Gets all the term-property types from a given namespace

Parameters:
vocabularyName - - Specifies the namespace

getParentConcepts

void getParentConcepts(java.lang.String vocabularyName,
                       java.lang.String conceptName,
                       boolean inputFlag)
Gets a parent DescLogicConcept for a given concept name

Parameters:
vocabularyName - - Specifies the namespace
conceptName - - Specifies the concept name
inputFlag - - If the input parameter is a concpeName inputFlag should be false
If the input parameter is a conceptCode this value should be true.

getParentConcepts

void getParentConcepts(java.lang.String vocabularyName,
                       java.lang.String conceptName,
                       boolean inputFlag,
                       int ASDIndex)
Gets a parent DescLogicConcept for a given concept name

Parameters:
vocabularyName - - Specifies the namespace
conceptName - - Specifies the concept name
inputFlag - - If the input parameter is a concpeName inputFlag should be false
If the input parameter is a conceptCode this value should be true.
ASDIndex - - Sets the AttributeSetDescriptor value

getChildConcepts

void getChildConcepts(java.lang.String vocabularyName,
                      java.lang.String conceptName,
                      boolean inputFlag)
Gets a child DescLogicConcept for a given concept name

Parameters:
vocabularyName - - Specifies the namespace
conceptName - - Specifies the concept name
inputFlag - - If the input parameter is a concpeName inputFlag should be false
If the input parameter is a conceptCode this value should be true.

getChildConcepts

void getChildConcepts(java.lang.String vocabularyName,
                      java.lang.String conceptName,
                      boolean inputFlag,
                      int ASDIndex)
Gets a child DescLogicConcept for a given concept name

Parameters:
vocabularyName - - Specifies the namespace
conceptName - - Specifies the concept name
inputFlag - - If the input parameter is a concpeName inputFlag should be false
If the input parameter is a conceptCode this value should be true.
ASDIndex - - Sets the AttributeSetDescriptor value

hasParents

void hasParents(java.lang.String vocabularyName,
                java.lang.String conceptName)
Returns true if the specified concept has a parent concept

Parameters:
vocabularyName - - Specifies the namespace
conceptName - - Specifies the concept name

hasChildren

void hasChildren(java.lang.String vocabularyName,
                 java.lang.String conceptName)
Returns true if the specified concept has a child concept

Parameters:
vocabularyName - - Specifies the namespace
conceptName - - Specifies the concept name

fetchDTSProperties

void fetchDTSProperties(java.lang.String vocabularyName,
                        java.lang.String conceptName)
Gets the properties of a given concept from the specified namespace

Parameters:
vocabularyName - - Specifies the namespace
conceptName - - Specifies the concept name

fetchTermAssociations

void fetchTermAssociations(java.lang.String vocabularyName,
                           java.lang.String conceptName)
Fetchs term association data for a given concept from the specified namespace

Parameters:
vocabularyName - - Specifies the namespace
conceptName - - Specifies the concept name

getConceptNameByCode

void getConceptNameByCode(java.lang.String vocabularyName,
                          java.lang.String conceptCode)
Deprecated. - The preferred method is getDescLogicConceptNameByCode

Gets the concept name for the specified concept code

Parameters:
vocabularyName - - specifies the namespace
conceptCode - - specifies the concept code

getDescLogicConcept

void getDescLogicConcept(java.lang.String vocabularyName,
                         java.lang.String conceptName,
                         boolean inputFlag)
Gets a DescLogicConcept for a valid conceptName or concept code

Parameters:
conceptName - - Specifies the conceptName or concept code
inputFlag - - If a concept code is entered this value is a true. If a concept name has been entered this value should be false.

getHistoryRecords

void getHistoryRecords(java.lang.String vocabularyName,
                       java.lang.String conceptCode)
Gets List of HistoryRecords for a given concept code

Parameters:
vocabularyName -
conceptCode -

getHistoryRecords

void getHistoryRecords(java.lang.String vocabularyName,
                       java.lang.String initialDate,
                       java.lang.String finalDate,
                       java.lang.String conceptCode)
Gets List of HistoryRecords

Parameters:
vocabularyName -
initialDate -
finalDate -
conceptCode -

getHistoryRecords

void getHistoryRecords(java.lang.String vocabularyName,
                       java.lang.String initialDate,
                       java.lang.String finalDate)
Gets List of HistoryRecords

Parameters:
vocabularyName -
initialDate -
finalDate -

getHistoryStartDate

void getHistoryStartDate(java.lang.String vocabularyName)

getHistoryEndDate

void getHistoryEndDate(java.lang.String vocabularyName)

getCodeActionChildren

void getCodeActionChildren(java.lang.String vocabularyName,
                           java.lang.String conceptCode,
                           java.lang.String baseLineDate,
                           java.lang.String action)
Gets child concept codes for the specified concept.

Parameters:
vocabularyName -
conceptCode -
baseLineDate -
action -

getCodeActionParents

void getCodeActionParents(java.lang.String vocabularyName,
                          java.lang.String conceptCode,
                          java.lang.String baseLineDate)
Gets parent concept codes for the specified concept.

Parameters:
vocabularyName -
conceptCode -
baseLineDate -

getSourcebyCode

void getSourcebyCode(java.lang.String vocabularyName,
                     java.lang.String conceptCode)
Gets source for the specified concept.

Parameters:
vocabularyName -
conceptCode -

getAssociationCollectionbyCode

void getAssociationCollectionbyCode(java.lang.String vocabularyName,
                                    java.lang.String conceptCode)
Gets associations for the specified concept.

Parameters:
vocabularyName -
conceptCode -

getTreeNodebyCode

void getTreeNodebyCode(java.lang.String vocabularyName,
                       java.lang.String conceptCode)
Gets TreeNode for the specified concept.

Parameters:
vocabularyName -
conceptCode -

getEdgePropertiesbyCode

void getEdgePropertiesbyCode(java.lang.String vocabularyName,
                             java.lang.String conceptCode)
Gets get Semantic Types for the specified concept.

Parameters:
conceptCode -

getSemanticTypeVectorbyCode

void getSemanticTypeVectorbyCode(java.lang.String vocabularyName,
                                 java.lang.String cui)

getSemanticTypeCollectionbyCui

void getSemanticTypeCollectionbyCui(java.lang.String cui)

getSynonymCollectionbyCui

void getSynonymCollectionbyCui(java.lang.String cui)

getQualifierCollectionbyName

void getQualifierCollectionbyName(java.lang.String name)

getAtomCollectionbyCui

void getAtomCollectionbyCui(java.lang.String cui)

getSourceCollectionbyCui

void getSourceCollectionbyCui(java.lang.String cui)

getSourcebyDefinition

void getSourcebyDefinition(java.lang.String definition)

getDefinitionCollectionbyCui

void getDefinitionCollectionbyCui(java.lang.String cui)

getHistoryCollectionbyDescLogicConceptCode

void getHistoryCollectionbyDescLogicConceptCode(java.lang.String descLogicConceptCode)

getSiloCollectionbyName

void getSiloCollectionbyName(java.lang.String name)

getSecurityTokenbyName

void getSecurityTokenbyName(java.lang.String name)

getPropertyCollectionbyName

void getPropertyCollectionbyName(java.lang.String name)

getPropertyCollectionbyCode

void getPropertyCollectionbyCode(java.lang.String vocabularyName,
                                 java.lang.String conceptCode)

getRoleCollectionbyCode

void getRoleCollectionbyCode(java.lang.String vocabularyName,
                             java.lang.String conceptCode)

getInverseRoleCollectionbyCode

void getInverseRoleCollectionbyCode(java.lang.String vocabularyName,
                                    java.lang.String conceptCode)

getInverseAssociationCollectionbyCode

void getInverseAssociationCollectionbyCode(java.lang.String vocabularyName,
                                           java.lang.String conceptCode)

getVocabularybyCode

void getVocabularybyCode(java.lang.String vocabularyName,
                         java.lang.String conceptCode)

getHasParentsbyCode

void getHasParentsbyCode(java.lang.String vocabularyName,
                         java.lang.String cui)

getHasChildrenbyCode

void getHasChildrenbyCode(java.lang.String vocabularyName,
                          java.lang.String cui)

getHistoryRecordbyCode

void getHistoryRecordbyCode(java.lang.String vocabularyName,
                            java.lang.String conceptCode)


Copyright © 2007 National Cancer Institute (NCI). All Rights Reserved.