java.lang.Object
- ca.corefacility.bioinformatics.irida.model.IridaRepresentationModel
- - ca.corefacility.bioinformatics.irida.model.sample.Sample

All Implemented Interfaces:

IridaThing, MutableIridaThing, RemoteSynchronizable, Timestamped<java.lang.Long>, java.lang.Comparable<Sample>
```
@Entity
public class Sample
extends IridaRepresentationModel
implements MutableIridaThing, java.lang.Comparable<Sample>, RemoteSynchronizable
```
A biological sample. Each sample may correspond to many files. A Sample comprises of many attributes. The attributes assigned to a Sample correspond to the NCBI Pathogen BioSample attributes. See BioSample Attributes: Package Pathogen for more information.

Constructor Summary

Constructors
Constructor Description

Sample()

Sample(java.lang.String sampleName)
Create a new Sample with the given name

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(Sample other)`
`boolean`	`equals(java.lang.Object other)`
`java.lang.String`	`getCollectedBy()`
`java.util.Date`	`getCollectionDate()`
`java.util.Date`	`getCreatedDate()`	Get the created date of the object
`GenomeAssembly`	`getDefaultGenomeAssembly()`
`SequencingObject`	`getDefaultSequencingObject()`
`java.lang.String`	`getDescription()`
`java.lang.String`	`getGeographicLocationName()`
`java.lang.Long`	`getId()`	Get the numerical identifier for this object
`java.lang.String`	`getIsolate()`
`java.lang.String`	`getIsolationSource()`
`java.lang.String`	`getLabel()`	Get a human readable label for this object.
`java.lang.String`	`getLatitude()`
`java.lang.String`	`getLongitude()`
`java.util.Date`	`getModifiedDate()`	Get the date that this object was last modified
`java.lang.String`	`getOrganism()`
`RemoteStatus`	`getRemoteStatus()`	Get the `RemoteStatus` for this object if it was read from a remote source
`java.lang.String`	`getSampleName()`
`java.lang.String`	`getStrain()`
`int`	`hashCode()`
`void`	`setCollectedBy(java.lang.String collectedBy)`
`void`	`setCollectionDate(java.util.Date collectionDate)`
`void`	`setCreatedDate(java.util.Date createdDate)`
`void`	`setDefaultGenomeAssembly(GenomeAssembly genomeAssembly)`
`void`	`setDefaultSequencingObject(SequencingObject sequencingObject)`
`void`	`setDescription(java.lang.String description)`
`void`	`setGeographicLocationName(java.lang.String geographicLocationName)`
`void`	`setId(java.lang.Long id)`	Set the numerical identifier for this object
`void`	`setIsolate(java.lang.String isolate)`
`void`	`setIsolationSource(java.lang.String isolationSource)`
`void`	`setLatitude(java.lang.String latitude)`
`void`	`setLongitude(java.lang.String longitude)`
`void`	`setModifiedDate(java.util.Date modifiedDate)`	Set the modification time of this object
`void`	`setOrganism(java.lang.String organism)`
`void`	`setRemoteStatus(RemoteStatus status)`	Set the `RemoteStatus` for this object if it was read from a remote source
`void`	`setSampleName(java.lang.String sampleName)`
`void`	`setStrain(java.lang.String strain)`
`java.lang.String`	`toString()`

Methods inherited from class ca.corefacility.bioinformatics.irida.model.IridaRepresentationModel
add, add, getLink, getLinks, getSelfHref, hasLink, hasLinks, removeLinks

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

Methods inherited from interface ca.corefacility.bioinformatics.irida.model.IridaThing
getIdentifier, setLabel

Methods inherited from interface ca.corefacility.bioinformatics.irida.model.remote.RemoteSynchronizable
isRemote

- Constructor Detail
  - Sample
```
public Sample()
```
  - Sample
```
public Sample(java.lang.String sampleName)
```
    Create a new Sample with the given name
    
    Parameters:
    
    sampleName - The name of the sample
- Method Detail
  - equals
```
public boolean equals(java.lang.Object other)
```
    Description copied from class: IridaRepresentationModel
    
    Overrides:
    
    equals in class IridaRepresentationModel
  - hashCode
```
public int hashCode()
```
    Description copied from class: IridaRepresentationModel
    
    Overrides:
    
    hashCode in class IridaRepresentationModel
  - compareTo
```
public int compareTo(Sample other)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<Sample>
  - toString
```
public java.lang.String toString()
```
    Description copied from class: IridaRepresentationModel
    
    Overrides:
    
    toString in class IridaRepresentationModel
  - getId
```
public java.lang.Long getId()
```
    Description copied from interface: IridaThing
    
    Get the numerical identifier for this object
    
    Specified by:
    
    getId in interface IridaThing
    
    Specified by:
    
    getId in interface Timestamped<java.lang.Long>
    
    Returns:
    
    the numerical identifier for the object
  - setId
```
public void setId(java.lang.Long id)
```
    Description copied from interface: MutableIridaThing
    
    Set the numerical identifier for this object
    
    Specified by:
    
    setId in interface MutableIridaThing
    
    Parameters:
    
    id - The ID to set
  - getSampleName
```
public java.lang.String getSampleName()
```
  - setSampleName
```
public void setSampleName(java.lang.String sampleName)
```
  - getDescription
```
public java.lang.String getDescription()
```
  - setDescription
```
public void setDescription(java.lang.String description)
```
  - getLabel
```
public java.lang.String getLabel()
```
    Description copied from interface: IridaThing
    
    Get a human readable label for this object.
    
    Specified by:
    
    getLabel in interface IridaThing
    
    Returns:
    
    a human-readable label for the object.
  - getModifiedDate
```
public java.util.Date getModifiedDate()
```
    Description copied from interface: MutableIridaThing
    
    Get the date that this object was last modified
    
    Specified by:
    
    getModifiedDate in interface MutableIridaThing
    
    Returns:
    
    Date object of the modified date
  - setModifiedDate
```
public void setModifiedDate(java.util.Date modifiedDate)
```
    Description copied from interface: MutableIridaThing
    
    Set the modification time of this object
    
    Specified by:
    
    setModifiedDate in interface MutableIridaThing
    
    Parameters:
    
    modifiedDate - The date where this object was modified
  - setCreatedDate
```
public void setCreatedDate(java.util.Date createdDate)
```
  - getCreatedDate
```
public java.util.Date getCreatedDate()
```
    Description copied from interface: Timestamped
    
    Get the created date of the object
    
    Specified by:
    
    getCreatedDate in interface Timestamped<java.lang.Long>
    
    Returns:
    
    A Date object of the created date
  - getStrain
```
public java.lang.String getStrain()
```
  - setStrain
```
public void setStrain(java.lang.String strain)
```
  - getCollectionDate
```
public java.util.Date getCollectionDate()
```
  - setCollectionDate
```
public void setCollectionDate(java.util.Date collectionDate)
```
  - getCollectedBy
```
public java.lang.String getCollectedBy()
```
  - setCollectedBy
```
public void setCollectedBy(java.lang.String collectedBy)
```
  - getLatitude
```
public java.lang.String getLatitude()
```
  - setLatitude
```
public void setLatitude(java.lang.String latitude)
```
  - getLongitude
```
public java.lang.String getLongitude()
```
  - setLongitude
```
public void setLongitude(java.lang.String longitude)
```
  - getOrganism
```
public java.lang.String getOrganism()
```
  - setOrganism
```
public void setOrganism(java.lang.String organism)
```
  - getIsolate
```
public java.lang.String getIsolate()
```
  - setIsolate
```
public void setIsolate(java.lang.String isolate)
```
  - getGeographicLocationName
```
public java.lang.String getGeographicLocationName()
```
  - setGeographicLocationName
```
public void setGeographicLocationName(java.lang.String geographicLocationName)
```
  - getIsolationSource
```
public java.lang.String getIsolationSource()
```
  - setIsolationSource
```
public void setIsolationSource(java.lang.String isolationSource)
```
  - getRemoteStatus
```
public RemoteStatus getRemoteStatus()
```
    Description copied from class: IridaRepresentationModel
    
    Get the RemoteStatus for this object if it was read from a remote source
    
    Specified by:
    
    getRemoteStatus in interface RemoteSynchronizable
    
    Overrides:
    
    getRemoteStatus in class IridaRepresentationModel
    
    Returns:
    
    a RemoteStatus
  - setRemoteStatus
```
public void setRemoteStatus(RemoteStatus status)
```
    Description copied from class: IridaRepresentationModel
    
    Set the RemoteStatus for this object if it was read from a remote source
    
    Specified by:
    
    setRemoteStatus in interface RemoteSynchronizable
    
    Overrides:
    
    setRemoteStatus in class IridaRepresentationModel
    
    Parameters:
    
    status - the RemoteStatus object
  - getDefaultSequencingObject
```
public SequencingObject getDefaultSequencingObject()
```
  - setDefaultSequencingObject
```
public void setDefaultSequencingObject(SequencingObject sequencingObject)
```
  - getDefaultGenomeAssembly
```
public GenomeAssembly getDefaultGenomeAssembly()
```
  - setDefaultGenomeAssembly
```
public void setDefaultGenomeAssembly(GenomeAssembly genomeAssembly)
```

Constructor	Description
`Sample()`
`Sample(java.lang.String sampleName)`	Create a new `Sample` with the given name

Class Sample

Constructor Summary

Method Summary

Methods inherited from class ca.corefacility.bioinformatics.irida.model.IridaRepresentationModel

Methods inherited from class java.lang.Object

Methods inherited from interface ca.corefacility.bioinformatics.irida.model.IridaThing

Methods inherited from interface ca.corefacility.bioinformatics.irida.model.remote.RemoteSynchronizable

Constructor Detail

Sample

Sample

Method Detail

equals

hashCode

compareTo

toString

getId

setId

getSampleName

setSampleName

getDescription

setDescription

getLabel

getModifiedDate

setModifiedDate

setCreatedDate

getCreatedDate

getStrain

setStrain

getCollectionDate

setCollectionDate

getCollectedBy

setCollectedBy

getLatitude

setLatitude

getLongitude

setLongitude

getOrganism

setOrganism

getIsolate

setIsolate

getGeographicLocationName

setGeographicLocationName

getIsolationSource

setIsolationSource

getRemoteStatus

setRemoteStatus

getDefaultSequencingObject

setDefaultSequencingObject

getDefaultGenomeAssembly

setDefaultGenomeAssembly