Mailing-List: contact java-dev-help@lucene.apache.org; run by ezmlm
Precedence: bulk
Reply-To: java-dev@lucene.apache.org
Received-SPF: pass (nike.apache.org: domain of serera@gmail.com designates
 209.85.219.179 as permitted sender)
DomainKey-Signature: a=rsa-sha1; c=nofws;
        d=gmail.com; s=gamma;
        h=mime-version:date:message-id:subject:from:to:content-type;
        b=Hm/bMuGrC1T7s/py42jLugyRBdmJVswtGRqPil7xDyZA+h2Cjqtlcfw4lyxYTkNvBw
         kAnhnruIDmluVVaN4CxehBhTBxEg3r6NEqNl6bxwOuyuNCtaCmOjvi55CpTwX1WKpHbZ
         kaZ2+OVw7oh3X5s/Slm8BSRZIQAtZtFqUqtes=
MIME-Version: 1.0
Date: Sat, 11 Apr 2009 18:10:19 +0300
Message-ID: <786fde50904110810t3e1e98c4ma45e12f78cf93a34@mail.gmail.com>
Subject: (Benchmark) Split DocMaker into DocCollector and DocMaker
From: Shai Erera <serera@gmail.com>
To: java-dev@lucene.apache.org
Content-Type: multipart/alternative; boundary=0016364c7b8d221ed6046748e10d

--0016364c7b8d221ed6046748e10d
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit

Hi

I would like to propose some refactoring to the benchmark package. Today,
DocMaker has two roles: collecting documents from a collection and preparing
a Document object. I think these two should actually be split up to
DocCollector and DocMaker, which will use a DocCollector instance.

DocCollector will implement all the methods of DocMaker, like
getNextDocData, raw size in bytes tracking etc. This can actually fit well
w/ 1591, by having a basic DocCollector that offers input stream services,
and wraps a file (for example) with a bzip or gzip streams etc.

DocMaker will implement the makeDocument methods, reusing DocState etc.

The idea is that collecting the Enwiki documents, for example, should be the
same whether I create documents using DocState, add payloads or index
additional metadata. Same goes for Trec and Reuters collections, as well as
LineDocMaker.
In fact, if one inspects EnwikiDocMaker and LineDocMaker closely, they are
99% the same and 99% different. Most of their differences lie in the way
they read the data, while most of the similarity lies in the way the create
documents (using DocState).
That led to a somehwat bizzare extension of LineDocMaker by EnwikiDocMaker
(just the reuse of DocState). Also, other DocMakers do not use that DocState
today.

So by having a EnwikiDocCollector, ReutersDocCollector and others (TREC,
Line, Simple), I can write several DocMakers, such as DocStateMaker,
ConfigurableDocMaker (one which accpets all kinds of config options) and
custom DocMakers (payload, facets, sorting), passing to them a DocCollector
instance (much like we do today w/ DocMaker) and reuse the same DocMaking
algorithm with many document collections, as well as the same document
collection algorithm with many DocMaker implementations.

This will also give us the opportunity to perf test document collection
alone (i.e., compare bzip, gzip and regular input streams), w/o the overhead
of creating a Document object.

I've already done so in my code environment (I extend the benchmark package
for my application's purposes) and I like the flexibility I have. I think
this can be a nice contribution to the benchmark package, which can result
in some code cleanup as well.

What do you think? I can open an issue and work out a patch.

Shai

--0016364c7b8d221ed6046748e10d
Content-Type: text/html; charset=ISO-8859-1
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr">Hi<br><br>I would like to propose some refactoring to the =
benchmark package. Today, DocMaker has two roles: collecting documents from=
 a collection and preparing a Document object. I think these two should act=
ually be split up to DocCollector and DocMaker, which will use a DocCollect=
or instance.<br>
<br>DocCollector will implement all the methods of DocMaker, like getNextDo=
cData, raw size in bytes tracking etc. This can actually fit well w/ 1591, =
by having a basic DocCollector that offers input stream services, and wraps=
 a file (for example) with a bzip or gzip streams etc.<br>
<br>DocMaker will implement the makeDocument methods, reusing DocState etc.=
<br><br>The idea is that collecting the Enwiki documents, for example, shou=
ld be the same whether I create documents using DocState, add payloads or i=
ndex additional metadata. Same goes for Trec and Reuters collections, as we=
ll as LineDocMaker.<br>
In fact, if one inspects EnwikiDocMaker and LineDocMaker closely, they are =
99% the same and 99% different. Most of their differences lie in the way th=
ey read the data, while most of the similarity lies in the way the create d=
ocuments (using DocState).<br>
That led to a somehwat bizzare extension of LineDocMaker by EnwikiDocMaker =
(just the reuse of DocState). Also, other DocMakers do not use that DocStat=
e today.<br><br>So by having a EnwikiDocCollector, ReutersDocCollector and =
others (TREC, Line, Simple), I can write several DocMakers, such as DocStat=
eMaker, ConfigurableDocMaker (one which accpets all kinds of config options=
) and custom DocMakers (payload, facets, sorting), passing to them a DocCol=
lector instance (much like we do today w/ DocMaker) and reuse the same DocM=
aking algorithm with many document collections, as well as the same documen=
t collection algorithm with many DocMaker implementations.<br>
<br>This will also give us the opportunity to perf test document collection=
 alone (i.e., compare bzip, gzip and regular input streams), w/o the overhe=
ad of creating a Document object.<br><br>I&#39;ve already done so in my cod=
e environment (I extend the benchmark package for my application&#39;s purp=
oses) and I like the flexibility I have. I think this can be a nice contrib=
ution to the benchmark package, which can result in some code cleanup as we=
ll.<br>
<br>What do you think? I can open an issue and work out a patch.<br><br>Sha=
i<br></div>

--0016364c7b8d221ed6046748e10d--