edu.emory.cci.aiw.umls.ConceptUID 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 Concept Unique Identifier (CUI) in a UMLS query. CUIs must
 * match the regular expression C\d{7} (the letter 'C' followed by
 * 7 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 ConceptUID extends AbstractUMLSSearchUID implements
        CUIQuerySearchUID, AUIQuerySearchUID, STRQuerySearchUID,
        TUIQuerySearchUID, SABQuerySearchUID, ParentsQuerySearchUID,
        NeighborQuerySearchUID, MapToIdQuerySearchUID, CodeQuerySearchUID {

    private static Pattern cuidPattern;

    /*
     * An empty CUI, used only within this package when only the key name is
     * required.
     */
    static final ConceptUID EMPTY_CUI = new ConceptUID("");

    /*
     * the regex all CUIs must match
     */
    static {
        cuidPattern = Pattern.compile("C\\d{7}");
    }

    private ConceptUID(String cuid) {
        super(cuid);
    }

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

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

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