source: trunk/gsdl3/src/java/org/greenstone/gsdl3/collection/Collection.java@ 3468

/*
 *    Collection.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.collection;

import org.greenstone.gsdl3.util.*;
import org.greenstone.gsdl3.core.*;
import org.greenstone.gsdl3.service.*;


// java XML classes we're using
import org.w3c.dom.Document; 
import org.w3c.dom.Node; 
import org.w3c.dom.Element; 
import org.w3c.dom.NodeList; 

import java.io.File;
import java.util.HashMap;

/**
 * Represents a collection in Greenstone. A collection is an extension of
 * a ServiceCluster - it has local data that the services use.
 *
 * @author <a href="mailto:[email protected]">Katherine Don</a>
 * @version $Revision: 3468 $
 * @see ModuleInterface
 */
public class Collection 
    extends ServiceCluster {

    /** same as setClusterName */
    public void setCollectionName(String name) {
    setClusterName(name);
    }

    public Collection() {
    service_map_ = new HashMap();
    converter_ = new XMLConverter();
    doc_ = converter_.newDOM();
    description_ = doc_.createElement("collection");
    service_info_ = doc_.createElement("serviceList");
    meta_info_ = doc_.createElement("metadataList");
    
    }
    
    /**
     * Configures the collection.
     *
     * gsdlHome and collectionName must be set before configure is called.
     *
     * the file buildcfg.xml is located in gsdlHome/collect/collectionName
     * collection metadata is obtained, and services loaded.
     *
     * @return true/false on success/fail
     */
    public boolean configure() {
    
    if (site_home_ == null || cluster_name_== null) {
        System.err.println("site_home and collection_name must be set before configure called!");
        return false;
    }
    // read the collection build configuration file
    File config_file_ = new File(GSFile.collectionBuildConfigFile(site_home_, cluster_name_));

    if (!config_file_.exists()) {
        System.err.println(config_file_+" does not exist");
        System.err.println("couldn't configure collection: "+cluster_name_);
        return false;
    }

    Document doc = converter_.getDOM(config_file_);
    Element e = doc.getDocumentElement();
    
    return configure(e);
 
    }


}