Class BioAssay
- java.lang.Object
-
- ubic.gemma.model.common.AbstractDescribable
-
- ubic.gemma.model.expression.bioAssay.BioAssay
-
- All Implemented Interfaces:
gemma.gsec.model.Securable,gemma.gsec.model.SecuredChild,Serializable,Securable,SecuredChild,Describable,Identifiable
@Indexed public class BioAssay extends AbstractDescribable implements SecuredChild, Serializable
Represents the bringing together of a biomaterial with an assay of some sort (typically an expression assay). We don't distinguish between "physical" and "computational" BioAssays, so this is a concrete class. This has several slots that are used specifically to support sequence-based data, but is intended to be generic.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classBioAssay.Factory
-
Constructor Summary
Constructors Constructor Description BioAssay()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object object)Returnstrueif the argument is an Describable instance and all identifiers for this entity equal the identifiers of the argument entity.DatabaseEntrygetAccession()ArrayDesigngetArrayDesignUsed()StringgetDescription()Obtain a human-readable description of the objectStringgetFastqHeaders()LonggetId()BooleangetIsOutlier()StringgetMetadata()StringgetName()Obtain the name of an object is a possibly ambiguous human-readable identifier that need not be an external database reference.ArrayDesigngetOriginalPlatform()DategetProcessingDate()BioMaterialgetSampleUsed()SecurablegetSecurityOwner()BooleangetSequencePairedReads()LonggetSequenceReadCount()IntegergetSequenceReadLength()inthashCode()Returns a hash code based on this entity's identifiers.voidsetAccession(DatabaseEntry accession)voidsetArrayDesignUsed(ArrayDesign arrayDesignUsed)voidsetFastqHeaders(String fastqHeaders)voidsetIsOutlier(Boolean isOutlier)voidsetMetadata(String metadata)voidsetOriginalPlatform(ArrayDesign originalPlatform)voidsetProcessingDate(Date processingDate)voidsetSampleUsed(BioMaterial sampleUsed)voidsetSequencePairedReads(Boolean sequencePairedReads)voidsetSequenceReadCount(Long sequenceReadCount)voidsetSequenceReadLength(Integer sequenceReadLength)-
Methods inherited from class ubic.gemma.model.common.AbstractDescribable
setDescription, setId, setName, toString
-
-
-
-
Method Detail
-
hashCode
public int hashCode()
Description copied from class:AbstractDescribableReturns a hash code based on this entity's identifiers.- Overrides:
hashCodein classAbstractDescribable
-
equals
public boolean equals(Object object)
Description copied from class:AbstractDescribableReturnstrueif the argument is an Describable instance and all identifiers for this entity equal the identifiers of the argument entity. Returnsfalseotherwise.- Overrides:
equalsin classAbstractDescribable
-
getId
@DocumentId public Long getId()
- Specified by:
getIdin interfaceIdentifiable- Specified by:
getIdin interfacegemma.gsec.model.Securable- Overrides:
getIdin classAbstractDescribable
-
getName
@Field public String getName()
Description copied from interface:DescribableObtain the name of an object is a possibly ambiguous human-readable identifier that need not be an external database reference.- Specified by:
getNamein interfaceDescribable- Overrides:
getNamein classAbstractDescribable
-
getDescription
@Field(store=YES) public String getDescription()
Description copied from interface:DescribableObtain a human-readable description of the object- Specified by:
getDescriptionin interfaceDescribable- Overrides:
getDescriptionin classAbstractDescribable
-
getAccession
@Nullable @IndexedEmbedded public DatabaseEntry getAccession()
-
setAccession
public void setAccession(@Nullable DatabaseEntry accession)
-
getArrayDesignUsed
public ArrayDesign getArrayDesignUsed()
-
setArrayDesignUsed
public void setArrayDesignUsed(ArrayDesign arrayDesignUsed)
-
getIsOutlier
public Boolean getIsOutlier()
- Returns:
- Used to indicate if the sample should be considered an outlier based on QC. The audit trail for the entity tracks when this was done.
-
setIsOutlier
public void setIsOutlier(Boolean isOutlier)
-
getProcessingDate
public Date getProcessingDate()
- Returns:
- Indicates the date that the assay was processed in the original study. This would correspond to "batch" information and will often be a "scan date" or similar information extracted from the raw data files.
-
setProcessingDate
public void setProcessingDate(Date processingDate)
-
getSampleUsed
@IndexedEmbedded public BioMaterial getSampleUsed()
-
setSampleUsed
public void setSampleUsed(BioMaterial sampleUsed)
-
getSecurityOwner
public Securable getSecurityOwner()
- Specified by:
getSecurityOwnerin interfacegemma.gsec.model.SecuredChild- Specified by:
getSecurityOwnerin interfaceSecuredChild
-
getSequencePairedReads
@Nullable public Boolean getSequencePairedReads()
- Returns:
- For sequence-based data, this should be set to true if the sequencing was paired-end reads and false otherwise. It should be left as null if it isn't known.
-
getSequenceReadCount
@Nullable public Long getSequenceReadCount()
- Returns:
- For sequence-read based data, the total number of reads in the sample, computed from the data as the total of the values for the elements assayed.
-
getSequenceReadLength
@Nullable public Integer getSequenceReadLength()
- Returns:
- For sequencing-based data, the length of the reads. If it was paired reads, this is understood to be the length for each "end". If the read length was variable (due to quality trimming, etc.) this will be treated as representing the mean read length.
-
getMetadata
public String getMetadata()
-
setMetadata
public void setMetadata(String metadata)
-
getOriginalPlatform
public ArrayDesign getOriginalPlatform()
-
setOriginalPlatform
public void setOriginalPlatform(ArrayDesign originalPlatform)
-
getFastqHeaders
public String getFastqHeaders()
-
setFastqHeaders
public void setFastqHeaders(String fastqHeaders)
-
-