3.2.4: 2013-12-06

net.sf.basedb.ws.server
Class BioAssaySetService

java.lang.Object
  extended by net.sf.basedb.ws.server.AbstractRPCService
      extended by net.sf.basedb.ws.server.BioAssaySetService

public class BioAssaySetService
extends AbstractRPCService

Web service for BioAssaySet BioAssaySet. This class provides services to get information and data from BioAssaySet.

Version:
2.5
Author:
Martin

Field Summary
 
Fields inherited from class net.sf.basedb.ws.server.AbstractRPCService
util
 
Constructor Summary
BioAssaySetService()
           
 
Method Summary
 org.apache.axiom.om.OMElement downloadDataFile(String ID, int bioAssaySetId, String dataFileType)
          Returns a data file of a certain type attached to an OMElement.
 AnnotationInfo[] getAnnotations(String ID, int bioAssaySetId, Integer[] annotationTypes, boolean findInherited)
          Get the annotation values for one or more annotation types.
 FileSetMemberInfo[] getDataFiles(String ID, int bioAssaySetId, QueryOptions qOpt)
          Returns information objects for each data file that is associated with a bioassay set.
 DataFileTypeInfo[] getDataFileTypes(String ID, int bioAssaySetId, QueryOptions qOpt)
          Returns information objects for each DataFileType represented in the FileSet of a BioAssaySet.
 Boolean hasDownloadableData(String ID, int bioAssaySetId)
          Checks if the files has been attached to bioassay set.
 
Methods inherited from class net.sf.basedb.ws.server.AbstractRPCService
attachFile, getRemoteId, getSessionControl
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BioAssaySetService

public BioAssaySetService()
Method Detail

downloadDataFile

public org.apache.axiom.om.OMElement downloadDataFile(String ID,
                                                      int bioAssaySetId,
                                                      String dataFileType)
Returns a data file of a certain type attached to an OMElement. This method assumes that only a single file of the given type exists. If there are two or more files, then it is not specified which one that is returned. Use getDataFiles(String, int, QueryOptions) and FileService to handle the multi-file case.

Parameters:
ID - Used to identify an active session with.
bioAssaySetId - Id of the bioassay set the file belongs to.
dataFileType - The external ID of the file type.
Returns:
OMElement with the file attached, or NULL if no file was found.
Since:
2.12
See Also:
DataFileType

hasDownloadableData

public Boolean hasDownloadableData(String ID,
                                   int bioAssaySetId)
Checks if the files has been attached to bioassay set.

Parameters:
ID - Used to identify an active session with
bioAssaySetId - Id of the bioassay set it concerns
Returns:
TRUE if there are files to download, FALSE otherwise.
Since:
2.12

getDataFileTypes

public DataFileTypeInfo[] getDataFileTypes(String ID,
                                           int bioAssaySetId,
                                           QueryOptions qOpt)
Returns information objects for each DataFileType represented in the FileSet of a BioAssaySet.

Parameters:
ID - Id of the active session.
bioAssaySetId - Id of the bioassay set it concerns
qOpt - Restrictions and includes to put on the query
Returns:
An array with DataFileTypeInfo:s.
Since:
2.12

getDataFiles

public FileSetMemberInfo[] getDataFiles(String ID,
                                        int bioAssaySetId,
                                        QueryOptions qOpt)
Returns information objects for each data file that is associated with a bioassay set.

Parameters:
ID - Id of the active session.
bioAssaySetId - Id of the bioassay set it concerns
qOpt - Restrictions and includes to put on the query
Returns:
An array with FileSetMemberInfo
Since:
3.0

getAnnotations

public AnnotationInfo[] getAnnotations(String ID,
                                       int bioAssaySetId,
                                       Integer[] annotationTypes,
                                       boolean findInherited)
Get the annotation values for one or more annotation types.

Parameters:
ID - Id of the active session.
bioAssaySetId - Id of the bioassay set it concerns
annotationTypes - Array with the ID of the annotation types
findInherited - TRUE to look among inherited annotations, FALSE to only look at primary annotations
Returns:
An array with AnnotationInfo object, each element in the array corresponds to the annotation type with the same index in the annotationTypes array

3.2.4: 2013-12-06