java.lang.Object
- ch.systemsx.cisd.etlserver.registrator.api.v1.impl.DataSet<FeatureVectorDataSetInformation>
- - ch.systemsx.cisd.openbis.dss.etl.dto.api.v1.impl.FeatureVectorDataSet

All Implemented Interfaces:: IDataSet, IDataSetUpdatable, IFeatureVectorDataSet, IDataSetImmutable, IMetaprojectContent

public class FeatureVectorDataSet
extends DataSet<FeatureVectorDataSetInformation>
implements IFeatureVectorDataSet

Field Summary

Fields
Modifier and Type Field Description

protected ch.systemsx.cisd.openbis.dss.generic.shared.IEncapsulatedBasicOpenBISService service

Constructor Summary

Constructors
Constructor	Description
`FeatureVectorDataSet(DataSet<FeatureVectorDataSetInformation> dataSet, ch.systemsx.cisd.openbis.dss.generic.shared.IEncapsulatedOpenBISService service)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object obj)`
`java.util.List<java.lang.String>`	`getAllPropertyCodes()`	Returns codes of all properties of this dataset.
`java.util.List<IDataSetImmutable>`	`getChildrenDataSets()`	Gets the children data sets.
`java.util.List<java.lang.String>`	`getContainedDataSetCodes()`	Get the codes for contained data sets.
`java.lang.String`	`getContainerDataSet()`	Return the code of the container in which this data set is contained.
`java.lang.String`	`getDataSetCode()`	Get the data set code of the data set
`java.io.File`	`getDataSetStagingFolder()`
`java.lang.String`	`getDataSetType()`	Get the data set type.
`DataSetType`	`getDataSetTypeWithPropertyTypes()`	Returns data set type with property types and vocabulary terms for all property types with vocabulary data type.
`protected DataSetType`	`getDataSetTypeWithPropertyTypes(java.lang.String dataSetTypeCode)`
`IExperimentImmutable`	`getExperiment()`	Get the experiment for this data set.
`java.lang.String`	`getExternalCode()`
`IExternalDataManagementSystemImmutable`	`getExternalDataManagementSystem()`	Get the external data management system
`java.lang.String`	`getFileFormatType()`	The file format type of the data set.
`java.util.List<java.lang.String>`	`getParentDatasets()`	Gets the parents of the dataset.
`java.lang.String`	`getPropertyValue(java.lang.String propertyCode)`	Get the value for a property.
`DataSetRegistrationDetails<? extends FeatureVectorDataSetInformation>`	`getRegistrationDetails()`
`ISampleImmutable`	`getSample()`	Get the sample for this data set, if there is one.
`int`	`getSpeedHint()`	Returns the speed hint.
`int`	`hashCode()`
`boolean`	`isContainedDataSet()`	Return true if this data set is contained in other data set
`boolean`	`isContainerDataSet()`	Return true if this data set contains other data sets.
`boolean`	`isLinkDataSet()`
`boolean`	`isMeasuredData()`	Return true if the data set is measured data.
`boolean`	`isNoFileDataSet()`
`void`	`setAnalysisProcedure(java.lang.String analysisProcedure)`	Sets the analysis procedure used to create the feature vectors.
`void`	`setContainedDataSetCodes(java.util.List<java.lang.String> containedDataSetCodes)`	Set the codes for contained data sets.
`void`	`setDataSetType(java.lang.String dataSetTypeCode)`	Set the data set type.
`void`	`setExperiment(IExperimentImmutable experiment)`	Set the experiment for this data set.
`void`	`setExternalCode(java.lang.String externalCode)`	Set the code from the external data management system
`void`	`setExternalDataManagementSystem(IExternalDataManagementSystemImmutable externalDataManagementSystem)`	Set the external data management system
`void`	`setFileFormatType(java.lang.String fileFormatTypeCode)`	Set the file format type.
`void`	`setMeasuredData(boolean measuredData)`	Set whether the data is measured or not.
`void`	`setParentDatasets(java.util.List<java.lang.String> parentDatasetCodes)`	Sets the parents of the dataset.
`void`	`setPropertyValue(java.lang.String propertyCode, java.lang.String propertyValue)`	Set the value for a property.
`void`	`setSample(ISampleImmutable sampleOrNull)`	Set the sample for this data set.
`void`	`setSpeedHint(int speedHint)`	Sets the speed hint for the data set.
`java.lang.String`	`toString()`
`java.io.File`	`tryDataSetContents()`

Methods inherited from class ch.systemsx.cisd.etlserver.registrator.api.v1.impl.DataSet
getContainerDataSets, getDataSetKind, getEntityId, getOrderInContainer, isPostRegistered, setDataSetKind, setExperiment

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.systemsx.cisd.etlserver.registrator.api.v1.IDataSet
setDataSetKind

Methods inherited from interface ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v1.IDataSetImmutable
getContainerDataSets, getDataSetKind, getOrderInContainer, isPostRegistered

Methods inherited from interface ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v1.IMetaprojectContent
getEntityId

- Field Detail
  - service
```
protected final ch.systemsx.cisd.openbis.dss.generic.shared.IEncapsulatedBasicOpenBISService service
```
- Constructor Detail
  - FeatureVectorDataSet
```
public FeatureVectorDataSet(DataSet<FeatureVectorDataSetInformation> dataSet,
                            ch.systemsx.cisd.openbis.dss.generic.shared.IEncapsulatedOpenBISService service)
```
- Method Detail
  - setAnalysisProcedure
```
public void setAnalysisProcedure(java.lang.String analysisProcedure)
```
    Description copied from interface: IFeatureVectorDataSet
    
    Sets the analysis procedure used to create the feature vectors.
    
    Specified by:
    
    setAnalysisProcedure in interface IFeatureVectorDataSet
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - getRegistrationDetails
```
public DataSetRegistrationDetails<? extends FeatureVectorDataSetInformation> getRegistrationDetails()
```
    Overrides:
    
    getRegistrationDetails in class DataSet<FeatureVectorDataSetInformation>
  - getDataSetStagingFolder
```
public java.io.File getDataSetStagingFolder()
```
    Overrides:
    
    getDataSetStagingFolder in class DataSet<FeatureVectorDataSetInformation>
  - getDataSetCode
```
public java.lang.String getDataSetCode()
```
    Description copied from interface: IDataSetImmutable
    
    Get the data set code of the data set
    
    Specified by:
    
    getDataSetCode in interface IDataSetImmutable
    
    Overrides:
    
    getDataSetCode in class DataSet<FeatureVectorDataSetInformation>
    
    Returns:
    
    The code of this data set.
  - getExperiment
```
public IExperimentImmutable getExperiment()
```
    Description copied from interface: IDataSetImmutable
    
    Get the experiment for this data set. This can only be null at initialization time, and will be non-null for a valid data set.
    
    Specified by:
    
    getExperiment in interface IDataSetImmutable
    
    Overrides:
    
    getExperiment in class DataSet<FeatureVectorDataSetInformation>
    
    Returns:
    
    The experiment for this data set (will be non-null for a valid data set)
  - getSample
```
public ISampleImmutable getSample()
```
    Description copied from interface: IDataSetImmutable
    
    Get the sample for this data set, if there is one.
    
    Specified by:
    
    getSample in interface IDataSetImmutable
    
    Overrides:
    
    getSample in class DataSet<FeatureVectorDataSetInformation>
    
    Returns:
    
    A sample or null.
  - getFileFormatType
```
public java.lang.String getFileFormatType()
```
    Description copied from interface: IDataSetImmutable
    
    The file format type of the data set. Defaults to the default specified in FileFormatType.
    This property is undefined for container data sets.
    
    Specified by:
    
    getFileFormatType in interface IDataSetImmutable
    
    Overrides:
    
    getFileFormatType in class DataSet<FeatureVectorDataSetInformation>
    
    Returns:
    
    The code of the FileFormatType for this data set.
  - getSpeedHint
```
public int getSpeedHint()
```
    Description copied from interface: IDataSetImmutable
    
    Returns the speed hint.
    This property is undefined for container data sets.
    
    Specified by:
    
    getSpeedHint in interface IDataSetImmutable
    
    Overrides:
    
    getSpeedHint in class DataSet<FeatureVectorDataSetInformation>
  - getDataSetType
```
public java.lang.String getDataSetType()
```
    Description copied from interface: IDataSetImmutable
    
    Get the data set type. This is only null during initialization and is non-null for a valid data set.
    
    Specified by:
    
    getDataSetType in interface IDataSetImmutable
    
    Overrides:
    
    getDataSetType in class DataSet<FeatureVectorDataSetInformation>
  - getDataSetTypeWithPropertyTypes
```
public DataSetType getDataSetTypeWithPropertyTypes()
```
    Description copied from interface: IDataSetImmutable
    
    Returns data set type with property types and vocabulary terms for all property types with vocabulary data type.
    
    Specified by:
    
    getDataSetTypeWithPropertyTypes in interface IDataSetImmutable
    
    Overrides:
    
    getDataSetTypeWithPropertyTypes in class DataSet<FeatureVectorDataSetInformation>
  - getPropertyValue
```
public java.lang.String getPropertyValue(java.lang.String propertyCode)
```
    Description copied from interface: IDataSetImmutable
    
    Get the value for a property.
    
    Specified by:
    
    getPropertyValue in interface IDataSetImmutable
    
    Overrides:
    
    getPropertyValue in class DataSet<FeatureVectorDataSetInformation>
  - getAllPropertyCodes
```
public java.util.List<java.lang.String> getAllPropertyCodes()
```
    Description copied from interface: IDataSetImmutable
    
    Returns codes of all properties of this dataset. Each code can be used when calling IDataSetImmutable.getPropertyValue(String).
    
    Specified by:
    
    getAllPropertyCodes in interface IDataSetImmutable
    
    Overrides:
    
    getAllPropertyCodes in class DataSet<FeatureVectorDataSetInformation>
  - getParentDatasets
```
public java.util.List<java.lang.String> getParentDatasets()
```
    Description copied from interface: IDataSetImmutable
    
    Gets the parents of the dataset.
    
    Specified by:
    
    getParentDatasets in interface IDataSetImmutable
    
    Overrides:
    
    getParentDatasets in class DataSet<FeatureVectorDataSetInformation>
  - getContainedDataSetCodes
```
public java.util.List<java.lang.String> getContainedDataSetCodes()
```
    Description copied from interface: IDataSetImmutable
    
    Get the codes for contained data sets. This is empty if IDataSetImmutable.isContainerDataSet() returns false.
    
    Specified by:
    
    getContainedDataSetCodes in interface IDataSetImmutable
    
    Overrides:
    
    getContainedDataSetCodes in class DataSet<FeatureVectorDataSetInformation>
  - getChildrenDataSets
```
public java.util.List<IDataSetImmutable> getChildrenDataSets()
```
    Description copied from interface: IDataSetImmutable
    
    Gets the children data sets. Only available for data sets existing prior the transaction start.
    
    Specified by:
    
    getChildrenDataSets in interface IDataSetImmutable
    
    Overrides:
    
    getChildrenDataSets in class DataSet<FeatureVectorDataSetInformation>
  - getContainerDataSet
```
public java.lang.String getContainerDataSet()
```
    Description copied from interface: IDataSetImmutable
    
    Return the code of the container in which this data set is contained. If the data set is in more than one container only the code of one of these containers is returned.
    
    Specified by:
    
    getContainerDataSet in interface IDataSetImmutable
    
    Overrides:
    
    getContainerDataSet in class DataSet<FeatureVectorDataSetInformation>
  - getExternalDataManagementSystem
```
public IExternalDataManagementSystemImmutable getExternalDataManagementSystem()
```
    Description copied from interface: IDataSetImmutable
    
    Get the external data management system
    
    Specified by:
    
    getExternalDataManagementSystem in interface IDataSetImmutable
    
    Overrides:
    
    getExternalDataManagementSystem in class DataSet<FeatureVectorDataSetInformation>
  - getExternalCode
```
public java.lang.String getExternalCode()
```
    Specified by:
    
    getExternalCode in interface IDataSetImmutable
    
    Overrides:
    
    getExternalCode in class DataSet<FeatureVectorDataSetInformation>
    
    Returns:
    
    the code of this link data set in the external data management system
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - setExperiment
```
public void setExperiment(IExperimentImmutable experiment)
```
    Description copied from interface: IDataSetUpdatable
    
    Set the experiment for this data set. The experiment may also be set by setting the sample.
    
    Specified by:
    
    setExperiment in interface IDataSetUpdatable
    
    Overrides:
    
    setExperiment in class DataSet<FeatureVectorDataSetInformation>
    
    Parameters:
    
    experiment - The experiment for this data set. Need not actually be immutable, but the immutable one is the supertype.
  - setSample
```
public void setSample(ISampleImmutable sampleOrNull)
```
    Description copied from interface: IDataSetUpdatable
    
    Set the sample for this data set. Will also set the experiment, since the sample must have an experiment.
    
    Specified by:
    
    setSample in interface IDataSetUpdatable
    
    Overrides:
    
    setSample in class DataSet<FeatureVectorDataSetInformation>
    
    Parameters:
    
    sampleOrNull - The sample to use. Need not actually be immutable, but the immutable one is the supertype.
  - setFileFormatType
```
public void setFileFormatType(java.lang.String fileFormatTypeCode)
```
    Description copied from interface: IDataSetUpdatable
    
    Set the file format type.
    This property is undefined for container data sets.
    
    Specified by:
    
    setFileFormatType in interface IDataSetUpdatable
    
    Overrides:
    
    setFileFormatType in class DataSet<FeatureVectorDataSetInformation>
    
    Parameters:
    
    fileFormatTypeCode - The code of the desired FileFormatType.
  - isMeasuredData
```
public boolean isMeasuredData()
```
    Description copied from interface: IDataSetImmutable
    
    Return true if the data set is measured data. Defaults to true.
    
    Specified by:
    
    isMeasuredData in interface IDataSetImmutable
    
    Overrides:
    
    isMeasuredData in class DataSet<FeatureVectorDataSetInformation>
    
    Returns:
    
    True if the data set is measured data, false otherwise.
  - setMeasuredData
```
public void setMeasuredData(boolean measuredData)
```
    Description copied from interface: IDataSet
    
    Set whether the data is measured or not.
    
    Specified by:
    
    setMeasuredData in interface IDataSet
    
    Overrides:
    
    setMeasuredData in class DataSet<FeatureVectorDataSetInformation>
  - setSpeedHint
```
public void setSpeedHint(int speedHint)
```
    Description copied from interface: IDataSet
    
    Sets the speed hint for the data set. The speed hint is a negative or positive number with an absolute value less than or equal Constants.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_HINT is assumed.
    This property is undefined for container data sets.
    
    Specified by:
    
    setSpeedHint in interface IDataSet
    
    Overrides:
    
    setSpeedHint in class DataSet<FeatureVectorDataSetInformation>
  - setDataSetType
```
public void setDataSetType(java.lang.String dataSetTypeCode)
```
    Description copied from interface: IDataSet
    
    Set the data set type.
    
    Specified by:
    
    setDataSetType in interface IDataSet
    
    Overrides:
    
    setDataSetType in class DataSet<FeatureVectorDataSetInformation>
  - setPropertyValue
```
public void setPropertyValue(java.lang.String propertyCode,
                             java.lang.String propertyValue)
```
    Description copied from interface: IDataSetUpdatable
    
    Set the value for a property.
    
    Specified by:
    
    setPropertyValue in interface IDataSetUpdatable
    
    Overrides:
    
    setPropertyValue in class DataSet<FeatureVectorDataSetInformation>
  - setParentDatasets
```
public void setParentDatasets(java.util.List<java.lang.String> parentDatasetCodes)
```
    Description copied from interface: IDataSetUpdatable
    
    Sets the parents of the dataset.
    
    Specified by:
    
    setParentDatasets in interface IDataSetUpdatable
    
    Overrides:
    
    setParentDatasets in class DataSet<FeatureVectorDataSetInformation>
  - isContainerDataSet
```
public boolean isContainerDataSet()
```
    Description copied from interface: IDataSetImmutable
    
    Return true if this data set contains other data sets.
    
    Specified by:
    
    isContainerDataSet in interface IDataSetImmutable
    
    Overrides:
    
    isContainerDataSet in class DataSet<FeatureVectorDataSetInformation>
  - setContainedDataSetCodes
```
public void setContainedDataSetCodes(java.util.List<java.lang.String> containedDataSetCodes)
```
    Description copied from interface: IDataSetUpdatable
    
    Set the codes for contained data sets.
    
    Specified by:
    
    setContainedDataSetCodes in interface IDataSetUpdatable
    
    Overrides:
    
    setContainedDataSetCodes in class DataSet<FeatureVectorDataSetInformation>
  - isContainedDataSet
```
public boolean isContainedDataSet()
```
    Description copied from interface: IDataSetImmutable
    
    Return true if this data set is contained in other data set
    
    Specified by:
    
    isContainedDataSet in interface IDataSetImmutable
    
    Overrides:
    
    isContainedDataSet in class DataSet<FeatureVectorDataSetInformation>
  - setExternalDataManagementSystem
```
public void setExternalDataManagementSystem(IExternalDataManagementSystemImmutable externalDataManagementSystem)
```
    Description copied from interface: IDataSetUpdatable
    
    Set the external data management system
    
    Specified by:
    
    setExternalDataManagementSystem in interface IDataSetUpdatable
    
    Overrides:
    
    setExternalDataManagementSystem in class DataSet<FeatureVectorDataSetInformation>
  - isLinkDataSet
```
public boolean isLinkDataSet()
```
    Specified by:
    
    isLinkDataSet in interface IDataSetImmutable
    
    Overrides:
    
    isLinkDataSet in class DataSet<FeatureVectorDataSetInformation>
    
    Returns:
    
    true if this is a data set, that links to external data management system
  - setExternalCode
```
public void setExternalCode(java.lang.String externalCode)
```
    Description copied from interface: IDataSetUpdatable
    
    Set the code from the external data management system
    
    Specified by:
    
    setExternalCode in interface IDataSetUpdatable
    
    Overrides:
    
    setExternalCode in class DataSet<FeatureVectorDataSetInformation>
  - isNoFileDataSet
```
public boolean isNoFileDataSet()
```
    Specified by:
    
    isNoFileDataSet in interface IDataSetImmutable
    
    Overrides:
    
    isNoFileDataSet in class DataSet<FeatureVectorDataSetInformation>
    
    Returns:
    
    true if this dataset doesn't contain any files. It can be for example container or link data set.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - tryDataSetContents
```
public java.io.File tryDataSetContents()
```
    Overrides:
    
    tryDataSetContents in class DataSet<FeatureVectorDataSetInformation>
  - getDataSetTypeWithPropertyTypes
```
protected DataSetType getDataSetTypeWithPropertyTypes(java.lang.String dataSetTypeCode)
```

Class FeatureVectorDataSet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ch.systemsx.cisd.etlserver.registrator.api.v1.impl.DataSet

Methods inherited from class java.lang.Object

Methods inherited from interface ch.systemsx.cisd.etlserver.registrator.api.v1.IDataSet

Methods inherited from interface ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v1.IDataSetImmutable

Methods inherited from interface ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v1.IMetaprojectContent

Field Detail

service

Constructor Detail

FeatureVectorDataSet

Method Detail

setAnalysisProcedure

equals

getRegistrationDetails

getDataSetStagingFolder

getDataSetCode

getExperiment

getSample

getFileFormatType

getSpeedHint

getDataSetType

getDataSetTypeWithPropertyTypes

getPropertyValue

getAllPropertyCodes

getParentDatasets

getContainedDataSetCodes

getChildrenDataSets

getContainerDataSet

getExternalDataManagementSystem

getExternalCode

hashCode

setExperiment

setSample

setFileFormatType

isMeasuredData

setMeasuredData

setSpeedHint

setDataSetType

setPropertyValue

setParentDatasets

isContainerDataSet

setContainedDataSetCodes

isContainedDataSet

setExternalDataManagementSystem

isLinkDataSet

setExternalCode

isNoFileDataSet

toString

tryDataSetContents

getDataSetTypeWithPropertyTypes