Package ch.systemsx.cisd.openbis.generic.shared.basic.dto

Class DatastoreServiceDescription

java.lang.Object

ch.systemsx.cisd.openbis.generic.shared.basic.dto.DatastoreServiceDescription

All Implemented Interfaces:

IReportInformationProvider, java.io.Serializable, java.lang.Comparable<DatastoreServiceDescription>

public class DatastoreServiceDescription
extends java.lang.Object
implements IReportInformationProvider, java.io.Serializable, java.lang.Comparable<DatastoreServiceDescription>

Description of one datastore server plugin task: key, label, dataset type codes.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DatastoreServiceDescription(java.lang.String key, java.lang.String label, java.lang.String[] datasetTypeCodes, java.lang.String datastoreCode, DataStoreServiceKind serviceKind)	Deprecated. exposed for tests

Method Summary

Modifier and Type	Method	Description
int	compareTo(DatastoreServiceDescription o)
java.lang.String[]	getDatasetTypeCodes()	codes of dataset types which are handled by this plugin
java.lang.String	getDatastoreCode()
java.lang.String	getDownloadURL()	URL used to generate images
java.lang.String	getKey()	the unique key of the plugin
java.lang.String	getLabel()	the user friendly name of the plugin
DataStoreServiceKind	getServiceKind()
static boolean	isMatching(DatastoreServiceDescription service, AbstractExternalData dataset)
static DatastoreServiceDescription	processing(java.lang.String key, java.lang.String label, java.lang.String[] datasetTypeCodes, java.lang.String datastoreCode)
static DatastoreServiceDescription	reporting(java.lang.String key, java.lang.String label, java.lang.String[] datasetTypeCodes, java.lang.String datastoreCode, ReportingPluginType type)
void	setDownloadURL(java.lang.String downloadURL)
void	setReportingPluginTypeOrNull(ReportingPluginType reportingPluginTypeOrNull)
java.lang.String	toString()
ReportingPluginType	tryReportingPluginType()

Methods inherited from class java.lang.Object

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

Constructor Detail

DatastoreServiceDescription

@Deprecated
public DatastoreServiceDescription(java.lang.String key,
                                   java.lang.String label,
                                   java.lang.String[] datasetTypeCodes,
                                   java.lang.String datastoreCode,
                                   DataStoreServiceKind serviceKind)

Deprecated.

exposed for tests

Method Detail

processing

public static DatastoreServiceDescription processing(java.lang.String key,
                                                     java.lang.String label,
                                                     java.lang.String[] datasetTypeCodes,
                                                     java.lang.String datastoreCode)

reporting

public static DatastoreServiceDescription reporting(java.lang.String key,
                                                    java.lang.String label,
                                                    java.lang.String[] datasetTypeCodes,
                                                    java.lang.String datastoreCode,
                                                    ReportingPluginType type)

getKey

public java.lang.String getKey()

the unique key of the plugin

Specified by:

getKey in interface IReportInformationProvider

getLabel

public java.lang.String getLabel()

the user friendly name of the plugin

getServiceKind

public DataStoreServiceKind getServiceKind()

getDatasetTypeCodes

public java.lang.String[] getDatasetTypeCodes()

codes of dataset types which are handled by this plugin

getDatastoreCode

public java.lang.String getDatastoreCode()

getDownloadURL

public java.lang.String getDownloadURL()

Description copied from interface: IReportInformationProvider

URL used to generate images

Specified by:

getDownloadURL in interface IReportInformationProvider

setDownloadURL

public void setDownloadURL(java.lang.String downloadURL)

tryReportingPluginType

public ReportingPluginType tryReportingPluginType()

setReportingPluginTypeOrNull

public void setReportingPluginTypeOrNull(ReportingPluginType reportingPluginTypeOrNull)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isMatching

public static boolean isMatching(DatastoreServiceDescription service,
                                 AbstractExternalData dataset)

compareTo

public int compareTo(DatastoreServiceDescription o)

Specified by:

compareTo in interface java.lang.Comparable<DatastoreServiceDescription>