edu.emory.cci.aiw.umls.MapToIdResult 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;

/**
 * Container class for the result of a mapToId UMLS query, via one of the
 * mapToId* methods in the API. It contains a unique identifier and the string
 * value it mapped from.
 * 
 * @author Michel Mansour
 * 
 * @param 
 *            the type of the unique identifier, which must implement the
 *            MapToIdQuerySearchUID interface
 */
public final class MapToIdResult {
    private final T uid;
    private final UMLSQueryStringValue str;

    private MapToIdResult(T uid, UMLSQueryStringValue str) {
        this.uid = uid;
        this.str = str;
    }

    /**
     * Gets the unique identifier
     * @return unique identifier of type T
     */
    public T getUid() {
        return this.uid;
    }

    /**
     * Gets the string value
     * @return a UMLSQueryStringValue
     */
    public UMLSQueryStringValue getStr() {
        return this.str;
    }

    static  MapToIdResult fromUidAndStr(
            U uid, UMLSQueryStringValue str) {
        return new MapToIdResult(uid, str);
    }

    @Override
    public String toString() {
        return uid.getKeyName() + ": " + uid.getValue() + "\t"
                + str.getKeyName() + ": " + str.getValue();
    }

    @Override
    public boolean equals(Object o) {
        if (this == o)
            return true;
        if (o == null)
            return false;
        if (this.getClass() != o.getClass())
            return false;
        return uid.equals(((MapToIdResult) o).getUid())
                && str.equals(((MapToIdResult) o).getStr());

    }

    @Override
    public int hashCode() {
        return (uid.getValue() + str.getValue()).hashCode();
    }
}