• Home
• nz.ac.waikato.cms.weka
• weka-dev
• 3.9.2
• source code
• TechnicalInformationHandlerJavadoc.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

weka.core.TechnicalInformationHandlerJavadoc Maven / Gradle / Ivy

/*
 *   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 3 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, see .
 */

/*
 * TechnicalInformationHandlerJavadoc.java
 * Copyright (C) 2006-2012 University of Waikato, Hamilton, New Zealand
 */

package weka.core;

import java.util.Collections;
import java.util.Enumeration;
import java.util.Vector;

/**
 * Generates Javadoc comments from the TechnicalInformationHandler's data.
 * Update the BibTex references and the plaintext techincal information.
 * 


 * 
 *  Valid options are:
 * 

 * 
 * 
 * -W <classname>
 *  The class to load.
 * 
 * 
 * 
 * -nostars
 *  Suppresses the '*' in the Javadoc.
 * 
 * 
 * 
 * -dir <dir>
 *  The directory above the package hierarchy of the class.
 * 
 * 
 * 
 * -silent
 *  Suppresses printing in the console.
 * 
 * 
 * 
 * -noprolog
 *  Suppresses the 'BibTex:' prolog in the Javadoc.
 * 
 * 
 * 
 * 
 * @author fracpete (fracpete at waikato dot ac dot nz)
 * @version $Revision: 14293 $
 * @see #PLAINTEXT_STARTTAG
 * @see #PLAINTEXT_ENDTAG
 * @see #BIBTEX_STARTTAG
 * @see #BIBTEX_ENDTAG
 */
public class TechnicalInformationHandlerJavadoc extends Javadoc {

  /** the start comment tag for inserting the generated BibTex */
  public final static String PLAINTEXT_STARTTAG = "";

  /** the end comment tag for inserting the generated BibTex */
  public final static String PLAINTEXT_ENDTAG = "";

  /** the start comment tag for inserting the generated BibTex */
  public final static String BIBTEX_STARTTAG = "";

  /** the end comment tag for inserting the generated BibTex */
  public final static String BIBTEX_ENDTAG = "";

  /** whether to include the "Valid options..." prolog in the Javadoc */
  protected boolean m_Prolog = true;

  /**
   * default constructor
   */
  public TechnicalInformationHandlerJavadoc() {
    super();

    m_StartTag = new String[2];
    m_EndTag = new String[2];
    m_StartTag[0] = PLAINTEXT_STARTTAG;
    m_EndTag[0] = PLAINTEXT_ENDTAG;
    m_StartTag[1] = BIBTEX_STARTTAG;
    m_EndTag[1] = BIBTEX_ENDTAG;
  }

  /**
   * Returns an enumeration describing the available options.
   * 
   * @return an enumeration of all the available options.
   */
  @Override
  public Enumeration listOptions() {
    Vector result = new Vector();

    result.addAll(Collections.list(super.listOptions()));

    result.addElement(new Option(
      "\tSuppresses the 'BibTex:' prolog in the Javadoc.", "noprolog", 0,
      "-noprolog"));

    return result.elements();
  }

  /**
   * Parses a given list of options.
   * 
   * @param options the list of options as an array of strings
   * @throws Exception if an option is not supported
   */
  @Override
  public void setOptions(String[] options) throws Exception {
    super.setOptions(options);

    setProlog(!Utils.getFlag("noprolog", options));
  }

  /**
   * Gets the current settings of this object.
   * 
   * @return an array of strings suitable for passing to setOptions
   */
  @Override
  public String[] getOptions() {
    Vector result;
    String[] options;
    int i;

    result = new Vector();

    options = super.getOptions();
    for (i = 0; i < options.length; i++) {
      result.add(options[i]);
    }

    if (!getProlog()) {
      result.add("-noprolog");
    }

    return result.toArray(new String[result.size()]);
  }

  /**
   * sets whether to add the "Valid options are..." prolog
   * 
   * @param value true if the prolog is to be used
   */
  public void setProlog(boolean value) {
    m_Prolog = value;
  }

  /**
   * whether "Valid options are..." prolog is included in the Javadoc
   * 
   * @return whether the prolog is currently used
   */
  public boolean getProlog() {
    return m_Prolog;
  }

  /**
   * generates and returns the Javadoc for the specified start/end tag pair.
   * 
   * @param index the index in the start/end tag array
   * @return the generated Javadoc
   * @throws Exception in case the generation fails
   */
  @Override
  protected String generateJavadoc(int index) throws Exception {
    String result;
    TechnicalInformationHandler handler;

    result = "";

    if (!canInstantiateClass()) {
      return result;
    }

    if (!InheritanceUtils.hasInterface(TechnicalInformationHandler.class,
      getInstance().getClass())) {
      throw new Exception("Class '" + getClassname()
        + "' is not a TechnicalInformationHandler!");
    }

    handler = (TechnicalInformationHandler) getInstance();

    switch (index) {
    case 0: // plain text
      result = toHTML(handler.getTechnicalInformation().toString()) + "\n";
      break;

    case 1: // bibtex
      // prolog?
      if (getProlog()) {
        result = "BibTeX:\n";
      }
      result += "
\n";
      result += toHTML(handler.getTechnicalInformation().toBibTex())
        .replaceAll("
", "") + "\n";
      result += "
\n

\n";
      break;
    }

    // stars?
    if (getUseStars()) {
      result = indent(result, 1, "* ");
    }

    return result;
  }

  /**
   * Returns the revision string.
   * 
   * @return the revision
   */
  @Override
  public String getRevision() {
    return RevisionUtils.extract("$Revision: 14293 $");
  }

  /**
   * Parses the given commandline parameters and generates the Javadoc.
   * 
   * @param args the commandline parameters for the object
   */
  public static void main(String[] args) {
    runJavadoc(new TechnicalInformationHandlerJavadoc(), args);
  }
}