edu.pitt.dbmi.data.reader.DataColumn Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of data-reader Show documentation

The newest version!

/*
 * Copyright (C) 2018 University of Pittsburgh.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301  USA
 */
package edu.pitt.dbmi.data.reader;

/**
 * Dec 8, 2018 4:14:30 PM
 *
 * @author Kevin V. Bui ([email protected])
 * @version $Id: $Id
 */
public interface DataColumn {

    /**
     * Get the column's name.
     *
     * @return the column's name.
     */
    String getName();

    /**
     * Get the column's number.
     *
     * @return the column's number.
     */
    int getColumnNumber();

    /**
     * True if this column was not read in from source such as file.
     *
     * @return true if this column was not read in from source such as file.
     */
    boolean isGenerated();

    /**
     * True if the datatype is discrete.
     *
     * @return true if the datatype is discrete.
     */
    boolean isDiscrete();

    /**
     * Set true for discrete datatype.
     *
     * @param discrete true for discrete datatype.
     */
    void setDiscrete(boolean discrete);

}