org.labkey.remoteapi.assay.Data Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of labkey-client-api Show documentation

The client-side library for Java developers is a separate JAR from the LabKey Server code base. It can be used by any Java program, including another Java web application.

There is a newer version: 6.2.0

Show newest version

/*
 * Copyright (c) 2010 LabKey Corporation
 *
 * 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 org.labkey.remoteapi.assay;

import org.json.JSONObject;

/**
 * Represents a data file that may be used in a run. In order to successfully look up a data file when saving a run,
 * the server checks for the id, pipelinePath, dataFileURL, and pipelinePath properties (in that order) to try to resolve
 * the file reference. At least one must be specified.
 */
public class Data extends ExpObject
{
    private String _dataFileURL;
    private String _absolutePath;
    private String _pipelinePath;

    public Data()
    {
        super();
    }

    public Data(JSONObject json)
    {
        super(json);
        _dataFileURL = json.optString("dataFileURL", null);
        _absolutePath = json.optString("absolutePath", null);
        _pipelinePath = json.optString("pipelinePath", null);
    }

    @Override
    public JSONObject toJSONObject()
    {
        JSONObject result = super.toJSONObject();
        result.put("dataFileURL", _dataFileURL);
        result.put("absolutePath", _absolutePath);
        result.put("pipelinePath", _pipelinePath);
        return result;
    }

    /** @return the URL to the data file from the web server's perspective */
    public String getDataFileURL()
    {
        return _dataFileURL;
    }

    /** @param dataFileURL the URL to the data file from the web server's perspective */
    public void setDataFileURL(String dataFileURL)
    {
        _dataFileURL = dataFileURL;
    }

    /** @return the full path to the file from the web server's file system perspective */
    public String getAbsolutePath()
    {
        return _absolutePath;
    }

    /** @param absolutePath the full path to the file from the web server's file system perspective */
    public void setAbsolutePath(String absolutePath)
    {
        _absolutePath = absolutePath;
    }

    /** @return the path to the file on the file system, relative to the folder's pipeline root */
    public String getPipelinePath()
    {
        return _pipelinePath;
    }

    /** @param pipelinePath the path to the file on the file system, relative to the folder's pipeline root */
    public void setPipelinePath(String pipelinePath)
    {
        _pipelinePath = pipelinePath;
    }
}