gov.nih.nci.firebird.nes.NesId.java Source code

Java tutorial

Introduction

Here is the source code for gov.nih.nci.firebird.nes.NesId.java

Source

/**
 * The software subject to this notice and license includes both human readable
 * source code form and machine readable, binary, object code form. The NCI OCR
 * Software was developed in conjunction with the National Cancer Institute
 * (NCI) by NCI employees and 5AM Solutions, Inc. (5AM). To the extent
 * government employees are authors, any rights in such works shall be subject
 * to Title 17 of the United States Code, section 105.
 *
 * This NCI OCR Software License (the License) is between NCI and You. You (or
 * Your) shall mean a person or an entity, and all other entities that control,
 * are controlled by, or are under common control with the entity. Control for
 * purposes of this definition means (i) the direct or indirect power to cause
 * the direction or management of such entity, whether by contract or otherwise,
 * or (ii) ownership of fifty percent (50%) or more of the outstanding shares,
 * or (iii) beneficial ownership of such entity.
 *
 * This License is granted provided that You agree to the conditions described
 * below. NCI grants You a non-exclusive, worldwide, perpetual, fully-paid-up,
 * no-charge, irrevocable, transferable and royalty-free right and license in
 * its rights in the NCI OCR Software to (i) use, install, access, operate,
 * execute, copy, modify, translate, market, publicly display, publicly perform,
 * and prepare derivative works of the NCI OCR Software; (ii) distribute and
 * have distributed to and by third parties the NCI OCR Software and any
 * modifications and derivative works thereof; and (iii) sublicense the
 * foregoing rights set out in (i) and (ii) to third parties, including the
 * right to license such rights to further third parties. For sake of clarity,
 * and not by way of limitation, NCI shall have no right of accounting or right
 * of payment from You or Your sub-licensees for the rights granted under this
 * License. This License is granted at no charge to You.
 *
 * Your redistributions of the source code for the Software must retain the
 * above copyright notice, this list of conditions and the disclaimer and
 * limitation of liability of Article 6, below. Your redistributions in object
 * code form must reproduce the above copyright notice, this list of conditions
 * and the disclaimer of Article 6 in the documentation and/or other materials
 * provided with the distribution, if any.
 *
 * Your end-user documentation included with the redistribution, if any, must
 * include the following acknowledgment: This product includes software
 * developed by 5AM and the National Cancer Institute. If You do not include
 * such end-user documentation, You shall include this acknowledgment in the
 * Software itself, wherever such third-party acknowledgments normally appear.
 *
 * You may not use the names "The National Cancer Institute", "NCI", or "5AM"
 * to endorse or promote products derived from this Software. This License does
 * not authorize You to use any trademarks, service marks, trade names, logos or
 * product names of either NCI or 5AM, except as required to comply with the
 * terms of this License.
 *
 * For sake of clarity, and not by way of limitation, You may incorporate this
 * Software into Your proprietary programs and into any third party proprietary
 * programs. However, if You incorporate the Software into third party
 * proprietary programs, You agree that You are solely responsible for obtaining
 * any permission from such third parties required to incorporate the Software
 * into such third party proprietary programs and for informing Your
 * sub-licensees, including without limitation Your end-users, of their
 * obligation to secure any required permissions from such third parties before
 * incorporating the Software into such third party proprietary software
 * programs. In the event that You fail to obtain such permissions, You agree
 * to indemnify NCI for any claims against NCI by such third parties, except to
 * the extent prohibited by law, resulting from Your failure to obtain such
 * permissions.
 *
 * For sake of clarity, and not by way of limitation, You may add Your own
 * copyright statement to Your modifications and to the derivative works, and
 * You may provide additional or different license terms and conditions in Your
 * sublicenses of modifications of the Software, or any derivative works of the
 * Software as a whole, provided Your use, reproduction, and distribution of the
 * Work otherwise complies with the conditions stated in this License.
 *
 * THIS SOFTWARE IS PROVIDED "AS IS," AND ANY EXPRESSED OR IMPLIED WARRANTIES,
 * (INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
 * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE) ARE DISCLAIMED. IN NO
 * EVENT SHALL THE NATIONAL CANCER INSTITUTE, 5AM SOLUTIONS, INC. OR THEIR
 * AFFILIATES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package gov.nih.nci.firebird.nes;

import gov.nih.nci.iso21090.extensions.Id;

import java.util.Iterator;

import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;
import org.iso._21090.II;

import com.google.common.base.Preconditions;
import com.google.common.base.Splitter;

/**
 * Provides methods for translating and working with NES identifiers.
 */
public final class NesId {

    private static final char NES_ID_SEPARATOR = ':';

    private final NesIIRoot root;
    private final String extension;

    /**
     * Create from a colon separated full NES ID string.
     *
     * @param nesIdString format <root>:<extension>
     */
    public NesId(String nesIdString) {
        Preconditions.checkNotNull(nesIdString);
        checkNesIdFormat(nesIdString);
        Iterator<String> nesIdParts = getNesIdParts(nesIdString);
        this.root = NesIIRoot.getByRoot(nesIdParts.next());
        this.extension = nesIdParts.next();
    }

    /**
     * Create from the NES ID component parts.
     *
     * @param root the root
     * @param extension the extension
     */
    public NesId(NesIIRoot root, String extension) {
        Preconditions.checkNotNull(root);
        Preconditions.checkNotNull(extension);
        this.root = root;
        this.extension = extension;
    }

    /**
     * Create from the NES ID component parts.
     *
     * @param root the root string
     * @param extension the extension
     */
    NesId(String root, String extension) {
        this(NesIIRoot.getByRoot(root), extension);
    }

    /**
     * Create from an ISO 21090 II.
     *
     * @param ii the II
     */
    public NesId(II ii) {
        this(ii.getRoot(), ii.getExtension());
    }

    private void checkNesIdFormat(String nesIdString) {
        Preconditions.checkArgument(isValidNesId(nesIdString),
                "NES id must be in the format <root>:<extension>, was: " + nesIdString);
    }

    private boolean isValidNesId(String nesId) {
        return StringUtils.countMatches(nesId, ":") == 1;
    }

    private Iterator<String> getNesIdParts(String nesIdString) {
        return Splitter.on(NES_ID_SEPARATOR).split(nesIdString).iterator();
    }

    /**
     * @return the root
     */
    public String getRoot() {
        return getRootType().getRoot();
    }

    /**
     * @return the root enum
     */
    public NesIIRoot getRootType() {
        return root;
    }

    /**
     * @return the extension
     */
    public String getExtension() {
        return extension;
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append(root);
        sb.append(NES_ID_SEPARATOR);
        sb.append(extension);
        return sb.toString();
    }

    /**
     * @return as an II
     */
    public II toIi() {
        II ii = new II();
        setValues(ii);
        return ii;
    }

    private void setValues(II ii) {
        ii.setRoot(root.getRoot());
        ii.setExtension(extension);
        ii.setIdentifierName(getRootType().getIdentifierName());
    }

    /**
     * @return as an ISO 21090 Id
     */
    public Id toId() {
        Id id = new Id();
        setValues(id);
        return id;
    }

    @Override
    public boolean equals(Object object) {
        if (!(object instanceof NesId)) {
            return false;
        }
        NesId other = (NesId) object;
        return new EqualsBuilder().append(getRootType(), other.getRootType())
                .append(getExtension(), other.getExtension()).isEquals();
    }

    @Override
    public int hashCode() {
        return new HashCodeBuilder().append(getRootType()).append(getExtension()).hashCode();
    }

}