Dataset (ICAT Clients 5.0.0 API)

java.lang.Object
- org.icatproject.EntityBaseBean
- - org.icatproject.Dataset

public class Dataset
extends EntityBaseBean

Java class for dataset complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="dataset">
   <complexContent>
     <extension base="{http://icatproject.org}entityBaseBean">
       <sequence>
         <element name="complete" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="dataCollectionDatasets" type="{http://icatproject.org}dataCollectionDataset" maxOccurs="unbounded" minOccurs="0"/>
         <element name="datafiles" type="{http://icatproject.org}datafile" maxOccurs="unbounded" minOccurs="0"/>
         <element name="datasetInstruments" type="{http://icatproject.org}datasetInstrument" maxOccurs="unbounded" minOccurs="0"/>
         <element name="datasetTechniques" type="{http://icatproject.org}datasetTechnique" maxOccurs="unbounded" minOccurs="0"/>
         <element name="description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="doi" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="endDate" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="fileCount" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="fileSize" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="investigation" type="{http://icatproject.org}investigation" minOccurs="0"/>
         <element name="location" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="parameters" type="{http://icatproject.org}datasetParameter" maxOccurs="unbounded" minOccurs="0"/>
         <element name="sample" type="{http://icatproject.org}sample" minOccurs="0"/>
         <element name="startDate" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="type" type="{http://icatproject.org}datasetType" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`complete`
`protected List<DataCollectionDataset>`	`dataCollectionDatasets`
`protected List<Datafile>`	`datafiles`
`protected List<DatasetInstrument>`	`datasetInstruments`
`protected List<DatasetTechnique>`	`datasetTechniques`
`protected String`	`description`
`protected String`	`doi`
`protected XMLGregorianCalendar`	`endDate`
`protected Long`	`fileCount`
`protected Long`	`fileSize`
`protected Investigation`	`investigation`
`protected String`	`location`
`protected String`	`name`
`protected List<DatasetParameter>`	`parameters`
`protected Sample`	`sample`
`protected XMLGregorianCalendar`	`startDate`
`protected DatasetType`	`type`

Fields inherited from class org.icatproject.EntityBaseBean
createId, createTime, id, modId, modTime

Constructor Summary

Constructors
Constructor and Description

Dataset()

Constructors
Constructor and Description
`Dataset()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<DataCollectionDataset>`	`getDataCollectionDatasets()` Gets the value of the dataCollectionDatasets property.
`List<Datafile>`	`getDatafiles()` Gets the value of the datafiles property.
`List<DatasetInstrument>`	`getDatasetInstruments()` Gets the value of the datasetInstruments property.
`List<DatasetTechnique>`	`getDatasetTechniques()` Gets the value of the datasetTechniques property.
`String`	`getDescription()` Gets the value of the description property.
`String`	`getDoi()` Gets the value of the doi property.
`XMLGregorianCalendar`	`getEndDate()` Gets the value of the endDate property.
`Long`	`getFileCount()` Gets the value of the fileCount property.
`Long`	`getFileSize()` Gets the value of the fileSize property.
`Investigation`	`getInvestigation()` Gets the value of the investigation property.
`String`	`getLocation()` Gets the value of the location property.
`String`	`getName()` Gets the value of the name property.
`List<DatasetParameter>`	`getParameters()` Gets the value of the parameters property.
`Sample`	`getSample()` Gets the value of the sample property.
`XMLGregorianCalendar`	`getStartDate()` Gets the value of the startDate property.
`DatasetType`	`getType()` Gets the value of the type property.
`boolean`	`isComplete()` Gets the value of the complete property.
`void`	`setComplete(boolean value)` Sets the value of the complete property.
`void`	`setDescription(String value)` Sets the value of the description property.
`void`	`setDoi(String value)` Sets the value of the doi property.
`void`	`setEndDate(XMLGregorianCalendar value)` Sets the value of the endDate property.
`void`	`setFileCount(Long value)` Sets the value of the fileCount property.
`void`	`setFileSize(Long value)` Sets the value of the fileSize property.
`void`	`setInvestigation(Investigation value)` Sets the value of the investigation property.
`void`	`setLocation(String value)` Sets the value of the location property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setSample(Sample value)` Sets the value of the sample property.
`void`	`setStartDate(XMLGregorianCalendar value)` Sets the value of the startDate property.
`void`	`setType(DatasetType value)` Sets the value of the type property.

Methods inherited from class org.icatproject.EntityBaseBean
getCreateId, getCreateTime, getId, getModId, getModTime, setCreateId, setCreateTime, setId, setModId, setModTime

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

- Field Detail
  - complete
```
protected boolean complete
```
  - dataCollectionDatasets
```
protected List<DataCollectionDataset> dataCollectionDatasets
```
  - datafiles
```
protected List<Datafile> datafiles
```
  - datasetInstruments
```
protected List<DatasetInstrument> datasetInstruments
```
  - datasetTechniques
```
protected List<DatasetTechnique> datasetTechniques
```
  - description
```
protected String description
```
  - doi
```
protected String doi
```
  - endDate
```
protected XMLGregorianCalendar endDate
```
  - fileCount
```
protected Long fileCount
```
  - fileSize
```
protected Long fileSize
```
  - investigation
```
protected Investigation investigation
```
  - location
```
protected String location
```
  - name
```
protected String name
```
  - parameters
```
protected List<DatasetParameter> parameters
```
  - sample
```
protected Sample sample
```
  - startDate
```
protected XMLGregorianCalendar startDate
```
  - type
```
protected DatasetType type
```
- Constructor Detail
  - Dataset
```
public Dataset()
```
- Method Detail
  - isComplete
```
public boolean isComplete()
```
    Gets the value of the complete property.
  - setComplete
```
public void setComplete(boolean value)
```
    Sets the value of the complete property.
  - getDataCollectionDatasets
```
public List<DataCollectionDataset> getDataCollectionDatasets()
```
    Gets the value of the dataCollectionDatasets property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the dataCollectionDatasets property.
    For example, to add a new item, do as follows:
```
    getDataCollectionDatasets().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list DataCollectionDataset
  - getDatafiles
```
public List<Datafile> getDatafiles()
```
    Gets the value of the datafiles property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the datafiles property.
    For example, to add a new item, do as follows:
```
    getDatafiles().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Datafile
  - getDatasetInstruments
```
public List<DatasetInstrument> getDatasetInstruments()
```
    Gets the value of the datasetInstruments property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the datasetInstruments property.
    For example, to add a new item, do as follows:
```
    getDatasetInstruments().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list DatasetInstrument
  - getDatasetTechniques
```
public List<DatasetTechnique> getDatasetTechniques()
```
    Gets the value of the datasetTechniques property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the datasetTechniques property.
    For example, to add a new item, do as follows:
```
    getDatasetTechniques().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list DatasetTechnique
  - getDescription
```
public String getDescription()
```
    Gets the value of the description property.
    
    Returns:
    
    possible object is String
  - setDescription
```
public void setDescription(String value)
```
    Sets the value of the description property.
    
    Parameters:
    
    value - allowed object is String
  - getDoi
```
public String getDoi()
```
    Gets the value of the doi property.
    
    Returns:
    
    possible object is String
  - setDoi
```
public void setDoi(String value)
```
    Sets the value of the doi property.
    
    Parameters:
    
    value - allowed object is String
  - getEndDate
```
public XMLGregorianCalendar getEndDate()
```
    Gets the value of the endDate property.
    
    Returns:
    
    possible object is XMLGregorianCalendar
  - setEndDate
```
public void setEndDate(XMLGregorianCalendar value)
```
    Sets the value of the endDate property.
    
    Parameters:
    
    value - allowed object is XMLGregorianCalendar
  - getFileCount
```
public Long getFileCount()
```
    Gets the value of the fileCount property.
    
    Returns:
    
    possible object is Long
  - setFileCount
```
public void setFileCount(Long value)
```
    Sets the value of the fileCount property.
    
    Parameters:
    
    value - allowed object is Long
  - getFileSize
```
public Long getFileSize()
```
    Gets the value of the fileSize property.
    
    Returns:
    
    possible object is Long
  - setFileSize
```
public void setFileSize(Long value)
```
    Sets the value of the fileSize property.
    
    Parameters:
    
    value - allowed object is Long
  - getInvestigation
```
public Investigation getInvestigation()
```
    Gets the value of the investigation property.
    
    Returns:
    
    possible object is Investigation
  - setInvestigation
```
public void setInvestigation(Investigation value)
```
    Sets the value of the investigation property.
    
    Parameters:
    
    value - allowed object is Investigation
  - getLocation
```
public String getLocation()
```
    Gets the value of the location property.
    
    Returns:
    
    possible object is String
  - setLocation
```
public void setLocation(String value)
```
    Sets the value of the location property.
    
    Parameters:
    
    value - allowed object is String
  - getName
```
public String getName()
```
    Gets the value of the name property.
    
    Returns:
    
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is String
  - getParameters
```
public List<DatasetParameter> getParameters()
```
    Gets the value of the parameters property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the parameters property.
    For example, to add a new item, do as follows:
```
    getParameters().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list DatasetParameter
  - getSample
```
public Sample getSample()
```
    Gets the value of the sample property.
    
    Returns:
    
    possible object is Sample
  - setSample
```
public void setSample(Sample value)
```
    Sets the value of the sample property.
    
    Parameters:
    
    value - allowed object is Sample
  - getStartDate
```
public XMLGregorianCalendar getStartDate()
```
    Gets the value of the startDate property.
    
    Returns:
    
    possible object is XMLGregorianCalendar
  - setStartDate
```
public void setStartDate(XMLGregorianCalendar value)
```
    Sets the value of the startDate property.
    
    Parameters:
    
    value - allowed object is XMLGregorianCalendar
  - getType
```
public DatasetType getType()
```
    Gets the value of the type property.
    
    Returns:
    
    possible object is DatasetType
  - setType
```
public void setType(DatasetType value)
```
    Sets the value of the type property.
    
    Parameters:
    
    value - allowed object is DatasetType

Class Dataset

Field Summary

Fields inherited from class org.icatproject.EntityBaseBean

Constructor Summary

Method Summary

Methods inherited from class org.icatproject.EntityBaseBean

Methods inherited from class java.lang.Object

Field Detail

complete

dataCollectionDatasets

datafiles

datasetInstruments

datasetTechniques

description

doi

endDate

fileCount

fileSize

investigation

location

name

parameters

sample

startDate

type

Constructor Detail

Dataset

Method Detail

isComplete

setComplete

getDataCollectionDatasets

getDatafiles

getDatasetInstruments

getDatasetTechniques

getDescription

setDescription

getDoi

setDoi

getEndDate

setEndDate

getFileCount

setFileCount

getFileSize

setFileSize

getInvestigation

setInvestigation

getLocation

setLocation

getName

setName

getParameters

getSample

setSample

getStartDate

setStartDate

getType

setType