Package com.ibm.fhir.model.resource
Class MolecularSequence
- java.lang.Object
-
- com.ibm.fhir.model.visitor.AbstractVisitable
-
- com.ibm.fhir.model.resource.Resource
-
- com.ibm.fhir.model.resource.DomainResource
-
- com.ibm.fhir.model.resource.MolecularSequence
-
- All Implemented Interfaces:
Visitable
@Generated("com.ibm.fhir.tools.CodeGenerator") public class MolecularSequence extends DomainResource
Raw data describing a biological sequence.Maturity level: FMM1 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMolecularSequence.Builderstatic classMolecularSequence.QualityAn experimental feature attribute that defines the quality of the feature in a quantitative way, such as a phred quality score ([SO:0001686](http://www.sequenceontology.org/browser/current_svn/term/SO:0001686)).static classMolecularSequence.ReferenceSeqA sequence that is used as a reference to describe variants that are present in a sequence analyzed.static classMolecularSequence.RepositoryConfigurations of the external repository.static classMolecularSequence.StructureVariantInformation about chromosome structure variation.static classMolecularSequence.VariantThe definition of variant here originates from Sequence ontology ([variant_of](http://www.sequenceontology.
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class com.ibm.fhir.model.resource.Resource
id, implicitRules, language, meta
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(String elementName, int elementIndex, Visitor visitor)Accept a Visitor and invoke the appropriate visit methods.static MolecularSequence.Builderbuilder()booleanequals(Object obj)IntegergetCoordinateSystem()Whether the sequence is numbered starting at 0 (0-based numbering or coordinates, inclusive start, exclusive end) or starting at 1 (1-based numbering, inclusive start and inclusive end).ReferencegetDevice()The method for sequencing, for example, chip information.List<Identifier>getIdentifier()A unique identifier for this particular sequence instance.StringgetObservedSeq()Sequence that was observed.ReferencegetPatient()The patient whose sequencing results are described by this resource.ReferencegetPerformer()The organization or lab that should be responsible for this result.List<Reference>getPointer()Pointer to next atomic sequence which at most contains one variant.List<MolecularSequence.Quality>getQuality()An experimental feature attribute that defines the quality of the feature in a quantitative way, such as a phred quality score ([SO:0001686](http://www.sequenceontology.org/browser/current_svn/term/SO:0001686)).QuantitygetQuantity()The number of copies of the sequence of interest.IntegergetReadCoverage()Coverage (read depth or depth) is the average number of reads representing a given nucleotide in the reconstructed sequence.MolecularSequence.ReferenceSeqgetReferenceSeq()A sequence that is used as a reference to describe variants that are present in a sequence analyzed.List<MolecularSequence.Repository>getRepository()Configurations of the external repository.ReferencegetSpecimen()Specimen used for sequencing.List<MolecularSequence.StructureVariant>getStructureVariant()Information about chromosome structure variation.SequenceTypegetType()Amino Acid Sequence/ DNA Sequence / RNA Sequence.List<MolecularSequence.Variant>getVariant()The definition of variant here originates from Sequence ontology ([variant_of](http://www.sequenceontology.booleanhasChildren()inthashCode()MolecularSequence.BuildertoBuilder()Create a new Builder from the contents of this Resource-
Methods inherited from class com.ibm.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class com.ibm.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
A unique identifier for this particular sequence instance. This is a FHIR-defined id.- Returns:
- An unmodifiable list containing immutable objects of type
Identifierthat may be empty.
-
getType
public SequenceType getType()
Amino Acid Sequence/ DNA Sequence / RNA Sequence.- Returns:
- An immutable object of type
SequenceTypethat may be null.
-
getCoordinateSystem
public Integer getCoordinateSystem()
Whether the sequence is numbered starting at 0 (0-based numbering or coordinates, inclusive start, exclusive end) or starting at 1 (1-based numbering, inclusive start and inclusive end).- Returns:
- An immutable object of type
Integerthat is non-null.
-
getPatient
public Reference getPatient()
The patient whose sequencing results are described by this resource.- Returns:
- An immutable object of type
Referencethat may be null.
-
getSpecimen
public Reference getSpecimen()
Specimen used for sequencing.- Returns:
- An immutable object of type
Referencethat may be null.
-
getDevice
public Reference getDevice()
The method for sequencing, for example, chip information.- Returns:
- An immutable object of type
Referencethat may be null.
-
getPerformer
public Reference getPerformer()
The organization or lab that should be responsible for this result.- Returns:
- An immutable object of type
Referencethat may be null.
-
getQuantity
public Quantity getQuantity()
The number of copies of the sequence of interest. (RNASeq).- Returns:
- An immutable object of type
Quantitythat may be null.
-
getReferenceSeq
public MolecularSequence.ReferenceSeq getReferenceSeq()
A sequence that is used as a reference to describe variants that are present in a sequence analyzed.- Returns:
- An immutable object of type
MolecularSequence.ReferenceSeqthat may be null.
-
getVariant
public List<MolecularSequence.Variant> getVariant()
The definition of variant here originates from Sequence ontology ([variant_of](http://www.sequenceontology. org/browser/current_svn/term/variant_of)). This element can represent amino acid or nucleic sequence change(including insertion,deletion,SNP,etc.) It can represent some complex mutation or segment variation with the assist of CIGAR string.- Returns:
- An unmodifiable list containing immutable objects of type
MolecularSequence.Variantthat may be empty.
-
getObservedSeq
public String getObservedSeq()
Sequence that was observed. It is the result marked by referenceSeq along with variant records on referenceSeq. This shall start from referenceSeq.windowStart and end by referenceSeq.windowEnd.- Returns:
- An immutable object of type
Stringthat may be null.
-
getQuality
public List<MolecularSequence.Quality> getQuality()
An experimental feature attribute that defines the quality of the feature in a quantitative way, such as a phred quality score ([SO:0001686](http://www.sequenceontology.org/browser/current_svn/term/SO:0001686)).- Returns:
- An unmodifiable list containing immutable objects of type
MolecularSequence.Qualitythat may be empty.
-
getReadCoverage
public Integer getReadCoverage()
Coverage (read depth or depth) is the average number of reads representing a given nucleotide in the reconstructed sequence.- Returns:
- An immutable object of type
Integerthat may be null.
-
getRepository
public List<MolecularSequence.Repository> getRepository()
Configurations of the external repository. The repository shall store target's observedSeq or records related with target's observedSeq.- Returns:
- An unmodifiable list containing immutable objects of type
MolecularSequence.Repositorythat may be empty.
-
getPointer
public List<Reference> getPointer()
Pointer to next atomic sequence which at most contains one variant.- Returns:
- An unmodifiable list containing immutable objects of type
Referencethat may be empty.
-
getStructureVariant
public List<MolecularSequence.StructureVariant> getStructureVariant()
Information about chromosome structure variation.- Returns:
- An unmodifiable list containing immutable objects of type
MolecularSequence.StructureVariantthat may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildrenin classDomainResource
-
accept
public void accept(String elementName, int elementIndex, Visitor visitor)
Description copied from interface:VisitableAccept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }- Specified by:
acceptin interfaceVisitable- Specified by:
acceptin classAbstractVisitable- Parameters:
elementName- the name of the element in the context of this visitelementIndex- the index of the element in a list or -1 if it is not contained within a Listvisitor- the visitor to use
-
toBuilder
public MolecularSequence.Builder toBuilder()
Description copied from class:ResourceCreate a new Builder from the contents of this Resource- Specified by:
toBuilderin classDomainResource
-
builder
public static MolecularSequence.Builder builder()
-
-