Index
NAME
InSilicoSpectro::Utils::XML::SaxIndexMaker
DESCRIPTION
A handler to be used with XML::Parser::PerlSax. The goal is to read an indexMaker (xmlIndexMaker) file, stating which elements sould be indexed from a (large) source xml file. Then this source file is parsed, indexed element are saved into an index (xmlIndex) file.
METHODS
my $sim=InSilicoSpectro::Utils::XML::SaxIndexMaker->new();
Instanciate a new SaxIndexMaker
$sim->readXmlIndexMaker($file)
$sim->readXmlIndexMaker(file=>$file)
$sim->readXmlIndexMaker(contents=>$xmlcontents)
Read what is to be caught and put into the index. xmlIndexMaker files follows the format
$sim->makeIndex($sourceFile, [$indexFile, [\%args]])
Opens $sourceFile and writes the index into $indexFile. $sourceFile is a normal valid xml.
$indexFile will look like the following example
%args can contain
- origSrc=file
-
So that the origSrc is saved instead of the given $sourceFile (think that the $sourceFile may bonly be a temporary gunziped file)
printIndex([$out])
Print the index in a text format
FUNCTIONS
COPYRIGHT
Copyright (C) 2004-2005 Geneva Bioinformatics www.genebio.com
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
AUTHORS
Alexandre Masselot, www.genebio.com
Nicolas Budin, www.genebio.com