edu.stanford.protege.webprotege.csv.GetCSVGridAction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of webprotege-backend-service Show documentation

The newest version!

package edu.stanford.protege.webprotege.csv;

import edu.stanford.protege.webprotege.dispatch.Action;

import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;

/**
 * Author: Matthew Horridge

 * Stanford University

 * Bio-Medical Informatics Research Group

 * Date: 21/05/2013
 */
public class GetCSVGridAction implements Action {

    public static final String CHANNEL = "webprotege.csv.GetCsvGrid";

    private final DocumentId csvDocumentId;

    private final int rowLimit;

    @Override
    public String getChannel() {
        return CHANNEL;
    }

    /**
     * Constructs a CSVGrid action.
     * @param csvDocumentId The document id that identifies the csv document to retrieve.  Not {@code null}.
     * @param rowLimit The maximum number of rows to read from the document. The value must be greater than zero.
     * @throws NullPointerException if {@code csvDocumentId} is {@code null}.
     * @throws IllegalArgumentException if {@code rowLimit} is not greater than zero.
     */
    public GetCSVGridAction(DocumentId csvDocumentId, int rowLimit) {
        this.csvDocumentId = checkNotNull(csvDocumentId);
        checkArgument(rowLimit > 0);
        this.rowLimit = rowLimit;
    }

    /**
     * Gets the {@link DocumentId} of the CSV document to read.
     * @return The document id.  Not {@code null}.
     */
    public DocumentId getCSVDocumentId() {
        return csvDocumentId;
    }

    /**
     * Gets the row limit.
     * @return The row limit which will be greater than zero.
     */
    public int getRowLimit() {
        return rowLimit;
    }
}