net.sf.basedb.ws.server
Class ArrayDesignService

java.lang.Object
  net.sf.basedb.ws.server.AbstractRPCService
      net.sf.basedb.ws.server.ArrayDesignService

public class ArrayDesignService
extends AbstractRPCService

Web service class for ArrayDesign Provides services to access limited functionality in this class.

Version:

2.5

Author:

Martin

Field Summary

Fields inherited from class net.sf.basedb.ws.server.AbstractRPCService

util

Constructor Summary

ArrayDesignService()

Method Summary

org.apache.axiom.om.OMElement	downloadArrayDesignByType(String ID, int arrayDesignId, String dataFileType) Returns array design file of a certain type, attached to an OMElement.
AnnotationInfo[]	getAnnotations(String ID, int arrayDesignId, Integer[] annotationTypes, boolean findInherited) Get the annotation values for one or more annotation types.
ArrayDesignInfo[]	getArrayDesigns(String ID, QueryOptions qOpt) Gets an array with info about array designs available for the active session.
ArrayDesignInfo	getById(String ID, int itemId) Get information about an array design that you know the ID of.
DataFileTypeInfo[]	getDataFileTypes(String ID, int arrayDesignId, QueryOptions qOpt) Returns information objects for each DataFileType represented in the FileSet of an ArrayDesign
Boolean	hasDownloadableData(String ID, int arrayDesignId) Gets if the arraydesign files can be downloaded or not.

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

ArrayDesignService

public ArrayDesignService()

Method Detail

getById

public ArrayDesignInfo getById(String ID,
                               int itemId)

Get information about an array design that you know the ID of.

Parameters:

ID - Id to identify the session.

itemId - The ID of the array design

Returns:

The array design information

getArrayDesigns

public ArrayDesignInfo[] getArrayDesigns(String ID,
                                         QueryOptions qOpt)

Gets an array with info about array designs available for the active session.

Parameters:

ID - Id for the session to use.

qOpt - QueryOptions to put on the query

Returns:

An ArrayDesignInfo array.

downloadArrayDesignByType

public org.apache.axiom.om.OMElement downloadArrayDesignByType(String ID,
                                                               int arrayDesignId,
                                                               String dataFileType)

Returns array design file of a certain type, attached to an OMElement.

Parameters:

ID - Used to identify an active session with.

arrayDesignId - Id of the array design the file is associated with.

dataFileType - IThe external ID of the file type.

Returns:

OMElement with the file attached, or NULL if no file was found.

hasDownloadableData

public Boolean hasDownloadableData(String ID,
                                   int arrayDesignId)

Gets if the arraydesign files can be downloaded or not.

Parameters:

ID - Used to identify an active session with

arrayDesignId - Id of the array design it concerns

Returns:

TRUE if there are files to download, FALSE otherwise.

getDataFileTypes

public DataFileTypeInfo[] getDataFileTypes(String ID,
                                           int arrayDesignId,
                                           QueryOptions qOpt)

Returns information objects for each DataFileType represented in the FileSet of an ArrayDesign

Parameters:

ID - Id of the active session.

arrayDesignId - Id of the array design it concerns

qOpt - Restrictions and includes to put on the query

Returns:

An array with DataFileTypeInfo:s.

getAnnotations

public AnnotationInfo[] getAnnotations(String ID,
                                       int arrayDesignId,
                                       Integer[] annotationTypes,
                                       boolean findInherited)

Get the annotation values for one or more annotation types.

Parameters:

ID - Id of the active session.

arrayDesignId - Id of the array design 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