com.apothesource.pillfill.rxnorm.service.ndfrt

Class NihNdfrtServiceProxy

java.lang.Object

com.apothesource.pillfill.rxnorm.service.ndfrt.NihNdfrtServiceProxy

All Implemented Interfaces:

NdfrtService

public class NihNdfrtServiceProxy
extends java.lang.Object
implements NdfrtService

Default implementation of NdfrtService backed by the live NIH services. http://rxnav.nlm.nih.gov/NdfrtAPIs.html# Created by Michael Ramirez (michael@pillfill.com) on 7/17/15.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	URL_ALL_CONCEPTS_TEMPLATE
static java.lang.String	URL_ALL_TEMPLATE
static java.lang.String	URL_ASSOCIATION_TEMPLATE
static java.lang.String	URL_BASE
static java.lang.String	URL_CHILDREN_TEMPLATE
static java.lang.String	URL_EPCC_TEMPLATE
static java.lang.String	URL_ID_TEMPLATE
static java.lang.String	URL_PARENTS_TEMPLATE
static java.lang.String	URL_PROPERTY_TEMPLATE
static java.lang.String	URL_REVERSE_ROLE_TEMPLATE
static java.lang.String	URL_ROLE_TEMPLATE
static java.lang.String	URL_SEARCH_NAME_TEMPLATE
static java.lang.String	URL_SEARCH_PROPERTY_TEMPLATE
static java.lang.String	URL_VA_TEMPLATE
static java.lang.String	URL_VAMEMBER_TEMPLATE
static java.lang.String	URL_VERSION

Constructor Summary

Constructors

Constructor and Description
NihNdfrtServiceProxy()

Method Summary

Modifier and Type	Method and Description
GroupConceptResponse	findConceptsByID(IdTypeNames idType, java.lang.String idString) Find the concepts from a given identifier.
GroupConceptResponse	findConceptsByName(java.lang.String conceptName, KindNames kindName) Get the concept identfier given a concept name and kind.
void	getAllConceptsByKind(java.util.List<KindNames> kinds, ConceptHandler handler) Gnarly stream parsing of concept list.
FullConceptResponse	getAllInfo(java.lang.String nui) This resource returns concept information for a specified concept.
GroupConceptResponse	getChildConcepts(java.lang.String nui, java.lang.Boolean transitive) Get the child concepts of a specified concept http://rxnav.nlm.nih.gov/NdfrtAPIs.html#uLink=Ndfrt_REST_getChildConcepts
GroupPropertyResponse	getConceptProperties(java.lang.String nui, PropertyNames propertyName) Get the property values for a specified concept and property http://rxnav.nlm.nih.gov/NdfrtAPIs.html#uLink=Ndfrt_REST_getConceptProperties
GroupConceptResponse	getConceptsByProperty(PropertyNames propertyName, java.lang.String propertyValue) Get the concepts that contain the specified property name and value http://rxnav.nlm.nih.gov/NdfrtAPIs.html#uLink=Ndfrt_REST_getConceptsByProperty
GroupConceptResponse	getEPCClassOfConcept(java.lang.String nui) Get the FDA Established Pharmacologic classes (EPC) for a specified drug.
VersionResponse	getNdfrtVersion() Get the date for the last update of the underlying NDFRT data
GroupConceptResponse	getParentConcepts(java.lang.String nui, java.lang.Boolean transitive) Get the parent concepts of a specified concept http://rxnav.nlm.nih.gov/NdfrtAPIs.html#uLink=Ndfrt_REST_getParentConcepts
GroupAssociationResponse	getRelatedConceptsByAssociation(java.lang.String nui, AssociationNames assocName) Get the associations for a specified concept
GroupConceptResponse	getRelatedConceptsByReverseRole(java.lang.String nui, RoleNames roleName, java.lang.Boolean transitive) Get the concepts related to the specified object concept by role.
GroupConceptResponse	getRelatedConceptsByRole(java.lang.String nui, RoleNames roleName, java.lang.Boolean transitive) Get the concepts related to the specified concept by role.
protected <T> T	getResponseFromNihServer(java.lang.Class<T> classType, java.lang.String template, java.lang.String[] parameters)
protected <T> T	getResponseFromNihServer(java.net.URL url, java.lang.Class<T> classType)
GroupConceptResponse	getVAClassMembers(java.lang.String nui) Get the members of a VA class
ConceptListResponse	getVAClassOfConcept(java.lang.String nui) Get the VA class of a specified concept

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

URL_BASE

public static final java.lang.String URL_BASE

See Also:

Constant Field Values

URL_ALL_CONCEPTS_TEMPLATE

public static final java.lang.String URL_ALL_CONCEPTS_TEMPLATE

See Also:

Constant Field Values

URL_ID_TEMPLATE

public static final java.lang.String URL_ID_TEMPLATE

See Also:

Constant Field Values

URL_SEARCH_NAME_TEMPLATE

public static final java.lang.String URL_SEARCH_NAME_TEMPLATE

See Also:

Constant Field Values

URL_ALL_TEMPLATE

public static final java.lang.String URL_ALL_TEMPLATE

See Also:

Constant Field Values

URL_CHILDREN_TEMPLATE

public static final java.lang.String URL_CHILDREN_TEMPLATE

See Also:

Constant Field Values

URL_PARENTS_TEMPLATE

public static final java.lang.String URL_PARENTS_TEMPLATE

See Also:

Constant Field Values

URL_SEARCH_PROPERTY_TEMPLATE

public static final java.lang.String URL_SEARCH_PROPERTY_TEMPLATE

See Also:

Constant Field Values

URL_PROPERTY_TEMPLATE

public static final java.lang.String URL_PROPERTY_TEMPLATE

See Also:

Constant Field Values

URL_REVERSE_ROLE_TEMPLATE

public static final java.lang.String URL_REVERSE_ROLE_TEMPLATE

See Also:

Constant Field Values

URL_ROLE_TEMPLATE

public static final java.lang.String URL_ROLE_TEMPLATE

See Also:

Constant Field Values

URL_ASSOCIATION_TEMPLATE

public static final java.lang.String URL_ASSOCIATION_TEMPLATE

See Also:

Constant Field Values

URL_EPCC_TEMPLATE

public static final java.lang.String URL_EPCC_TEMPLATE

See Also:

Constant Field Values

URL_VAMEMBER_TEMPLATE

public static final java.lang.String URL_VAMEMBER_TEMPLATE

See Also:

Constant Field Values

URL_VA_TEMPLATE

public static final java.lang.String URL_VA_TEMPLATE

See Also:

Constant Field Values

URL_VERSION

public static final java.lang.String URL_VERSION

See Also:

Constant Field Values

Constructor Detail

NihNdfrtServiceProxy

public NihNdfrtServiceProxy()

Method Detail

findConceptsByID

public GroupConceptResponse findConceptsByID(IdTypeNames idType,
                                             java.lang.String idString)
                                      throws java.io.IOException

Description copied from interface: NdfrtService

Find the concepts from a given identifier. http://rxnav.nlm.nih.gov/NdfrtAPIs.html#uLink=Ndfrt_REST_findConceptsByID

Specified by:

findConceptsByID in interface NdfrtService

Parameters:

idType - - the type of identifier. See /typeList for valid identifier types.

idString - - the value of the identifier

Throws:

java.io.IOException

getAllInfo

public FullConceptResponse getAllInfo(java.lang.String nui)
                               throws java.io.IOException

Description copied from interface: NdfrtService

This resource returns concept information for a specified concept. http://rxnav.nlm.nih.gov/NdfrtAPIs.html#uLink=Ndfrt_REST_getAllInfo

Specified by:

getAllInfo in interface NdfrtService

Parameters:

nui - - the ndfrt identifier for the concept

Returns:

The concept associated with this NUI

Throws:

java.io.IOException

findConceptsByName

public GroupConceptResponse findConceptsByName(java.lang.String conceptName,
                                               KindNames kindName)
                                        throws java.io.IOException

Description copied from interface: NdfrtService

Get the concept identfier given a concept name and kind. The name must match the NDF-RT name or one of its synonyms. http://rxnav.nlm.nih.gov/NdfrtAPIs.html#uLink=Ndfrt_REST_findConceptsByName

Specified by:

findConceptsByName in interface NdfrtService

Parameters:

conceptName - - the name of the concept

kindName - - (optional) the kind value. If not specified, all kinds are returned. See getKindList for valid values.

Throws:

java.io.IOException

getChildConcepts

public GroupConceptResponse getChildConcepts(java.lang.String nui,
                                             java.lang.Boolean transitive)
                                      throws java.io.IOException

Description copied from interface: NdfrtService

Get the child concepts of a specified concept http://rxnav.nlm.nih.gov/NdfrtAPIs.html#uLink=Ndfrt_REST_getChildConcepts

Specified by:

getChildConcepts in interface NdfrtService

Parameters:

nui - the NDF-RT identifier

transitive - (optional, default: false) if false, then only direct child concepts are returned. If true, return all descendant concepts.

Returns:

The list of descendant concepts

Throws:

java.io.IOException - if errors occur communicating with the service

getParentConcepts

public GroupConceptResponse getParentConcepts(java.lang.String nui,
                                              java.lang.Boolean transitive)
                                       throws java.io.IOException

Description copied from interface: NdfrtService

Get the parent concepts of a specified concept http://rxnav.nlm.nih.gov/NdfrtAPIs.html#uLink=Ndfrt_REST_getParentConcepts

Specified by:

getParentConcepts in interface NdfrtService

Parameters:

nui - the NDF-RT identifier

transitive - (optional, default: false) if false, then only direct child concepts are returned. If true, return all ancestor concepts.

Returns:

The list of descendant concepts

Throws:

java.io.IOException - if errors occur communicating with the service

getConceptProperties

public GroupPropertyResponse getConceptProperties(java.lang.String nui,
                                                  PropertyNames propertyName)
                                           throws java.io.IOException

Description copied from interface: NdfrtService

Get the property values for a specified concept and property http://rxnav.nlm.nih.gov/NdfrtAPIs.html#uLink=Ndfrt_REST_getConceptProperties

Specified by:

getConceptProperties in interface NdfrtService

Parameters:

nui - the NDF-RT identifier

propertyName - (optional) the property name. If not specified, all concept properties are returned. See /propertyList example for valid property names

Returns:

The named properties associated with this concept

Throws:

java.io.IOException - if errors occur communicating with the service

getConceptsByProperty

public GroupConceptResponse getConceptsByProperty(PropertyNames propertyName,
                                                  java.lang.String propertyValue)
                                           throws java.io.IOException

Description copied from interface: NdfrtService

Get the concepts that contain the specified property name and value http://rxnav.nlm.nih.gov/NdfrtAPIs.html#uLink=Ndfrt_REST_getConceptsByProperty

Specified by:

getConceptsByProperty in interface NdfrtService

Parameters:

propertyName - name of the property. See /propertyList example for valid property names.

propertyValue - the property value

Returns:

The list of concepts matching the provided property

Throws:

java.io.IOException - if errors occur communicating with the service

getRelatedConceptsByReverseRole

public GroupConceptResponse getRelatedConceptsByReverseRole(java.lang.String nui,
                                                            RoleNames roleName,
                                                            java.lang.Boolean transitive)
                                                     throws java.io.IOException

Description copied from interface: NdfrtService

Get the concepts related to the specified object concept by role. In NDF-RT, the relations between two concepts are defined by roles and are one directional. For example, "Fenofibrate" "may_treat" "Arteriosclerosis" is an example of a relationship in NDF-RT where the role "may_treat" is the relationship between the drug "Fenofibrate" (the subject) and the disease "Arteriosclerosis" (the object). To determine which diseases the drug "Fenofibrate" "may_treat", the resource here specifies the subject and the role. This resource allows the reverse direction, specifying the object and the role. In the example above, this means finding the drugs that "may_treat" "Arteriosclerosis".

Specified by:

getRelatedConceptsByReverseRole in interface NdfrtService

Parameters:

nui - the NDF-RT identifier of the object of the role

roleName - the role. See /roleList example for valid role names.

transitive - (default:false) if false, then only the concepts directly associated with the role are returned. If true, the concepts directly associated with the role along with the descendants of these concepts are returned.

Returns:

The list of concepts

Throws:

java.io.IOException

getRelatedConceptsByRole

public GroupConceptResponse getRelatedConceptsByRole(java.lang.String nui,
                                                     RoleNames roleName,
                                                     java.lang.Boolean transitive)
                                              throws java.io.IOException

Description copied from interface: NdfrtService

Get the concepts related to the specified concept by role. In NDF-RT, the relations between two concepts are defined by roles and are one directional. For example, "Fenofibrate" "may_treat" "Arteriosclerosis" is an example of a relationship in NDF-RT where the role "may_treat" is the relationship between the drug "Fenofibrate" (the subject) and the disease "Arteriosclerosis" (the object). To determine which diseases the drug "Fenofibrate" "may_treat", this function specifies the subject and the role. NdfrtService.getRelatedConceptsByReverseRole(java.lang.String, com.apothesource.pillfill.rxnorm.datamodel.ndf.RoleNames, java.lang.Boolean) allows the reverse direction, by specifying the object and the role. In the example above, this means finding the drugs that "may_treat" "Arteriosclerosis".

Specified by:

getRelatedConceptsByRole in interface NdfrtService

Parameters:

nui - the NDF-RT identifier of the object of the role

roleName - the role. See /roleList example for valid role names.

transitive - (default:false) if false, then only the concepts directly associated with the role are returned. If true, the concepts directly associated with the role and the descendants of these concepts are returned.

Returns:

The list of concepts

Throws:

java.io.IOException

getRelatedConceptsByAssociation

public GroupAssociationResponse getRelatedConceptsByAssociation(java.lang.String nui,
                                                                AssociationNames assocName)
                                                         throws java.io.IOException

Description copied from interface: NdfrtService

Get the associations for a specified concept

Specified by:

getRelatedConceptsByAssociation in interface NdfrtService

Parameters:

nui - the NDF-RT concept identifier

assocName - (optional) the association name. If not specified, then all associations are returned for the concept. See getAssociationList for valid values.

Returns:

An array of association structures. Each association structure contains: Association name, Concept identifier (NUI) of the object of the association

Throws:

java.io.IOException

getEPCClassOfConcept

public GroupConceptResponse getEPCClassOfConcept(java.lang.String nui)
                                          throws java.io.IOException

Description copied from interface: NdfrtService

Get the FDA Established Pharmacologic classes (EPC) for a specified drug. The specified drug must be an NDF-RT unique identifier (NUI) of a DRUG_KIND concept.

Specified by:

getEPCClassOfConcept in interface NdfrtService

Parameters:

nui - the NDF-RT identifier

Returns:

a list of concepts in this class

Throws:

java.io.IOException

getVAClassMembers

public GroupConceptResponse getVAClassMembers(java.lang.String nui)
                                       throws java.io.IOException

Description copied from interface: NdfrtService

Get the members of a VA class

Specified by:

getVAClassMembers in interface NdfrtService

Parameters:

nui - the NDF-RT identifier

Returns:

a list of concepts in this class

Throws:

java.io.IOException

getVAClassOfConcept

public ConceptListResponse getVAClassOfConcept(java.lang.String nui)
                                        throws java.io.IOException

Description copied from interface: NdfrtService

Get the VA class of a specified concept

Specified by:

getVAClassOfConcept in interface NdfrtService

Parameters:

nui - the NDF-RT identifier. The identifier must be for a concept that is a VA product (Level = "VA Product")

Returns:

a list of concepts in this class

Throws:

java.io.IOException

getNdfrtVersion

public VersionResponse getNdfrtVersion()
                                throws java.io.IOException

Description copied from interface: NdfrtService

Get the date for the last update of the underlying NDFRT data

Specified by:

getNdfrtVersion in interface NdfrtService

Returns:

A date

Throws:

java.io.IOException

getAllConceptsByKind

public void getAllConceptsByKind(java.util.List<KindNames> kinds,
                                 ConceptHandler handler)

Gnarly stream parsing of concept list. TODO: Create a cleaner, reusable stream parser

Specified by:

getAllConceptsByKind in interface NdfrtService

Parameters:

kinds - one or more Kind identifiers. See /kindList example for valid values.

handler - A handler to receive concepts as they are retrieved (to minimize memory overhead vs. a single list object)

getResponseFromNihServer

protected <T> T getResponseFromNihServer(java.lang.Class<T> classType,
                                         java.lang.String template,
                                         java.lang.String[] parameters)
                                  throws java.io.IOException

Throws:

java.io.IOException

getResponseFromNihServer

protected <T> T getResponseFromNihServer(java.net.URL url,
                                         java.lang.Class<T> classType)
                                  throws java.io.IOException

Throws:

java.io.IOException