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 java.lang.Object implements IDataSet
A generic class that represents a data set for the registration API. Can be subclassed.
-
-
Field Summary
Fields Modifier and Type Field Description protected ch.systemsx.cisd.openbis.dss.generic.shared.IEncapsulatedBasicOpenBISServiceservice
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<java.lang.String>getAllPropertyCodes()java.util.List<ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable>getChildrenDataSets()java.util.List<java.lang.String>getContainedDataSetCodes()java.lang.StringgetContainerDataSet()java.util.List<java.lang.String>getContainerDataSets()java.lang.StringgetDataSetCode()ch.systemsx.cisd.openbis.generic.shared.basic.dto.DataSetKindgetDataSetKind()java.io.FilegetDataSetStagingFolder()java.lang.StringgetDataSetType()ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.DataSetTypegetDataSetTypeWithPropertyTypes()protected ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.DataSetTypegetDataSetTypeWithPropertyTypes(java.lang.String dataSetTypeCode)ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.id.IObjectIdgetEntityId()ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IExperimentImmutablegetExperiment()java.lang.StringgetExternalCode()ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IExternalDataManagementSystemImmutablegetExternalDataManagementSystem()java.lang.StringgetFileFormatType()java.lang.IntegergetOrderInContainer(java.lang.String containerDataSetCode)java.util.List<java.lang.String>getParentDatasets()java.lang.StringgetPropertyValue(java.lang.String propertyCode)ch.systemsx.cisd.etlserver.registrator.DataSetRegistrationDetails<? extends T>getRegistrationDetails()ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutablegetSample()intgetSpeedHint()booleanisContainedDataSet()booleanisContainerDataSet()booleanisLinkDataSet()booleanisMeasuredData()booleanisNoFileDataSet()booleanisPostRegistered()voidsetContainedDataSetCodes(java.util.List<java.lang.String> containedDataSetCodes)Set the codes for contained data sets.voidsetDataSetKind(ch.systemsx.cisd.openbis.generic.shared.basic.dto.DataSetKind dataSetKind)voidsetDataSetType(java.lang.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(java.lang.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(java.lang.String fileFormatTypeCode)Set the file format type.voidsetMeasuredData(boolean measuredData)Set whether the data is measured or not.voidsetParentDatasets(java.util.List<java.lang.String> parentDatasetCodes)Sets the parents of the dataset.voidsetPropertyValue(java.lang.String propertyCode, java.lang.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.java.io.FiletryDataSetContents()
-
-
-
Constructor Detail
-
DataSet
public DataSet(ch.systemsx.cisd.etlserver.registrator.DataSetRegistrationDetails<? extends T> registrationDetails, java.io.File dataSetFolder, ch.systemsx.cisd.openbis.dss.generic.shared.IEncapsulatedOpenBISService service)
-
-
Method Detail
-
getRegistrationDetails
public ch.systemsx.cisd.etlserver.registrator.DataSetRegistrationDetails<? extends T> getRegistrationDetails()
-
getDataSetStagingFolder
public java.io.File getDataSetStagingFolder()
-
tryDataSetContents
public java.io.File tryDataSetContents()
-
getDataSetCode
public java.lang.String 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
-
setExperiment
public void setExperiment(ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IExperimentImmutable experiment)
Description copied from interface:IDataSetUpdatableSet the experiment for this data set. The experiment may also be set by setting the sample.- Specified by:
setExperimentin interfaceIDataSetUpdatable- Parameters:
experiment- The experiment for this data set. Need not actually be immutable, but the immutable one is the supertype.
-
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
-
setSample
public void setSample(ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable sampleOrNull)
Description copied from interface:IDataSetUpdatableSet the sample for this data set. Will also set the experiment, since the sample must have an experiment.- Specified by:
setSamplein interfaceIDataSetUpdatable- Parameters:
sampleOrNull- The sample to use. Need not actually be immutable, but the immutable one is the supertype.
-
getFileFormatType
public java.lang.String getFileFormatType()
- Specified by:
getFileFormatTypein interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
setFileFormatType
public void setFileFormatType(java.lang.String fileFormatTypeCode)
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
public java.lang.String 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
public void setDataSetType(java.lang.String dataSetTypeCode)
Description copied from interface:IDataSetSet the data set type.- Specified by:
setDataSetTypein interfaceIDataSet
-
setDataSetKind
public void setDataSetKind(ch.systemsx.cisd.openbis.generic.shared.basic.dto.DataSetKind dataSetKind)
- Specified by:
setDataSetKindin interfaceIDataSet
-
setExperiment
protected void setExperiment(ch.systemsx.cisd.openbis.generic.shared.basic.dto.Experiment exp)
-
getPropertyValue
public java.lang.String getPropertyValue(java.lang.String propertyCode)
- Specified by:
getPropertyValuein interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
getAllPropertyCodes
public java.util.List<java.lang.String> getAllPropertyCodes()
- Specified by:
getAllPropertyCodesin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
setPropertyValue
public void setPropertyValue(java.lang.String propertyCode, java.lang.String propertyValue)Description copied from interface:IDataSetUpdatableSet the value for a property.- Specified by:
setPropertyValuein interfaceIDataSetUpdatable
-
setParentDatasets
public void setParentDatasets(java.util.List<java.lang.String> parentDatasetCodes)
Description copied from interface:IDataSetUpdatableSets the parents of the dataset.- Specified by:
setParentDatasetsin interfaceIDataSetUpdatable
-
getParentDatasets
public java.util.List<java.lang.String> 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
public java.util.List<java.lang.String> getContainedDataSetCodes()
- Specified by:
getContainedDataSetCodesin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
setContainedDataSetCodes
public void setContainedDataSetCodes(java.util.List<java.lang.String> containedDataSetCodes)
Description copied from interface:IDataSetUpdatableSet the codes for contained data sets.- Specified by:
setContainedDataSetCodesin interfaceIDataSetUpdatable
-
getChildrenDataSets
public java.util.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
public java.lang.String getContainerDataSet()
- Specified by:
getContainerDataSetin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
getContainerDataSets
public java.util.List<java.lang.String> getContainerDataSets()
- Specified by:
getContainerDataSetsin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
getOrderInContainer
public java.lang.Integer getOrderInContainer(java.lang.String containerDataSetCode)
- Specified by:
getOrderInContainerin interfacech.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IDataSetImmutable
-
setExternalDataManagementSystem
public void setExternalDataManagementSystem(ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IExternalDataManagementSystemImmutable externalDataManagementSystem)
Description copied from interface:IDataSetUpdatableSet the external data management system- Specified by:
setExternalDataManagementSystemin interfaceIDataSetUpdatable
-
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
public void setExternalCode(java.lang.String externalCode)
Description copied from interface:IDataSetUpdatableSet the code from the external data management system- Specified by:
setExternalCodein interfaceIDataSetUpdatable
-
getExternalCode
public java.lang.String 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(java.lang.String dataSetTypeCode)
-
-