ch.systemsx.cisd.openbis.generic.shared.dto.NewExternalData.java Source code

Introduction

Here is the source code for ch.systemsx.cisd.openbis.generic.shared.dto.NewExternalData.java

Source

/*
 * Copyright 2007 ETH Zuerich, CISD
 *
 * 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.
 */

package ch.systemsx.cisd.openbis.generic.shared.dto;

import java.util.Date;

import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;

import ch.systemsx.cisd.common.types.BooleanOrUnknown;
import ch.systemsx.cisd.openbis.generic.shared.IServer;
import ch.systemsx.cisd.openbis.generic.shared.basic.dto.DataSetType;
import ch.systemsx.cisd.openbis.generic.shared.basic.dto.FileFormatType;
import ch.systemsx.cisd.openbis.generic.shared.basic.dto.LocatorType;

/**
 * Information given to openBIS when registering a new external data set.
 * 
 * @author Christian Ribeaud
 */
public final class NewExternalData extends ExtractableData {
    private static final long serialVersionUID = IServer.VERSION;

    private String location;

    private StorageFormat storageFormat;

    private Date registrationDate;

    private FileFormatType fileFormatType;

    private DataSetType dataSetType;

    private LocatorType locatorType;

    private BooleanOrUnknown complete = BooleanOrUnknown.U;

    private String associatedSampleCode;

    private String dataStoreCode;

    private boolean measured;

    /** Returns <code>dataSetType</code>. */
    public final DataSetType getDataSetType() {
        return dataSetType;
    }

    /** Sets <code>dataSetType</code>. */
    public final void setDataSetType(final DataSetType dataSetType) {
        this.dataSetType = dataSetType;
    }

    /** Returns <code>locator</code>. */
    public final String getLocation() {
        return location;
    }

    /** Sets <code>locator</code>. */
    public final void setLocation(final String locator) {
        this.location = locator;
    }

    /**
     * Returns the storage format (proprietary or BDS) of this external data set.
     */
    public StorageFormat getStorageFormat() {
        return storageFormat;
    }

    /**
     * Sets the storage format (proprietary or BDS) of this external data set.
     */
    public void setStorageFormat(final StorageFormat storageFormat) {
        this.storageFormat = storageFormat;
    }

    /** Returns the date when the data set has been registered to the database. */
    public Date getRegistrationDate() {
        return registrationDate;
    }

    /** Sets the date when the data set has been registered to the database. */
    public void setRegistrationDate(final Date registrationDate) {
        this.registrationDate = registrationDate;
    }

    /** Returns <code>fileFormatType</code>. */
    public final FileFormatType getFileFormatType() {
        return fileFormatType;
    }

    /** Sets <code>fileFormatType</code>. */
    public final void setFileFormatType(final FileFormatType fileFormatType) {
        this.fileFormatType = fileFormatType;
    }

    /** Returns <code>locatorType</code>. */
    public final LocatorType getLocatorType() {
        return locatorType;
    }

    /** Sets <code>locatorType</code>. */
    public final void setLocatorType(final LocatorType locatorType) {
        this.locatorType = locatorType;
    }

    /**
     * Returns {@link BooleanOrUnknown#T}, if the data set is complete in the data store and
     * {@link BooleanOrUnknown#F}, if some parts of the data are missing. If the completeness is not
     * known (e.g. because the data set is stored in a format that does not allow to assess the
     * completeness, {@link BooleanOrUnknown#U} is returned.
     */
    public final BooleanOrUnknown getComplete() {
        return complete;
    }

    /**
     * Sets whether this data set is complete in the data store or not. The default is
     * {@link BooleanOrUnknown#U}, which corresponds to the case where the data are stored in a
     * format that does not allow to assess completeness.
     */
    public final void setComplete(final BooleanOrUnknown complete) {
        this.complete = complete;
    }

    public String getAssociatedSampleCode() {
        return associatedSampleCode;
    }

    public void setAssociatedSampleCode(final String sampleCode) {
        this.associatedSampleCode = sampleCode;
    }

    public final String getDataStoreCode() {
        return dataStoreCode;
    }

    public final void setDataStoreCode(String dataStoreCode) {
        this.dataStoreCode = dataStoreCode;
    }

    public final boolean isMeasured() {
        return measured;
    }

    public final void setMeasured(boolean measured) {
        this.measured = measured;
    }

    //
    // Object
    //

    @Override
    public final boolean equals(final Object obj) {
        if (obj == this) {
            return true;
        }
        if (obj instanceof NewExternalData == false) {
            return false;
        }
        final NewExternalData that = (NewExternalData) obj;
        final EqualsBuilder builder = new EqualsBuilder();
        builder.append(that.location, location);
        return builder.isEquals();
    }

    @Override
    public final int hashCode() {
        final HashCodeBuilder builder = new HashCodeBuilder();
        builder.append(location);
        return builder.toHashCode();
    }

    //
    // Comparable
    //

    /**
     * If <code>null</code> values are present for <code>code</code>, then they come first.
     */
    @Override
    public final int compareTo(final ExtractableData o) {
        final String thatLocation = ((NewExternalData) o).location;
        if (location == null) {
            return thatLocation == null ? 0 : -1;
        }
        if (thatLocation == null) {
            return 1;
        }
        return location.compareTo(thatLocation);
    }

}