2.8.0: 2008-09-08

net.sf.basedb.ws.client
Class BioAssaySetClient

java.lang.Object
  extended by net.sf.basedb.ws.client.AbstractRPCClient
      extended by net.sf.basedb.ws.client.BioAssaySetClient

public class BioAssaySetClient
extends AbstractRPCClient

Web service client for BioAssaySetService in BASE. BioAssaySetService

Version:
2.5
Author:
Martin

Field Summary
private  SessionClient session
           
 
Constructor Summary
BioAssaySetClient(SessionClient session)
          Creates new BioAssayClient for a session.
 
Method Summary
 InputStream downloadBioAssaySet(int bioAssaySetId, String format, String[] reporterFields, String[] spotFields, boolean mergeReporters)
          Call the service in BioAssaySetService that exports a bioassay set and then sends it as a file.
 String[] getExportFormats()
          Calls the BioAssaySetService and gets the available formats to export a BioAssaySet from BASE in.
 
Methods inherited from class net.sf.basedb.ws.client.AbstractRPCClient
getOperation, getService, getServiceFactory, invokeBlocking, invokeBlocking, invokeBlocking, invokeFileBlocking, setServiceFactory
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

session

private final SessionClient session
Constructor Detail

BioAssaySetClient

public BioAssaySetClient(SessionClient session)
Creates new BioAssayClient for a session.

Parameters:
session - Active session.
Method Detail

getExportFormats

public String[] getExportFormats()
                          throws org.apache.axis2.AxisFault
Calls the BioAssaySetService and gets the available formats to export a BioAssaySet from BASE in.

Returns:
An array with the formats.
Throws:
org.apache.axis2.AxisFault - If communication with the service fails.

downloadBioAssaySet

public InputStream downloadBioAssaySet(int bioAssaySetId,
                                       String format,
                                       String[] reporterFields,
                                       String[] spotFields,
                                       boolean mergeReporters)
                                throws org.apache.axis2.AxisFault,
                                       IOException
Call the service in BioAssaySetService that exports a bioassay set and then sends it as a file.

Parameters:
bioAssaySetId - Id of the bioAssay set to export
format - Export format to use when exporting the bioassay set
reporterFields - Reporter fields to include in the export
spotFields - Spot fields to include in the export
mergeReporters - If the reporters should be merged or not.
Returns:
An InputStream to read the file data from
Throws:
org.apache.axis2.AxisFault - If communication with services fails.
IOException - If accessing the file files.

2.8.0: 2008-09-08