com.ggasoftware.parso.Column Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of parso Show documentation
A lightweight library to parse sas7bdat files. Supports 'CHAR' compression.
The newest version!
package com.ggasoftware.parso;

/**
 * A class to store column metadata.
 */
public class Column {
    /**
     * The column id.
     */
    private int id;

    /**
     * The column name.
     */
    private String name;

    /**
     * The column label.
     */
    private String label;

    /**
     * The column format
     */
    private String format;

    /**
     * The class of data stored in the cells of rows related to a column, can be Number.class or String.class.
     */
    private Class type;

    /**
     * The data length of the column.
     */
    private int length;

    /**
     * The constructor that defines all parameters of the Column class.
     *
     * @param name   the column name.
     * @param label  the column label.
     * @param format the column format
     * @param type   the class of data stored in cells of rows related to the column, can be Number.class or
     *               String.class.
     */
    public Column(int id, String name, String label, String format, Class type, int length) {
        this.id = id;
        this.name = name;
        this.label = label;
        this.format = format;
        this.type = type;
        this.length = length;
    }

    /**
     * The function to get {@link Column#id}.
     *
     * @return the number that contains the column id.
     */
    public int getId() {
        return id;
    }

    /**
     * The function to get {@link Column#name}.
     *
     * @return the string that contains the column name.
     */
    public String getName() {
        return name;
    }

    /**
     * The function to get {@link Column#format}.
     *
     * @return the string that contains the column format.
     */
    public String getFormat() {
        return format;
    }

    /**
     * The function to get {@link Column#type}.
     *
     * @return the class of data stored in cells of rows related to the column.
     */
    public Class getType() {
        return type;
    }

    /**
     * The function to get {@link Column#label}.
     *
     * @return the string that contains the column label.
     */
    public String getLabel() {
        return label;
    }

    /**
     * The function to get {@link Column#length}.
     *
     * @return the number that contains the column length.
     */
    public int getLength() {
        return length;
    }
}