Documentation

ParseBlocksManager implements ParseDatabaseInterface

FinalYes

Class ParseBlocksManager A BLOCKS entry describes an ungapped conserved region of a protein family, not a sequence, so this class exposes plain scalars rather than the Sequence/Feature entities of ParseDbAbstractManager.

Tags
author

Amélie DUVERNET aka Amelaye amelieonline@gmail.com

Table of Contents

Interfaces

ParseDatabaseInterface
Interface ParseDatabaseInterface

Properties

$aaTriplet  : string
$accession  : string
$description  : string
$distMax  : int
$distMin  : int
$id  : string

Methods

__construct()  : mixed
Constructor.
getAaTriplet()  : string
getAccession()  : string
getDescription()  : string
getDistMax()  : int
Maximum distance, in residues, from the previous block of the family.
getDistMin()  : int
Minimum distance, in residues, from the previous block of the family.
getEntryId()  : string
Extracts the identifier uniquely naming a BLOCKS entry, read from its AC line.
getFormat()  : string
The name this format is known by in the collection records and in DatabaseParserFactory.
getId()  : string
isEntryEnd()  : bool
Tells whether a line closes a BLOCKS entry.
isEntryStart()  : bool
Tells whether a line opens a new BLOCKS entry.
parseDataFile()  : Sequence
Parses a BLOCKS data file and populates this manager's fields.
parseAccession()  : void
Reads the AC line, which carries the accession then the distance range to the previous block.
readLabel()  : string
Reads the label of a field line : two letters followed by three blanks. A sequence line of a block opens on its protein name in the first column, which may begin like a label (IDHP_HUMAN, ACON_YEAST, BLAC_ECOLX) and is no field.

Properties

Methods

getDistMax()

Maximum distance, in residues, from the previous block of the family.

public getDistMax() : int
Return values
int

getDistMin()

Minimum distance, in residues, from the previous block of the family.

public getDistMin() : int
Return values
int

getEntryId()

Extracts the identifier uniquely naming a BLOCKS entry, read from its AC line.

public static getEntryId(array<string|int, mixed> $aFlines, string $sLine) : string
Parameters
$aFlines : array<string|int, mixed>

The whole file, buffered

$sLine : string

The line opening the entry

Return values
string

getFormat()

The name this format is known by in the collection records and in DatabaseParserFactory.

public static getFormat() : string
Return values
string

isEntryEnd()

Tells whether a line closes a BLOCKS entry.

public static isEntryEnd(string $sLine) : bool
Parameters
$sLine : string

The line to analyze

Return values
bool

isEntryStart()

Tells whether a line opens a new BLOCKS entry.

public static isEntryStart(string $sLine) : bool
Parameters
$sLine : string

The line to analyze

Return values
bool

parseDataFile()

Parses a BLOCKS data file and populates this manager's fields.

public parseDataFile(array<string|int, mixed> $aFlines) : Sequence
Parameters
$aFlines : array<string|int, mixed>

The lines the script has to parse

Tags
throws
Exception
Return values
Sequence —

$oSequence

parseAccession()

Reads the AC line, which carries the accession then the distance range to the previous block.

private parseAccession(string $sData) : void

Example: AC IPB002128C; distance from previous block=(30,31)

Parameters
$sData : string

The AC line, tag stripped

readLabel()

Reads the label of a field line : two letters followed by three blanks. A sequence line of a block opens on its protein name in the first column, which may begin like a label (IDHP_HUMAN, ACON_YEAST, BLAC_ECOLX) and is no field.

private static readLabel(string $sLine) : string
Parameters
$sLine : string

The line to analyze

Return values
string —

The label, "" for a line holding none

On this page

Search results