source: trunk/java-client/org/nzdl/gsdl/service/NzdlCollectionInfo.java@ 2178

/*
 *    NzdlCollectionInfo.java
 *    Copyright (C) 2001 New Zealand Digital Library Project
 *
 *    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.
 */

//the package we're in
package org.nzdl.gsdl.service;

/** gsdl corba stuff */
import org.nzdl.gsdl.corba.gsdlInterface.*;
import org.nzdl.gsdl.util.*;

/**
 * An object that stores information on a collection. Information is obtained from
 * {@link NzdlService NzdlService.getCollectionInfo(name)}
 * Easily interrogated by a user.
 *
 * @author Stuart Yeates  ([email protected])
 * @author Aziz Mahoui    ([email protected])
 * @author Gordon Paynter ([email protected])
 * @author Dave Nichols   ([email protected])
 * @author Brett Sheeran ([email protected]) (comments)
 * @version $Revision: 2178 $
 */
public class NzdlCollectionInfo extends Object {

  private corbaColInfoResponse m_Info = null;

  /**
   * Create an instance of NzdlCollectionInfo.
   */
  public NzdlCollectionInfo( corbaColInfoResponse _info ) {
    m_Info = _info;
  }

  /**
   * Returns the corbaInfoResponse.
   */
  public corbaColInfoResponse getInfo(){
    return m_Info;
  }

  /**
   * Returns the name of a collection. <br>
   * Pre: Created instance of NzdlCollectionInfo. Used
   * {@link NzdlService NzdlService.getCollectionInfo(name)}
   * to extract collection information.
   * @return A string representing the name of the collection.
   */
  public String getName() {
    return NzdlCorbaFactory.toString( m_Info.shoftInfo.name ) ;
  }
  /**
   * Returns HTTP Prefix
   */
  public String getHTTPPrefix() {
    //return m_Info.httpprefix.text.toString();
     return NzdlCorbaFactory.toString( m_Info.httpprefix ) ;
  }

  /**
   * Returns HTTP Domain
   */
  public String getHTTPDomain() {
    return NzdlCorbaFactory.toString( m_Info.httpdomain ) ;
  }

  /**
   * Returns reseptionist
   */
  public String getReceptionist() {
    return NzdlCorbaFactory.toString( m_Info.receptionist ) ;
  }

  /**
   * Returns true if collection is public. <br>
   * Pre: Created instance of NzdlCollectionInfo. Used
   * {@link NzdlService NzdlService.getCollectionInfo(name)}
   * to extract collection information.
   * @return Boolean true if collection is public, otherwise returns false.
   */
  public boolean isPublic() {
    return m_Info.isPublic;
  }

  /**
   * Returns true if collection is a beta version. <br>
   * Pre: Created instance of NzdlCollectionInfo. Used
   * {@link NzdlService NzdlService.getCollectionInfo(name)}
   * to extract collection information.
   * @return Boolean true if collection is a beta version, otherwise returns false.
   */
  public boolean isBeta() {
    return m_Info.isBeta;
  }

  /**
   * Returns an integer representation of build date. <br>
   * Pre: Created instance of NzdlCollectionInfo. Used
   * {@link NzdlService NzdlService.getCollectionInfo(name)}
   * to extract collection information.
   * @return Integer representation of date.
   */
  public int getBuildDate() {
    return m_Info.buildDate;
  }

  /**
   * Returns the number of documents in a collection. <br>
   * Pre: Created instance of NzdlCollectionInfo. Used
   * {@link NzdlService NzdlService.getCollectionInfo(name)}
   * to extract collection information.
   * @return An integer representing the number of documents in the collection.
   */
  public int getNumOfDocs() {
    return m_Info.numDocs;
  }

  /**
   * Returns the number of words in a collection. <br>
   * Pre: Created instance of NzdlCollectionInfo. Used
   * {@link NzdlService NzdlService.getCollectionInfo(name)}
   * to extract collection information.
   * @return An integer representing the number of words in the collection.
   */
  public int getNumOfWords() {
    return m_Info.numWords;
  }

  /**
   * Returns the number of bytes in the collection. <br>
   * Pre: Created instance of NzdlCollectionInfo. Used
   * {@link NzdlService NzdlService.getCollectionInfo(name)}
   * to extract collection information.
   * @return An integer representing the number of bytes in the collection.
   */
  public int getNumOfBytes() {
    return m_Info.numBytes;
  }

  /**
   * Returns a string describing collection details. <br>
   * Pre: Created instance of NzdlCollectionInfo. Used
   * {@link NzdlService NzdlService.getCollectionInfo(name)}
   * to extract collection information.
   * @return A string describing collection details such as: collection name;
   * isPublic; isBeta; buildDate; numOfDocs; numOfWords; numOfBytes
   */
  public String toString() {
    StringBuffer buf = new  StringBuffer(1000);
    buf.append("coll name=\"").append(getName());
    buf.append("\" isPublic=").append(isPublic());
    buf.append(" isBeta=").append(isBeta());
    buf.append(" buildDate=").append(getBuildDate());
    buf.append(" numOfDocs=").append(getNumOfDocs());
    buf.append(" numOfWords=").append(getNumOfWords());
    buf.append(" numOfBytes=").append(getNumOfBytes());
    return buf.toString();
  }

  /**
   * Not currently implemented
   */
  public void print() {
    /* [email protected] */
    //System.out.println("Collection Information--------------");
    //System.out.println("Collection Name = " + this.getName());
    //System.out.println("Collection Name = " + m_info.getName());
    
  }

}