io.github.vmzakharov.ecdataframe.dataframe.DfColumn Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dataframe-ec Show documentation

A tabular data structure based on the Eclipse Collections framework

There is a newer version: 1.0.0

package io.github.vmzakharov.ecdataframe.dataframe;

import io.github.vmzakharov.ecdataframe.dsl.value.Value;
import io.github.vmzakharov.ecdataframe.dsl.value.ValueType;

import static io.github.vmzakharov.ecdataframe.util.ExceptionFactory.exceptionByKey;

public interface DfColumn
{
    String getName();

    String getValueAsString(int rowIndex);

    default String getValueAsStringLiteral(int rowIndex)
    {
        return this.isNull(rowIndex) ? "" : this.getValueAsString(rowIndex);
    }

    void addObject(Object newObject);

    void addValue(Value value);

    boolean isNull(int rowIndex);

    Object getObject(int rowIndex);

    DataFrame getDataFrame();

    Value getValue(int rowIndex);

    ValueType getType();

    boolean isStored();

    default boolean isComputed()
    {
        return !this.isStored();
    }

    int getSize();

    void setObject(int rowIndex, Object anObject);

    void addEmptyValue();

    default Object aggregate(AggregateFunction aggregateFunction)
    {
        if (!aggregateFunction.supportsSourceType(this.getType()))
        {
            throw aggregateFunction.notApplicable(this);
        }

        if (this.getSize() == 0)
        {
            return aggregateFunction.valueForEmptyColumn(this);
        }

        try
        {
            return aggregateFunction.applyToColumn(this);
        }
        catch (NullPointerException npe)
        {
            // npe can be thrown if there is a null value stored in a column of primitive type, this can happen when
            // converting column values to a list.
            return null;
        }
    }

    void applyAggregator(int targetRowIndex, DfColumn sourceColumn, int sourceRowIndex, AggregateFunction aggregateFunction);

    DfColumn cloneSchemaAndAttachTo(DataFrame attachTo);

    DfColumn cloneSchemaAndAttachTo(DataFrame attachTo, String newName);

    void addRowToColumn(int rowIndex, DfColumn target);

    default void enablePooling()
    {
        // nothing
    }

    default void disablePooling()
    {
        // nothing
    }

    DfColumn mergeWithInto(DfColumn other, DataFrame target);

    DfColumn copyTo(DataFrame target);

    default DfCellComparator columnComparator(DfColumn otherColumn)
    {
        throw exceptionByKey("DF_NO_COL_COMPARATOR")
                .with("columnName", this.getName())
                .with("columnType", this.getType())
                .getUnsupported();
    }

    default int dataFrameRowIndex(int virtualRowIndex)
    {
        return this.getDataFrame().rowIndexMap(virtualRowIndex);
    }
}