Documentation

ParseProdomManager implements ParseDatabaseInterface

FinalYes

Class ParseProdomManager A ProDom entry describes a family of protein domains, not a sequence, so this class exposes plain scalars rather than the Sequence/Feature entities of ParseDbAbstractManager. Only the fields the original BioPHP parser read are decomposed : the alignment block (AL/CO) and the cross-references (DR) are left aside, as they were there.

Tags
author

Amélie DUVERNET aka Amelaye amelieonline@gmail.com

Table of Contents

Interfaces

ParseDatabaseInterface
Interface ParseDatabaseInterface

Properties

$accession  : string
$domainCount  : int
$entryNo  : string
$freqNames  : array<string|int, mixed>
$keywords  : array<string|int, mixed>
$release  : string

Methods

__construct()  : mixed
Constructor.
getAccession()  : string
getDomainCount()  : int
getEntryId()  : string
Extracts the identifier uniquely naming a ProDom entry, read from its AC line.
getEntryNo()  : string
getFormat()  : string
The name this format is known by in the collection records and in DatabaseParserFactory.
getFreqNames()  : array<string|int, mixed>
Frequent protein names, keyed by name, valued by how many times they occur.
getKeywords()  : array<string|int, mixed>
getRelease()  : string
isEntryEnd()  : bool
Tells whether a line closes a ProDom entry.
isEntryStart()  : bool
Tells whether a line opens a new ProDom entry.
parseDataFile()  : Sequence
Parses a ProDom data file and populates this manager's fields.
parseIdentifier()  : void
Reads the ID line, which carries the entry number, the release and the domain count.
parseKeywords()  : void
Reads the KW line, which carries the frequent names and their occurrence count, then the keywords, the two halves being separated by a double slash.

Properties

Methods

getEntryId()

Extracts the identifier uniquely naming a ProDom 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

getFreqNames()

Frequent protein names, keyed by name, valued by how many times they occur.

public getFreqNames() : array<string|int, mixed>
Return values
array<string|int, mixed>

getKeywords()

public getKeywords() : array<string|int, mixed>
Return values
array<string|int, mixed>

isEntryEnd()

Tells whether a line closes a ProDom 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 ProDom entry.

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

The line to analyze

Return values
bool

parseDataFile()

Parses a ProDom 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

parseIdentifier()

Reads the ID line, which carries the entry number, the release and the domain count.

private parseIdentifier(string $sData) : void

Example: ID 20167 p2002.1 10 seq.

Parameters
$sData : string

The ID line, tag stripped

parseKeywords()

Reads the KW line, which carries the frequent names and their occurrence count, then the keywords, the two halves being separated by a double slash.

private parseKeywords(string $sData) : void

Example: KW FADR(2) Y586(1) // COMPLETE PROTEOME DNA-BINDING FATTY

Parameters
$sData : string

The KW line, tag stripped

On this page

Search results