Taxon.java

/**
 *
 *  Copyright 2012-2013 The MITRE Corporation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * **************************************************************************
 *                          NOTICE
 * This software was produced for the U. S. Government under Contract No.
 * W15P7T-12-C-F600, and is subject to the Rights in Noncommercial Computer
 * Software and Noncommercial Computer Software Documentation Clause
 * 252.227-7014 (JUN 1995)
 *
 * (c) 2012 The MITRE Corporation. All Rights Reserved.
 * **************************************************************************
 */
package org.opensextant.data;

import java.util.Arrays;
import java.util.Collection;
import java.util.HashSet;
import java.util.Set;

/**
 * For now, what seems useful are catalog, name, terms.

 * @author ubaldino
 */
public class Taxon {

    /**  Catalog, for example "fruit" */
    public String catalog = null;

    /** Node name: citrus.tropical */
    public String name = null;
    /** Nod OID:  1.2.3  */
    public String id = null;
    /** Node root: citrus */
    public String rootid = null;
    /** Terms: "pineapple", "mango", ... */
    public Set<String> termset = null;
    public Set<String> tagset = null;
    /** Acronyms are assumed to be ALL UPPER CASE; granted this does not
     * always apply.   But this is used to inform post-processing if a match, such as
     * 'abc' matched 'ABC' incorrectly.  If the match is lower case, but the Taxon is Acronym,
     * then you have a mismatch of case and semantics likley.
     */
    public boolean isAcronym = false;

    public Taxon() {
    }

    public void setName(String n) {
        name = n;
    }

    public void setId(String i) {
        id = i;
    }

    public void setRootid(String i) {
        rootid = i;
    }

    public void setTerms(String[] t) {
        if (t == null) {
            return;
        }
        if (termset == null) {
            termset = new HashSet<String>();
        }
        termset.addAll(Arrays.asList(t));

    }

    public void addTags(Collection<Object> tlist) {
        if (tlist == null) {
            return;
        }

        for (Object o : tlist) {
            addTag((String) o);
        }
    }

    public void addTag(String t) {
        if (t == null) {
            return;
        }

        if (tagset == null) {
            tagset = new HashSet<String>();
        }
        tagset.add(t);
    }

    public void addTerm(String t) {
        if (termset == null) {
            termset = new HashSet<String>();
        }
        termset.add(t);
    }

    public void addTerms(Collection<String> tlist) {
        if (tlist == null) {
            return;
        }
        if (termset == null) {
            termset = new HashSet<String>();
        }
        termset.addAll(tlist);
    }

    @Override
    public String toString() {
        if (termset == null) {
            return name;
        }
        return name + " " + termset.toString();
    }
}