/*
 * Copyright (c) 2016, Metron, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Metron, Inc. nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL METRON, INC. BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.metsci.glimpse.dspl.parser.column;

import com.metsci.glimpse.dspl.schema.Concept;
import com.metsci.glimpse.dspl.schema.DataType;
import com.metsci.glimpse.dspl.schema.Table.Column;

/**
 * A loaded instance of a dspl Table. The getColumn() method should provide the primary key for the TableColumn.
 * A TableColumn always has a type, but does not have to have an associated Concept, so getConcept() may return null.<p>
 *
 * Usually only one of the typed data getter methods will return valid data (according to the type of the TableColumn
 * returned by getType). However, the TableColumn is allowed (but not required) to automatically coerce data (converting
 * Integers to Strings for example).
 *
 * @author ulman
 *
 */
public interface TableColumn
{
    public Column getColumn( );

    public Concept getConcept( );

    public DataType getType( );

    public boolean isConstant( );

    public int getSize( );

    public String[] getStringData( );

    public int[] getIntegerData( );

    public float[] getFloatData( );

    public boolean[] getBooleanData( );

    public long[] getDateData( );

    public String getStringData( int i );

    public int getIntegerData( int i );

    public float getFloatData( int i );

    public boolean getBooleanData( int i );

    public long getDateData( int i );
}