Class DataSet<T extends ch.systemsx.cisd.openbis.dss.generic.shared.dto.DataSetInformation>
java.lang.Object
ch.systemsx.cisd.etlserver.registrator.api.v2.impl.DataSet<T>
- All Implemented Interfaces:
IDataSet,IDataSetUpdatable,ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable,ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IMetaprojectContent
public class DataSet<T extends ch.systemsx.cisd.openbis.dss.generic.shared.dto.DataSetInformation>
extends Object
implements IDataSet
A generic class that represents a data set for the registration API. Can be subclassed.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final ch.systemsx.cisd.openbis.dss.generic.shared.IEncapsulatedBasicOpenBISService -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionList<ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable>ch.systemsx.cisd.openbis.generic.shared.basic.dto.DataSetKindch.systemsx.cisd.openbis.generic.shared.api.v1.dto.DataSetTypeprotected ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.DataSetTypegetDataSetTypeWithPropertyTypes(String dataSetTypeCode) ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.id.IObjectIdch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IExperimentImmutablech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IExternalDataManagementSystemImmutablegetOrderInContainer(String containerDataSetCode) getPropertyValue(String propertyCode) ch.systemsx.cisd.etlserver.registrator.DataSetRegistrationDetails<? extends T>ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutableintbooleanbooleanbooleanbooleanbooleanbooleanvoidsetContainedDataSetCodes(List<String> containedDataSetCodes) Set the codes for contained data sets.voidsetDataSetKind(ch.systemsx.cisd.openbis.generic.shared.basic.dto.DataSetKind dataSetKind) voidsetDataSetType(String dataSetTypeCode) Set the data set type.voidsetExperiment(ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IExperimentImmutable experiment) Set the experiment for this data set.protected voidsetExperiment(ch.systemsx.cisd.openbis.generic.shared.basic.dto.Experiment exp) voidsetExternalCode(String externalCode) Set the code from the external data management systemvoidsetExternalDataManagementSystem(ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IExternalDataManagementSystemImmutable externalDataManagementSystem) Set the external data management systemvoidsetFileFormatType(String fileFormatTypeCode) Set the file format type.voidsetMeasuredData(boolean measuredData) Set whether the data is measured or not.voidsetParentDatasets(List<String> parentDatasetCodes) Sets the parents of the dataset.voidsetPropertyValue(String propertyCode, String propertyValue) Set the value for a property.voidsetSample(ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable sampleOrNull) Set the sample for this data set.voidsetSpeedHint(int speedHint) Sets the speed hint for the data set.
-
Field Details
-
service
protected final ch.systemsx.cisd.openbis.dss.generic.shared.IEncapsulatedBasicOpenBISService service
-
-
Constructor Details
-
Method Details
-
getRegistrationDetails
public ch.systemsx.cisd.etlserver.registrator.DataSetRegistrationDetails<? extends T> getRegistrationDetails() -
getDataSetStagingFolder
-
tryDataSetContents
-
getDataSetCode
- Specified by:
getDataSetCodein interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
getEntityId
public ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.id.IObjectId getEntityId()- Specified by:
getEntityIdin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IMetaprojectContent
-
getExperiment
public ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IExperimentImmutable getExperiment()- Specified by:
getExperimentin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
getSample
public ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable getSample()- Specified by:
getSamplein interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
getFileFormatType
- Specified by:
getFileFormatTypein interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
setFileFormatType
Description copied from interface:IDataSetUpdatableSet the file format type.This property is undefined for container data sets.
- Specified by:
setFileFormatTypein interfaceIDataSetUpdatable- Parameters:
fileFormatTypeCode- The code of the desiredFileFormatType.
-
isMeasuredData
public boolean isMeasuredData()- Specified by:
isMeasuredDatain interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
setMeasuredData
public void setMeasuredData(boolean measuredData) Description copied from interface:IDataSetSet whether the data is measured or not.- Specified by:
setMeasuredDatain interfaceIDataSet
-
getSpeedHint
public int getSpeedHint()- Specified by:
getSpeedHintin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
setSpeedHint
public void setSpeedHint(int speedHint) Description copied from interface:IDataSetSets the speed hint for the data set. The speed hint is a negative or positive number with an absolute value less than or equalConstants.MAX_SPEED.A positive value means that the data set should be stored in a storage with speed >=
speedHint. A negative value means that the data set should be stored in a storage with speed <=abs(speedHint). The speed hint might be ignored.If no speed hint has been set the default value
Constants.DEFAULT_SPEED_HINTis assumed.This property is undefined for container data sets.
- Specified by:
setSpeedHintin interfaceIDataSet
-
getDataSetType
- Specified by:
getDataSetTypein interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
getDataSetKind
public ch.systemsx.cisd.openbis.generic.shared.basic.dto.DataSetKind getDataSetKind()- Specified by:
getDataSetKindin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
getDataSetTypeWithPropertyTypes
public ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.DataSetType getDataSetTypeWithPropertyTypes()- Specified by:
getDataSetTypeWithPropertyTypesin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
setDataSetType
Description copied from interface:IDataSetSet the data set type.- Specified by:
setDataSetTypein interfaceIDataSet
-
getPropertyValue
- Specified by:
getPropertyValuein interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
getAllPropertyCodes
- Specified by:
getAllPropertyCodesin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
setPropertyValue
Description copied from interface:IDataSetUpdatableSet the value for a property.- Specified by:
setPropertyValuein interfaceIDataSetUpdatable
-
setParentDatasets
Description copied from interface:IDataSetUpdatableSets the parents of the dataset.- Specified by:
setParentDatasetsin interfaceIDataSetUpdatable
-
getParentDatasets
- Specified by:
getParentDatasetsin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
isContainerDataSet
public boolean isContainerDataSet()- Specified by:
isContainerDataSetin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
getContainedDataSetCodes
- Specified by:
getContainedDataSetCodesin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
setContainedDataSetCodes
Description copied from interface:IDataSetUpdatableSet the codes for contained data sets.- Specified by:
setContainedDataSetCodesin interfaceIDataSetUpdatable
-
getChildrenDataSets
public List<ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable> getChildrenDataSets()- Specified by:
getChildrenDataSetsin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
isContainedDataSet
public boolean isContainedDataSet()- Specified by:
isContainedDataSetin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
getContainerDataSet
- Specified by:
getContainerDataSetin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
getContainerDataSets
- Specified by:
getContainerDataSetsin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
getOrderInContainer
- Specified by:
getOrderInContainerin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
isLinkDataSet
public boolean isLinkDataSet()- Specified by:
isLinkDataSetin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
getExternalDataManagementSystem
public ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IExternalDataManagementSystemImmutable getExternalDataManagementSystem()- Specified by:
getExternalDataManagementSystemin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
setExternalCode
Description copied from interface:IDataSetUpdatableSet the code from the external data management system- Specified by:
setExternalCodein interfaceIDataSetUpdatable
-
getExternalCode
- Specified by:
getExternalCodein interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
isNoFileDataSet
public boolean isNoFileDataSet()- Specified by:
isNoFileDataSetin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
isPostRegistered
public boolean isPostRegistered()- Specified by:
isPostRegisteredin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
getDataSetTypeWithPropertyTypes
protected ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.DataSetType getDataSetTypeWithPropertyTypes(String dataSetTypeCode)
-