File Coverage

blib/lib/DDC/HitList.pm

Criterion	Covered	Total	%
statement	6	14	42.8
branch	0	2	0.0
condition	0	3	0.0
subroutine	2	5	40.0
pod	1	3	33.3
total	9	27	33.3

#-*- Mode: CPerl -*-

## File: DDC::HitList.pm
## Author: Bryan Jurish
## Description:
##  + DDC Query utilities: query response structure
##======================================================================

package DDC::HitList;
use DDC::Hit;
use strict;

##======================================================================
## Globals

##======================================================================
## Constructors, etc.

## $hits = $CLASS_OR_OBJ->new(%args)
##  + %$hits, %args:
##    (
##     hits_ => \@hits,                      ##-- ARRAY-ref of DDC::Hit objects
##
##     ##-- administrative data returned by DDC server (from ConcordDmnLib/Corpora.cpp: CDDCServerListenHost::ProcessSocketString())
##     istatus_ => $InternalError,           ##-- int InternalError (0=success)
##     nstatus_ => $NetworkError,            ##-- int iNetworkError (0=success)
##     end_     => $EndHitNo,                ##-- DWORD EndHitNo
##     nhits_   => $HitsCount,               ##-- DWORD HitsCount
##     ndocs_   => $DocsCount,               ##-- DWORD RelevantDocsCount
##     dhits_   => $HitDistribution,         ##-- string N1+N2+N3+...+NN=N*
##     ddocs_   => $DocDistribution,         ##-- string N1+N2+N3+...+NN=N*
##     error_   => $errorMessage,            ##-- error message if $hits->{istatus_}!=0 or $hits->{nstatus_}!=0 (empty: success)
##    )
sub new {
  my $that = shift;
  return bless {
		hits_=>[],
		@_
	       }, ref($that)||$that;
}

## $hits = $hits->expandFields()
## $hits = $hits->expandFields(\@fieldNames)
##  + just calls $hit->expandFields() on every hit in $hits->{hits_}
sub expandFields {
  my ($hl,$names) = @_;
  $_->expandFields($names) foreach (@{$hl->{hits_}||[]});
  return $hl;
}

## $thingy = $obj->TO_JSON()
##  + annoying wrapper for JSON, JSON::XS
sub TO_JSON {
  return { %{$_[0]} };
}


1; ##-- be happy

__END__