Overview

Namespaces

  • AnalyseModule
    • Models
  • BaseModule
    • Exceptions
    • Models
    • Repository
    • Services
  • DispatchModule
    • Helpers
    • Models
    • Tools
  • PredictModule
  • SearchModule

Classes

  • BaseMatch
  • BaseParser
  • BlastMatch
  • BlatMatch
  • PredictParser
  • ResultSet
  • SearchParser
  • Sequence
  • Overview
  • Namespace
  • Class

Class ResultSet

ResultSet is an envelope holding information about set of sequences

Namespace: DispatchModule
Located at DispatchModule/ResultSet.php
Methods summary
public integer
# getTotalCount( )

Returns the number of the whole result set (primarly it's important when the partial result set is returned)

Returns the number of the whole result set (primarly it's important when the partial result set is returned)

Returns

integer
Result set size
public
# setTotalCount( integer $totalCount )

Sets the result set count. This is important in case the partial result set is returned

Sets the result set count. This is important in case the partial result set is returned

Parameters

$totalCount
Result set count
public
# addSequence( DispatchModule\Sequence $sequence )

Adds one single sequence to the result set

Adds one single sequence to the result set

Parameters

$sequence
public
# add( DispatchModule\ResultSet $set = null )

Merges two results together

Merges two results together

Parameters

$set
public
# intersect( DispatchModule\ResultSet $set = null )

Intersection of two results

Intersection of two results

Parameters

$set
public
# leftJoin( DispatchModule\ResultSet $set = null )

Add informations from $set to sequences in this ResultSet

Add informations from $set to sequences in this ResultSet

Parameters

$set
public array
# getData( )

Returns data

Returns data

Returns

array
of sequences
public array
# getDataAndCount( )

Returns data with array containing additional info in the last key position (count in the "count" key position and search identifier in the "search_id" key position)

Returns data with array containing additional info in the last key position (count in the "count" key position and search identifier in the "search_id" key position)

Returns

array
of sequences
public
# sortByScore( )

Sorts the data by matches score (coverage * identity)

Sorts the data by matches score (coverage * identity)

public
# sortScores( )

Sorts the matches scores in sequences (coverage * identity)

Sorts the matches scores in sequences (coverage * identity)

public
# mergeSequences( DispatchModule\Sequence & $oldSequence, DispatchModule\Sequence $newSequence )

Merges two sequence (sets unset properties from $newSequence into $oldSequence)

Merges two sequence (sets unset properties from $newSequence into $oldSequence)

Parameters

$oldSequence
$newSequence
Properties summary
public array $data

Holds result data

Holds result data

# array()
public integer $totalCount

This count variable is important in case the partial result set is returned. Gives info about the whole result set size

This count variable is important in case the partial result set is returned. Gives info about the whole result set size

# 0
public integer $id

This id variable is important for identification of experiment in case the partial result set is returned. Gives info about the whole result set size

This id variable is important for identification of experiment in case the partial result set is returned. Gives info about the whole result set size

#
API documentation generated by ApiGen