edu.emory.cci.aiw.umls.StringUID 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 String Unique Identifier (SUI) in a UMLS query. SUIs must match
 * the regular expression S\d{7} (the letter 'S' followed by 7 or
 * 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 StringUID extends AbstractUMLSSearchUID implements
        CUIQuerySearchUID, AUIQuerySearchUID, STRQuerySearchUID,
        TUIQuerySearchUID, SABQuerySearchUID, MapToIdQuerySearchUID {
    private static Pattern suidPattern;

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

    /*
     * the regex all SUIs must match
     */
    static {
        suidPattern = Pattern.compile("S\\d{7,8}");
    }

    private StringUID(String suid) {
        super(suid);
    }

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

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

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