Documentation

Feature

Class GbFeatures

Tags
author

Amélie DUVERNET aka Amelaye amelieonline@gmail.com

Attributes
#[Entity]
#[Index]
$name: "feature_prim_acc"
$columns: ["prim_acc"]
#[Table]
$name: "feature"

Table of Contents

Properties

$ftDesc  : string
$ftFrom  : int
$ftKey  : string
$ftLocation  : string|null
The location exactly as the record wrote it (INSDC syntax, e.g. "join(94..300,401..1482)").
$ftQual  : string
$ftTo  : int
$ftValue  : string
$id  : int|null
$primAcc  : string
The primary accession of the sequence this row belongs to : a plain column, so that a parsed record can be stored as the parser builds it, with its accession as a string.
$strand  : string|null
The strand the feature was read from : "+" (direct/sense) or "-" (the location was wrapped in "complement(...)"). Null when the format has no strand concept (e.g. Swiss-Prot, whose features are positions on a protein sequence), when the feature lies on both strands (a trans-spliced join(complement(a..b),c..d)) or when none was recorded.

Methods

getFtDesc()  : string
getFtFrom()  : int|null
getFtKey()  : string
getFtLocation()  : string|null
getFtQual()  : string
getFtTo()  : int|null
getFtValue()  : string
getId()  : int|null
getPrimAcc()  : string
getStrand()  : string|null
isPartial()  : bool
Tells whether the feature extends beyond the bases its location gives ("<1..206", the start lies before base 1 ; "1..>888", the end lies after base 888), as the location was written.
setFtDesc()  : void
setFtFrom()  : void
setFtKey()  : void
setFtLocation()  : void
setFtQual()  : void
setFtTo()  : void
setFtValue()  : void
setPrimAcc()  : void
setStrand()  : void

Properties

$ftDesc

private string $ftDesc = ""
Attributes
#[Column]
$type: "text"

$ftFrom

private int $ftFrom = null
Attributes
#[Column]
$type: "integer"
$length: 11
$nullable: true

$ftKey

private string $ftKey = ""
Attributes
#[Column]
$type: "string"
$length: 20
$nullable: false

$ftLocation

The location exactly as the record wrote it (INSDC syntax, e.g. "join(94..300,401..1482)").

private string|null $ftLocation = null

ftFrom and ftTo only keep its outer bounds : this keeps the exons of a spliced feature, and any partial ("<", ">") mark. Null when the format has no such syntax or none was recorded.

Attributes
#[Column]
$type: "text"
$nullable: true

$ftQual

private string $ftQual = ""
Attributes
#[Column]
$type: "string"
$length: 60
$nullable: false

$ftTo

private int $ftTo = null
Attributes
#[Column]
$type: "integer"
$length: 11
$nullable: true

$ftValue

private string $ftValue = ""
Attributes
#[Column]
$type: "text"

$id

private int|null $id = null
Attributes
#[Column]
$type: "integer"
#[GeneratedValue]
#[Id]

$primAcc

The primary accession of the sequence this row belongs to : a plain column, so that a parsed record can be stored as the parser builds it, with its accession as a string.

private string $primAcc = ""
Attributes
#[Column]
$type: "string"
$length: 50
$nullable: false

$strand

The strand the feature was read from : "+" (direct/sense) or "-" (the location was wrapped in "complement(...)"). Null when the format has no strand concept (e.g. Swiss-Prot, whose features are positions on a protein sequence), when the feature lies on both strands (a trans-spliced join(complement(a..b),c..d)) or when none was recorded.

private string|null $strand = null
Attributes
#[Column]
$type: "string"
$length: 1
$nullable: true

Methods

getFtDesc()

public getFtDesc() : string
Return values
string

getFtFrom()

public getFtFrom() : int|null
Return values
int|null

getFtKey()

public getFtKey() : string
Return values
string

getFtLocation()

public getFtLocation() : string|null
Return values
string|null

getFtQual()

public getFtQual() : string
Return values
string

getFtTo()

public getFtTo() : int|null
Return values
int|null

getFtValue()

public getFtValue() : string
Return values
string

getId()

public getId() : int|null
Return values
int|null —

Null until the row is stored

getPrimAcc()

public getPrimAcc() : string
Return values
string

getStrand()

public getStrand() : string|null
Return values
string|null

isPartial()

Tells whether the feature extends beyond the bases its location gives ("<1..206", the start lies before base 1 ; "1..>888", the end lies after base 888), as the location was written.

public isPartial() : bool
Return values
bool —

False as well when no location was recorded

setFtDesc()

public setFtDesc(string $ftDesc) : void
Parameters
$ftDesc : string

setFtFrom()

public setFtFrom(int|null $ftFrom) : void
Parameters
$ftFrom : int|null

setFtKey()

public setFtKey(string $ftKey) : void
Parameters
$ftKey : string

setFtLocation()

public setFtLocation(string|null $ftLocation) : void
Parameters
$ftLocation : string|null

setFtQual()

public setFtQual(string $ftQual) : void
Parameters
$ftQual : string

setFtTo()

public setFtTo(int|null $ftTo) : void
Parameters
$ftTo : int|null

setFtValue()

public setFtValue(string $ftValue) : void
Parameters
$ftValue : string

setPrimAcc()

public setPrimAcc(string $primAcc) : void
Parameters
$primAcc : string

setStrand()

public setStrand(string|null $strand) : void
Parameters
$strand : string|null
On this page

Search results