@JsonObject(value="NewDataSetDTO")
public class NewDataSetDTO
extends java.lang.Object
implements java.io.Serializable
The information required to register a new data set are the owner of the data set, the name of the container of the data set (folder or file name), and file info about the files in the data set.
Optionally, a data set type and properties may be specified. The type and properties will override those inferred by the server.
Modifier and Type | Class and Description |
---|---|
static class |
NewDataSetDTO.DataSetOwner
The identifier of the owner of the new data set.
|
static class |
NewDataSetDTO.DataSetOwnerType
The different types of owners of data sets; there are two: experiment and sample.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_DATA_SET_FOLDER_NAME |
Constructor and Description |
---|
NewDataSetDTO(NewDataSetDTO.DataSetOwner dataSetOwner,
java.io.File dataSetFile)
Constructor
|
NewDataSetDTO(NewDataSetDTO.DataSetOwner dataSetOwner,
java.lang.String dataSetFolderNameOrNull,
java.util.List<FileInfoDssDTO> fileInfos)
Constructor
|
NewDataSetDTO(NewDataSetMetadataDTO dataSetMetadata,
NewDataSetDTO.DataSetOwner dataSetOwner,
java.lang.String dataSetFolderNameOrNull,
java.util.List<FileInfoDssDTO> fileInfos)
Constructor
|
NewDataSetDTO(java.lang.String dataSetType,
NewDataSetDTO.DataSetOwner dataSetOwner,
java.lang.String dataSetFolderNameOrNull,
java.util.List<FileInfoDssDTO> fileInfos)
Constructor
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDataSetFolderName()
The name of the folder containing the files in the data set.
|
NewDataSetDTO.DataSetOwner |
getDataSetOwner()
The direct owner of the data set, either an experiment or a sample.
|
java.util.List<FileInfoDssDTO> |
getFileInfos()
FileInfoDssDTO objects describing the files within the data set. |
java.util.List<java.lang.String> |
getParentDataSetCodes()
The codes of the parent data sets for this new data set.
|
java.util.Map<java.lang.String,java.lang.String> |
getProperties() |
void |
setDataSetTypeOrNull(java.lang.String dataSetTypeOrNull) |
void |
setParentDataSetCodes(java.util.List<java.lang.String> codesOrNull)
Sets the parent data sets of this data set.
|
void |
setProperties(java.util.Map<java.lang.String,java.lang.String> props) |
java.lang.String |
toString() |
java.lang.String |
tryDataSetType() |
public static java.lang.String DEFAULT_DATA_SET_FOLDER_NAME
public NewDataSetDTO(NewDataSetDTO.DataSetOwner dataSetOwner, java.io.File dataSetFile)
dataSetOwner
- the owner of the new data setdataSetFile
- a local file or directory whose contents will be uploaded to openBIS.public NewDataSetDTO(NewDataSetDTO.DataSetOwner dataSetOwner, java.lang.String dataSetFolderNameOrNull, java.util.List<FileInfoDssDTO> fileInfos)
dataSetOwner
- The owner of the new data setdataSetFolderNameOrNull
- The name of the folder the data is stored in. If the data set
is just a single file and the folder name is null, a folder will be created.fileInfos
- FileInfoDssDTO objects for each of the files in the data set.public NewDataSetDTO(java.lang.String dataSetType, NewDataSetDTO.DataSetOwner dataSetOwner, java.lang.String dataSetFolderNameOrNull, java.util.List<FileInfoDssDTO> fileInfos)
dataSetType
- The type of the new data setdataSetOwner
- The owner of the new data setdataSetFolderNameOrNull
- The name of the folder the data is stored in. If the data set
is just a single file and the folder name is null, a folder will be created.fileInfos
- FileInfoDssDTO objects for each of the files in the data set.public NewDataSetDTO(NewDataSetMetadataDTO dataSetMetadata, NewDataSetDTO.DataSetOwner dataSetOwner, java.lang.String dataSetFolderNameOrNull, java.util.List<FileInfoDssDTO> fileInfos)
dataSetMetadata
- The metadata (type and properties) that will override those inferred
by the server.dataSetOwner
- The owner of the new data setdataSetFolderNameOrNull
- The name of the folder the data is stored in. If the data set
is just a single file and the folder name is null, a folder will be created.fileInfos
- FileInfoDssDTO objects for each of the files in the data set.public NewDataSetDTO.DataSetOwner getDataSetOwner()
public java.lang.String getDataSetFolderName()
public java.util.List<FileInfoDssDTO> getFileInfos()
FileInfoDssDTO
objects describing the files within the data set.public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String tryDataSetType()
public void setDataSetTypeOrNull(java.lang.String dataSetTypeOrNull)
public java.util.Map<java.lang.String,java.lang.String> getProperties()
public void setProperties(java.util.Map<java.lang.String,java.lang.String> props)
public java.util.List<java.lang.String> getParentDataSetCodes()
public void setParentDataSetCodes(java.util.List<java.lang.String> codesOrNull)
codesOrNull
- If the value is null, the parents are cleared.