3.1.2: 2012-07-31

net.sf.basedb.ws.client
Class ArrayDesignClient

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

public class ArrayDesignClient
extends AbstractRPCClient

A web service client for array design in BASE. This class supports all services in ArrayDesignService

Version:
2.5
Author:
Martin

Field Summary
private  SessionClient session
           
 
Constructor Summary
ArrayDesignClient(SessionClient session)
          Creates a new client object for a session.
 
Method Summary
 ArrayDesignInfo[] getArrayDesigns(QueryOptions qOpt)
          Gets info about array designs that are available in the logged in session.
 ArrayDesignInfo getById(int itemId)
          Get info about an array design when you know the ID.
 FileSetMemberInfo[] getDataFiles(int arrayDesignId, QueryOptions qOpt)
          Returns information about data files that are used storing feature information for an array design.
 DataFileTypeInfo[] getDataFileTypes(int arrayDesignId, QueryOptions qOpt)
          Gets the datafile types that is used to store an array design.
 Boolean hasDownloadableData(int arrayDesignId)
          Gets if data in an array design can be downloaded as a file or not.
 InputStream xdownloadArrayDesignByType(int arrayDesignId, String dataFileType)
          Downloads an arraydesign as a file, if it is stored as a file in BASE.
 
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 SessionClient session
Constructor Detail

ArrayDesignClient

public ArrayDesignClient(SessionClient session)
Creates a new client object for a session.

Parameters:
session -
Method Detail

getById

public ArrayDesignInfo getById(int itemId)
                        throws org.apache.axis2.AxisFault
Get info about an array design when you know the ID.

Parameters:
itemId - The ID of the array design
Returns:
An ArrayDesignInfo object
Throws:
org.apache.axis2.AxisFault - If communication with web service fails.

getArrayDesigns

public ArrayDesignInfo[] getArrayDesigns(QueryOptions qOpt)
                                  throws org.apache.axis2.AxisFault
Gets info about array designs that are available in the logged in session.

Parameters:
qOpt - Options to put on the query
Returns:
An array with info object for each array design that was found.
Throws:
org.apache.axis2.AxisFault - If communication with web service fails.

xdownloadArrayDesignByType

public InputStream xdownloadArrayDesignByType(int arrayDesignId,
                                              String dataFileType)
                                       throws IOException
Downloads an arraydesign as a file, if it is stored as a file in BASE.

Parameters:
arrayDesignId - The array design's id.
dataFileType - The external ID of the data file type to download
Returns:
An InputStream to read the file data from, or null if no file of the specified type exists
Throws:
IOException - If writing to the file fails.

getDataFileTypes

public DataFileTypeInfo[] getDataFileTypes(int arrayDesignId,
                                           QueryOptions qOpt)
                                    throws org.apache.axis2.AxisFault
Gets the datafile types that is used to store an array design.

Parameters:
arrayDesignId - The array design's id
qOpt - Restrictions and includes to put on a query when getting the types.
Returns:
An array with a DataFileTypeInfo for each found data file type.
Throws:
org.apache.axis2.AxisFault - If communication with the webservice fails.

getDataFiles

public FileSetMemberInfo[] getDataFiles(int arrayDesignId,
                                        QueryOptions qOpt)
                                 throws org.apache.axis2.AxisFault
Returns information about data files that are used storing feature information for an array design.

Parameters:
arrayDesignId - Id of the array design to get the information about.
qOpt - Restrictions and includes to put on the query when getting the information.
Returns:
An array of FileSetMemberInfo, one for each data file used in the array design.
Throws:
org.apache.axis2.AxisFault - If communication with webservice fails.
Since:
3.0

hasDownloadableData

public Boolean hasDownloadableData(int arrayDesignId)
                            throws org.apache.axis2.AxisFault
Gets if data in an array design can be downloaded as a file or not.

Parameters:
arrayDesignId - Id of the array design to check
Returns:
TRUE if there are any data to download as a file, FALSE otherwise.
Throws:
org.apache.axis2.AxisFault - If communication with the webservice fails.

3.1.2: 2012-07-31