edu.emory.cci.aiw.cvrg.eureka.common.comm.clients

Class EtlClient

java.lang.Object

org.eurekaclinical.common.comm.clients.EurekaClinicalClient

edu.emory.cci.aiw.cvrg.eureka.common.comm.clients.EurekaClient

edu.emory.cci.aiw.cvrg.eureka.common.comm.clients.EtlClient

All Implemented Interfaces:

AutoCloseable

public class EtlClient
extends EurekaClient

Author:

hrathod

Constructor Summary

Constructors

Constructor and Description
EtlClient(String inEtlUrl)

Method Summary

Modifier and Type	Method and Description
Long	createDestination(EtlDestination etlDest)
void	deleteDestination(String etlDestId)
void	deleteOutput(String destinationId)
List<EtlCohortDestination>	getCohortDestinations()
EtlDestination	getDestination(String destId)
List<EtlDestination>	getDestinations()
List<EtlI2B2Destination>	getI2B2Destinations()
org.eurekaclinical.eureka.client.comm.Job	getJob(Long inJobId)
List<org.eurekaclinical.eureka.client.comm.Job>	getJobs()
List<org.eurekaclinical.eureka.client.comm.Job>	getJobsDesc()
org.eurekaclinical.eureka.client.comm.Statistics	getJobStats(Long inJobId, String inPropId)
List<org.eurekaclinical.eureka.client.comm.Job>	getJobStatus(org.eurekaclinical.eureka.client.comm.JobFilter inFilter)
List<org.eurekaclinical.eureka.client.comm.Job>	getLatestJob()
com.sun.jersey.api.client.ClientResponse	getOutput(String destinationId)
List<EtlPatientSetExtractorDestination>	getPatientSetExtractorDestinations()
List<EtlPatientSetSenderDestination>	getPatientSetSenderDestinations()
org.protempa.PropositionDefinition	getPropositionDefinition(String sourceConfigId, String inKey) Gets a proposition definition with a specified id for a specified user.
List<org.protempa.PropositionDefinition>	getPropositionDefinitions(String sourceConfigId, List<String> inKeys, Boolean withChildren) Gets all of the proposition definitions given by the key IDs for the given user.
List<String>	getPropositionSearchResults(String sourceConfigId, String inSearchKey)
List<org.protempa.PropositionDefinition>	getPropositionSearchResultsBySearchKey(String sourceConfigId, String inSearchKey)
protected URI	getResourceUrl()
org.eurekaclinical.common.comm.Role	getRole(Long inRoleId)
org.eurekaclinical.common.comm.Role	getRoleByName(String name)
List<org.eurekaclinical.common.comm.Role>	getRoles()
org.eurekaclinical.eureka.client.comm.SourceConfig	getSourceConfig(String sourceConfigId)
List<org.eurekaclinical.eureka.client.comm.SourceConfig>	getSourceConfigs()
List<EtlTabularFileDestination>	getTabularFileDestinations()
Long	submitJob(JobRequest inJobRequest)
void	updateDestination(EtlDestination etlDest)
void	upload(String fileName, String sourceId, String fileTypeId, InputStream inputStream)
void	validatePropositions(ValidationRequest inRequest)

Methods inherited from class org.eurekaclinical.common.comm.clients.EurekaClinicalClient

close, doDelete, doDelete, doDeleteForProxy, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGet, doGetForProxy, doGetResponse, doGetResponse, doPost, doPost, doPost, doPost, doPost, doPost, doPost, doPostCreate, doPostCreate, doPostCreateMultipart, doPostCreateMultipart, doPostCreateMultipart, doPostForm, doPostForm, doPostForProxy, doPostMultipart, doPostMultipart, doPostMultipart, doPostMultipart, doPut, doPut, doPut, doPutForProxy, errorIfStatusEqualTo, errorIfStatusNotEqualTo, extractId

Methods inherited from class java.lang.Object

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

Constructor Detail

EtlClient

@Inject
public EtlClient(String inEtlUrl)

Method Detail

getResourceUrl

protected URI getResourceUrl()

Specified by:

getResourceUrl in class org.eurekaclinical.common.comm.clients.EurekaClinicalClient

getSourceConfigs

public List<org.eurekaclinical.eureka.client.comm.SourceConfig> getSourceConfigs()
                                                                          throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getSourceConfig

public org.eurekaclinical.eureka.client.comm.SourceConfig getSourceConfig(String sourceConfigId)
                                                                   throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getDestinations

public List<EtlDestination> getDestinations()
                                     throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getCohortDestinations

public List<EtlCohortDestination> getCohortDestinations()
                                                 throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getI2B2Destinations

public List<EtlI2B2Destination> getI2B2Destinations()
                                             throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getPatientSetExtractorDestinations

public List<EtlPatientSetExtractorDestination> getPatientSetExtractorDestinations()
                                                                           throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getPatientSetSenderDestinations

public List<EtlPatientSetSenderDestination> getPatientSetSenderDestinations()
                                                                     throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getTabularFileDestinations

public List<EtlTabularFileDestination> getTabularFileDestinations()
                                                           throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getDestination

public EtlDestination getDestination(String destId)
                              throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

createDestination

public Long createDestination(EtlDestination etlDest)
                       throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

updateDestination

public void updateDestination(EtlDestination etlDest)
                       throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

deleteDestination

public void deleteDestination(String etlDestId)
                       throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

submitJob

public Long submitJob(JobRequest inJobRequest)
               throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getJobStatus

public List<org.eurekaclinical.eureka.client.comm.Job> getJobStatus(org.eurekaclinical.eureka.client.comm.JobFilter inFilter)
                                                             throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getJobs

public List<org.eurekaclinical.eureka.client.comm.Job> getJobs()
                                                        throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getJobsDesc

public List<org.eurekaclinical.eureka.client.comm.Job> getJobsDesc()
                                                            throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getLatestJob

public List<org.eurekaclinical.eureka.client.comm.Job> getLatestJob()
                                                             throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getJob

public org.eurekaclinical.eureka.client.comm.Job getJob(Long inJobId)
                                                 throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getJobStats

public org.eurekaclinical.eureka.client.comm.Statistics getJobStats(Long inJobId,
                                                                    String inPropId)
                                                             throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

validatePropositions

public void validatePropositions(ValidationRequest inRequest)
                          throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getPropositionDefinition

public org.protempa.PropositionDefinition getPropositionDefinition(String sourceConfigId,
                                                                   String inKey)
                                                            throws org.eurekaclinical.common.comm.clients.ClientException

Gets a proposition definition with a specified id for a specified user.

Parameters:

sourceConfigId - the source config id of interest.

inKey - the proposition id of interest.

Returns:

the proposition id, if found, or null if not.

Throws:

org.eurekaclinical.common.comm.clients.ClientException - if an error occurred looking for the proposition definition.

getPropositionDefinitions

public List<org.protempa.PropositionDefinition> getPropositionDefinitions(String sourceConfigId,
                                                                          List<String> inKeys,
                                                                          Boolean withChildren)
                                                                   throws org.eurekaclinical.common.comm.clients.ClientException

Gets all of the proposition definitions given by the key IDs for the given user.

Parameters:

sourceConfigId - the ID of the source configuration to use

inKeys - the keys (IDs) of the proposition definitions to get

withChildren - whether to get the children of specified proposition definitions as well

Returns:

a List of PropositionDefinitions

Throws:

org.eurekaclinical.common.comm.clients.ClientException - if an error occurred looking for the proposition definitions

upload

public void upload(String fileName,
                   String sourceId,
                   String fileTypeId,
                   InputStream inputStream)
            throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getPropositionSearchResults

public List<String> getPropositionSearchResults(String sourceConfigId,
                                                String inSearchKey)
                                         throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getPropositionSearchResultsBySearchKey

public List<org.protempa.PropositionDefinition> getPropositionSearchResultsBySearchKey(String sourceConfigId,
                                                                                       String inSearchKey)
                                                                                throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getOutput

public com.sun.jersey.api.client.ClientResponse getOutput(String destinationId)
                                                   throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

deleteOutput

public void deleteOutput(String destinationId)
                  throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getRoles

public List<org.eurekaclinical.common.comm.Role> getRoles()
                                                   throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getRole

public org.eurekaclinical.common.comm.Role getRole(Long inRoleId)
                                            throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getRoleByName

public org.eurekaclinical.common.comm.Role getRoleByName(String name)
                                                  throws org.eurekaclinical.common.comm.clients.ClientException

Throws:

org.eurekaclinical.common.comm.clients.ClientException