CDKDictRefTaglet.java

/* $Revision$ $Author$ $Date$
 *
 * Copyright (C) 2004-2007  Egon Willighagen <egonw@users.sf.net>
 *
 * This program 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 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */
package net.sf.cdk.tools.doclets;

import com.sun.tools.doclets.Taglet;
import com.sun.javadoc.*;
import java.util.Map;
import java.util.StringTokenizer;
import java.util.Hashtable;

/**
 * Taglet that expands inline cdk.dictref tags into a weblink to the appropriate
 * dictionary. For example.
 * <pre>
 * @cdk.dictref blue-obelisk:graphPartitioning
 * </pre>
 *
 * <p>The known dictionaries are:
 * <ul>
 *  <li>blue-obelisk: <a href="http://qsar.sourceforge.net/dicts/blue-obelisk/index.xhtml">Blue Obelisk Chemoinformatics Dictionary</a>
 *  <li>bodf: <a href="http://qsar.sourceforge.net/ontologies/data-features/index.xhtml">Blue Obelisk Data Features Dictionary</a>
 *  <li>qsar-descriptors: <a href="http://qsar.sourceforge.net/dicts/qsar-descriptors/index.xhtml">QSAR.sf.net Descriptors Dictionary</a>
 * </ul>
 */
public class CDKDictRefTaglet implements Taglet {
    
    private static final String NAME = "cdk.dictref";
    
    private static final Map<String, String> dictURLs;
    private static final Map<String, String> dictNames;
    
    static {
        dictURLs = new Hashtable<String, String>(5);
        dictNames = new Hashtable<String, String>(5);
        
        dictURLs.put("bodf", "http://qsar.sourceforge.net/ontologies/data-features/index.xhtml");
        dictNames.put("bodf", "Blue Obelisk Data Features Dictionary");

        dictURLs.put("blue-obelisk", "http://qsar.sourceforge.net/dicts/blue-obelisk/index.xhtml");
        dictNames.put("blue-obelisk", "Blue Obelisk Chemoinformatics Dictionary");
        
        dictURLs.put("qsar-descriptors", "http://qsar.sourceforge.net/dicts/qsar-descriptors/index.xhtml");
        dictNames.put("qsar-descriptors", "QSAR.sf.net Descriptors Dictionary");
    }
    
    public String getName() {
        return NAME;
    }
    
    public boolean inField() {
        return true;
    }

    public boolean inConstructor() {
        return true;
    }
    
    public boolean inMethod() {
        return true;
    }
    
    public boolean inOverview() {
        return true;
    }

    public boolean inPackage() {
        return true;
    }

    public boolean inType() {
        return true;
    }
    
    public boolean isInlineTag() {
        return false;
    }
    
    public static void register(Map<String, CDKDictRefTaglet> tagletMap) {
       CDKDictRefTaglet tag = new CDKDictRefTaglet();
       Taglet t = (Taglet) tagletMap.get(tag.getName());
       if (t != null) {
           tagletMap.remove(tag.getName());
       }
       tagletMap.put(tag.getName(), tag);
    }

    public String toString(Tag tag) {
        String tagText = tag.text();
        String separator = ":";
        if (tagText.indexOf(separator) != -1) {
            StringTokenizer tokenizer = new StringTokenizer(tagText, separator);
            String dictCode = tokenizer.nextToken();
            String dictRef = tokenizer.nextToken();
            String output = "<DT><B>Dictionary pointer(s): </B><DD>";
            if (dictURLs.containsKey(dictCode)) {
                String url = dictURLs.get(dictCode) + "#" + dictRef;
                output += "<a href=\"" + url + "\">" + dictRef +
                          "</a> in the <a href=\"" + dictURLs.get(dictCode) + 
                          "\">" + dictNames.get(dictCode) + "</a> [" + 
                          tagText + "]</DD>\n";
            } else {
                output += "Unknown code: " + tagText + "</DD>\n";
            }
            return output;
        } else {
            return "<DT><B>A pointer to a dictionary: </B><DD>Unknown code: " + tagText + "</DD>\n";
        }
    }
    
    public String toString(Tag[] tags) {
        if (tags.length == 0) {
            return null;
        } else {
            return toString(tags[0]);
        }
    }
    
}