edu.emory.cci.aiw.umls.AtomUID 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 an Atom Unique Identifier (AUI) in a UMLS query. AUIs must match
 * the regular expression A\d{7,8} (the letter 'A' followed by 7 or
 * 8 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 AtomUID extends AbstractUMLSSearchUID implements
        CUIQuerySearchUID, AUIQuerySearchUID, STRQuerySearchUID,
        TUIQuerySearchUID, SABQuerySearchUID, ParentsQuerySearchUID,
        NeighborQuerySearchUID, MapToIdQuerySearchUID, CodeQuerySearchUID {

    private static Pattern auidPattern;

    /*
     * An empty AUI, used only within this package when only the key name is
     * required
     */
    static final AtomUID EMPTY_AUI = new AtomUID("");

    /*
     * the regex all AUIs must match
     */
    static {
        auidPattern = Pattern.compile("A\\d{7,8}");
    }

    private AtomUID(String auid) {
        super(auid);
    }

    /**
     * Creates and returns a new AtomUID from the given string. The
     * string must match the AUI format, which is given by the regular
     * expression A\d{7} (the letter 'A' followed by exactly 7 or 8
     * digits). If the string does not match the regex, then a
     * MalformedUMLSUniqueIdentifierException is thrown.
     * 
     * @param auid
     *            the string representing the AUI to be created
     * @return an AtomUID whose value is the given string
     * @throws MalformedUMLSUniqueIdentifierException
     *             if the string argument does not match the AUI format
     */
    public static AtomUID fromString(String auid)
            throws MalformedUMLSUniqueIdentifierException {
        Matcher m = auidPattern.matcher(auid);
        if (m.matches()) {
            return new AtomUID(auid);
        } else {
            throw new MalformedUMLSUniqueIdentifierException(
                    "Atom Unique Identifiers must consist of the letter "
                            + "'A' followed by 7 or 8 digits: " + auid);
        }
    }

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

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