de.sekmi.li2b2.client.crc

Class QueryClient

java.lang.Object

de.sekmi.li2b2.client.CellClient

de.sekmi.li2b2.client.crc.QueryClient

public class QueryClient
extends CellClient

Field Summary

Fields

Modifier and Type	Field and Description
static String	PSM_NS

Fields inherited from class de.sekmi.li2b2.client.CellClient

client, serviceUrl

Constructor Summary

Constructors

Constructor and Description
QueryClient(Li2b2Client client, URL serviceUrl)

Method Summary

Modifier and Type	Method and Description
void	deleteQueryMaster(String masterId)
List<QueryInstance>	getQueryInstanceList(String masterId) Retrieve query executions (instances) for the given query master id
List<QueryMaster>	getQueryMasterList() Retrieve previous queries for the current user and project.
List<QueryMaster>	getQueryMasterList(String userId, String groupId, int fetchSize) Retrieve previous queries.
List<QueryResultInstance>	getQueryResultInstanceList(String instanceId)
String	getResultDocument(String query_result_instance_id) Retrieve the result document for the given result id.
List<QueryResultType>	getResultType()
MasterInstanceResult	runQueryInstance(Element query_definition, String[] result_output_list)

Methods inherited from class de.sekmi.li2b2.client.CellClient

appendOptionalElement, appendTextElement, createConnection, createRequest, createRequestMessage, createRequestMessage, createRequestMessage, getOutputCharset, getServiceURL, newBuilder, submitRequest, submitRequest, submitRequestWithResponseContent

Methods inherited from class java.lang.Object

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

Field Detail

PSM_NS

public static final String PSM_NS

See Also:

Constant Field Values

Constructor Detail

QueryClient

public QueryClient(Li2b2Client client,
                   URL serviceUrl)

Method Detail

getResultType

public List<QueryResultType> getResultType()
                                    throws HiveException

Throws:

HiveException

runQueryInstance

public MasterInstanceResult runQueryInstance(Element query_definition,
                                             String[] result_output_list)
                                      throws HiveException

Throws:

HiveException

getQueryMasterList

public List<QueryMaster> getQueryMasterList(String userId,
                                            String groupId,
                                            int fetchSize)
                                     throws HiveException

Retrieve previous queries.

Parameters:

userId - user id

groupId - group id. usually the project id.

fetchSize - maximum number of queries to return

Returns:

query list

Throws:

HiveException - communications error

getQueryMasterList

public List<QueryMaster> getQueryMasterList()
                                     throws HiveException

Retrieve previous queries for the current user and project. The list is limited to 20 queries. For more control over the request, see getQueryMasterList(String, String, int).

Returns:

previous queries

Throws:

HiveException - error

getQueryInstanceList

public List<QueryInstance> getQueryInstanceList(String masterId)
                                         throws HiveException

Retrieve query executions (instances) for the given query master id

Parameters:

masterId - query master id

Returns:

list of executions/instances

Throws:

HiveException - error

getQueryResultInstanceList

public List<QueryResultInstance> getQueryResultInstanceList(String instanceId)
                                                     throws HiveException

Throws:

HiveException

deleteQueryMaster

public void deleteQueryMaster(String masterId)
                       throws HiveException

Throws:

HiveException

getResultDocument

public String getResultDocument(String query_result_instance_id)
                         throws HiveException

Retrieve the result document for the given result id. A document is only available for some result types. Typically those with a display type CATNUM.

Parameters:

query_result_instance_id - result id

Returns:

String result document Usually XML document with root element i2b2_result_envelope in namespace http://www.i2b2.org/xsd/hive/msg/result/1.1/

Throws:

HiveException - error