|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectch.systemsx.cisd.openbis.generic.shared.api.v1.dto.DataSet
@JsonObject(value="DataSet") public final class DataSet
Immutable value object representing a data set.
Nested Class Summary | |
---|---|
static class |
DataSet.Connections
|
static class |
DataSet.DataSetInitializer
Class used to initialize a new data set instance. |
Constructor Summary | |
---|---|
DataSet(DataSet.DataSetInitializer initializer)
Creates a new instance with the provided initializer |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
|
java.util.List<java.lang.String> |
getChildrenCodes()
Return the children codes. |
java.lang.String |
getCode()
Returns the sample code; |
java.util.List<DataSet> |
getContainedDataSets()
|
java.lang.String |
getDataSetTypeCode()
|
java.lang.String |
getExperimentIdentifier()
Returns the identifier of the Experiment to which this data set belongs. |
DataSetFetchOptions |
getFetchOptions()
|
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()
|
void |
setContainedDataSets(java.util.List<DataSet> containedDataSets)
|
void |
setContainerDataSet(boolean containerDataSet)
|
void |
setFetchOptions(DataSetFetchOptions fetchOptions)
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DataSet(DataSet.DataSetInitializer initializer)
java.lang.IllegalArgumentException
- if some of the required information is not provided.Method Detail |
---|
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.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 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 void setContainerDataSet(boolean containerDataSet)
public void setContainedDataSets(java.util.List<DataSet> containedDataSets)
public DataSetFetchOptions getFetchOptions()
public void setFetchOptions(DataSetFetchOptions fetchOptions)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |