edu.emory.cci.aiw.cvrg.eureka.services.config

Interface EtlClient

All Known Implementing Classes:

EtlClientImpl

public interface EtlClient

Author:

Andrew Post

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() gets the latest job submitted by the logged in user
com.sun.jersey.api.client.ClientResponse	getOutput(String destinationId)
List<EtlPatientSetExtractorDestination>	getPatientSetExtractorDestinations()
org.protempa.PropositionDefinition	getPropositionDefinition(String sourceConfigId, String inKey) Gets a proposition definition with a specified id for a source configuration.
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 source configuration.
List<String>	getPropositionSearchResults(String sourceConfigID, String inSearchKey)
List<org.protempa.PropositionDefinition>	getPropositionSearchResultsBySearchKey(String sourceConfigID, String inSearchKey)
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()
Long	submitJob(JobRequest inJobRequest)
void	updateDestination(EtlDestination etlDest)
void	upload(String fileName, String sourceId, String fileTypeId, InputStream inputStream)
void	validatePropositions(ValidationRequest inRequest)

Method Detail

getDestination

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

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getCohortDestinations

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

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getI2B2Destinations

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

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getPatientSetExtractorDestinations

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

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getDestinations

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

Throws:

org.eurekaclinical.common.comm.clients.ClientException

createDestination

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

Throws:

org.eurekaclinical.common.comm.clients.ClientException

updateDestination

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

Throws:

org.eurekaclinical.common.comm.clients.ClientException

deleteDestination

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

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getJob

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

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getJobStats

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

getJobStatus

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

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

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getPropositionDefinition

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 source configuration.

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

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 source configuration.

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

getSourceConfig

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

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getSourceConfigs

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

Throws:

org.eurekaclinical.common.comm.clients.ClientException

submitJob

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

Throws:

org.eurekaclinical.common.comm.clients.ClientException

upload

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

Throws:

org.eurekaclinical.common.comm.clients.ClientException

validatePropositions

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

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getJobsDesc

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

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getPropositionSearchResults

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

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getPropositionSearchResultsBySearchKey

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

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getOutput

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

Throws:

org.eurekaclinical.common.comm.clients.ClientException

deleteOutput

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

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getLatestJob

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

gets the latest job submitted by the logged in user

Returns:

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getRoles

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

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getRole

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

Throws:

org.eurekaclinical.common.comm.clients.ClientException

getRoleByName

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

Throws:

org.eurekaclinical.common.comm.clients.ClientException