@JsonObject(value="DataSet")
public final class DataSet
extends java.lang.Object
implements java.io.Serializable, ch.systemsx.cisd.openbis.generic.shared.basic.IIdHolder
Modifier and Type | Class and Description |
---|---|
static class |
DataSet.Connections |
static class |
DataSet.DataSetInitializer
Class used to initialize a new data set instance.
|
Constructor and Description |
---|
DataSet(DataSet.DataSetInitializer initializer)
Creates a new instance with the provided initializer
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.util.List<java.lang.String> |
getChildrenCodes()
Return the children codes.
|
java.lang.String |
getCode()
Returns the data set code;
|
java.util.List<DataSet> |
getContainedDataSets() |
DataSet |
getContainerOrNull() |
java.lang.String |
getDataSetTypeCode() |
java.lang.String |
getExperimentIdentifier()
Returns the identifier of the Experiment to which this data set belongs.
|
ch.systemsx.cisd.openbis.generic.shared.basic.dto.ExternalDataManagementSystem |
getExternalDataManagementSystem() |
java.lang.String |
getExternalDataSetCode() |
java.lang.String |
getExternalDataSetLink() |
DataSetFetchOptions |
getFetchOptions() |
java.lang.Long |
getId()
Returns tech id of the data set.
|
java.util.List<ch.systemsx.cisd.openbis.generic.shared.basic.dto.Metaproject> |
getMetaprojects() |
java.util.List<java.lang.String> |
getParentCodes()
Return the parent codes.
|
java.util.HashMap<java.lang.String,java.lang.String> |
getProperties() |
java.util.Date |
getRegistrationDate() |
EntityRegistrationDetails |
getRegistrationDetails()
Return the data set registration details.
|
java.util.EnumSet<DataSet.Connections> |
getRetrievedConnections() |
java.lang.String |
getSampleIdentifierOrNull() |
int |
hashCode() |
boolean |
isContainerDataSet() |
boolean |
isLinkDataSet() |
boolean |
isStorageConfirmed() |
boolean |
isStub() |
void |
setFetchOptions(DataSetFetchOptions fetchOptions) |
void |
setStorageConfirmed(boolean storageConfirmed) |
java.lang.String |
toString() |
public DataSet(DataSet.DataSetInitializer initializer)
java.lang.IllegalArgumentException
- if some of the required information is not provided.public java.lang.Long getId()
getId
in interface ch.systemsx.cisd.openbis.generic.shared.basic.IIdHolder
null
if there is no Id.public java.lang.String getCode()
public java.lang.String getExperimentIdentifier()
null
if this data set is not completely filled with all information
available. That is, getExperimentIdentifier()
== null
indicates
that getSampleIdentifierOrNull()
, getProperties()
,
getChildrenCodes()
, getParentCodes()
, and
getContainedDataSets()
do not return correct results.public java.lang.String getSampleIdentifierOrNull()
public java.lang.String getDataSetTypeCode()
public java.util.Date getRegistrationDate()
public java.util.HashMap<java.lang.String,java.lang.String> getProperties()
public java.util.List<ch.systemsx.cisd.openbis.generic.shared.basic.dto.Metaproject> getMetaprojects() throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
public java.util.EnumSet<DataSet.Connections> getRetrievedConnections()
public java.util.List<java.lang.String> getParentCodes() throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
- Thrown if the parent codes were not retrieved from the
server.public java.util.List<java.lang.String> getChildrenCodes() throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
- Thrown if the children codes were not retrieved from the
server.public EntityRegistrationDetails getRegistrationDetails()
public boolean isContainerDataSet()
public DataSet getContainerOrNull()
public boolean isLinkDataSet()
public java.lang.String getExternalDataSetCode()
public java.lang.String getExternalDataSetLink()
public ch.systemsx.cisd.openbis.generic.shared.basic.dto.ExternalDataManagementSystem getExternalDataManagementSystem()
public java.util.List<DataSet> getContainedDataSets()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public DataSetFetchOptions getFetchOptions()
public void setFetchOptions(DataSetFetchOptions fetchOptions)
public boolean isStorageConfirmed()
public void setStorageConfirmed(boolean storageConfirmed)
public boolean isStub()