edu.emory.cci.aiw.umls.TermUID Maven / Gradle / Ivy

Go to download
/*
 * #%L
 * UMLSQuery
 * %%
 * Copyright (C) 2012 - 2013 Emory University
 * %%
 * 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.
 * #L%
 */
package edu.emory.cci.aiw.umls;

import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * Represents a Term Unique Identifier (TUI) in a UMLS query. TUIs must match
 * the regular expression T\d{3} (the letter 'T' followed by 3
 * digits). Implements several marker interfaces that allow objects of this type
 * to be used as a search key in various UMLS queries.
 * 
 * @author Michel Mansour
 * 
 */
public final class TermUID extends AbstractUMLSSearchUID {

    private static Pattern tuidPattern;

    /*
     * the regex all TUIs must match
     */
    static {
        tuidPattern = Pattern.compile("T\\d{3}");
    }

    private TermUID(String tui) {
        super(tui);
    }

    @Override
    public String getKeyName() {
        return "TUI";
    }

    @Override
    public boolean equals(Object o) {
        if (o instanceof TermUID) {
            return this.getValue().equals(((TermUID) o).getValue());
        }
        return false;
    }

    /**
     * Creates and returns a new TermUID from the given string. The
     * string must match the TUI format, which is given by the regular
     * expression T\d{3} (the letter 'T' followed by 3 digits). If
     * the string does not match the regex, then a
     * MalformedUMLSUniqueIdentifierException is thrown.
     * 
     * @param tui
     *            the string representing the TUI to be created
     * @return a TermUID whose value is the given string
     * @throws MalformedUMLSUniqueIdentifierException
     *             if the string argument does not match the TUI format
     */
    public static TermUID fromString(String tui)
            throws MalformedUMLSUniqueIdentifierException {
        Matcher m = tuidPattern.matcher(tui);
        if (m.matches()) {
            return new TermUID(tui);
        } else {
            throw new MalformedUMLSUniqueIdentifierException(
                    "Term Unique Identifiers must consist of the letter 'T' "
                            + "followed by 3 digits");
        }
    }
}