source: trunk/gsdl3/src/java/org/greenstone/gsdl3/service/GS2MGPPRetrieve.java@ 3851

/*
 *    GS2MGPPRetrieve.java
 *    Copyright (C) 2002 New Zealand Digital Library, http://www.nzdl.org
 *
 *    This program is free software; you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation; either version 2 of the License, or
 *    (at your option) any later version.
 *
 *    This program 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 General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License
 *    along with this program; if not, write to the Free Software
 *    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
package org.greenstone.gsdl3.service;


// Greenstone classes
import org.greenstone.mgpp.*;
import org.greenstone.gsdl3.util.*;

// XML classes
import org.w3c.dom.Element; 


/**
 * A ServiceRack class for retrieval in greenstone 2 MGPP collections
 *
 * @author <a href="mailto:[email protected]">Katherine Don</a>
 * @version $Revision: 3851 $
 * @see ServiceRack
 */
public class GS2MGPPRetrieve 
    extends GS2Retrieve {

    // Parameters used
    private static final String LEVEL_PARAM = "level";

    // Elements used in the config file that are specific to this class
    private static final String DEFAULT_LEVEL_ELEM = "defaultLevel";

    private MGPPWrapper mgpp_src_ = null;
    
    private String default_level_ = null;


    /** constructor */
    public GS2MGPPRetrieve()
    {
    mgpp_src_ = new MGPPWrapper();
    }


    /** configure this service */
    public boolean configure(Element info)
    {
    // Do specific configuration
    System.out.println("Configuring GS2MGPPRetrieve...");

    // Get the default level out of <defaultLevel> (buildConfig.xml)
    Element def = (Element) GSXML.getChildByTagName(info, DEFAULT_LEVEL_ELEM);
    if (def != null) {
        default_level_ = def.getAttribute(GSXML.NAME_ATT);
    }
    if (default_level_ == null || default_level_.equals("")) {
        System.err.println("Error: default level not specified!");
        return false;
    }
    // System.out.println("Default level: " + default_level_);

    // Do generic configuration
    return super.configure(info);
    }


    /** Retrieve the structure of a document - this function needed as its called specifically on the class name*/
    protected Element processDocumentStructureRetrieve(Element request)
    {
    return super.processDocumentStructureRetrieve(request);
    }


    /** Retrieve metadata associated with a document - this function needed as its called specifically on the class name*/
    protected Element processDocumentMetadataRetrieve(Element request)
    {
    return super.processDocumentMetadataRetrieve(request);
    }


    /** Retrieve the content of a document */
    protected Element processDocumentContentRetrieve(Element request)
    {
    // Create a new (empty) result message
    Element result = doc_.createElement(GSXML.RESPONSE_ELEM);
    String from = GSPath.appendLink(cluster_name_, DOCUMENT_CONTENT_RETRIEVE_SERVICE);
    result.setAttribute(GSXML.FROM_ATT, from);
    result.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_PROCESS);
    Element result_content = doc_.createElement(GSXML.CONTENT_ELEM);
    result.appendChild(result_content);

    // Get the parameters of the request
    Element param_list = (Element) GSXML.getChildByTagName(request, GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
    if (param_list == null) {
        System.err.println("GS2MGPPRetrieve, DocumentContentRetrieve Error: missing paramList.\n");
        return result;  // Return the empty result
    }

    String level = default_level_;

    // Process the request parameters
    // are there any???
    Element param = (Element) param_list.getFirstChild();
    while (param != null) {
        if (!param.getNodeName().equals(GSXML.PARAM_ELEM)) {
        System.err.println("Warning: Non-param in paramList (ignored).");
        }
        else {
        // this looks for a level param but I think we dont use it
        if (param.getAttribute(GSXML.NAME_ATT) == LEVEL_PARAM) {
            level = GSXML.getValue(param);
            System.out.println("Level: " + level);
        }
        }

        param = (Element) param.getNextSibling();
    }

    // Get the request content
    Element content = (Element) GSXML.getChildByTagName(request, GSXML.CONTENT_ELEM);
    if (content == null) {
        System.err.println("Error: DocumentContentRetrieve request had no content.\n");
        return result;
    }

    Element doc_list = doc_.createElement(GSXML.DOCUMENT_ELEM+GSXML.LIST_MODIFIER);
    result_content.appendChild(doc_list);

    // The location of the MGPP text files
    String basedir = GSFile.collectionBaseDir(site_home_, cluster_name_);
    String textdir = GSFile.collectionTextPath(cluster_name_);

    // Get the documents
    String[] doc_ids = GSXML.getDocumentNameList(content);
    for (int i = 0; i < doc_ids.length; i++) {
        String doc_id = doc_ids[i];
        long doc_num = gdbm_src_.oid2Docnum(doc_id);
        String doc_content = mgpp_src_.getDocument(basedir, textdir, level, doc_num);

        // For now, stick it in a text node - eventually should be parsed as xml??
        Element doc = GSXML.createDocumentElement(doc_, doc_id);
        GSXML.addDocText(doc_, doc, doc_content);
        doc_list.appendChild(doc);
    }

    return result;
    }
}