io.deephaven.engine.table.impl.locations.ColumnLocation Maven / Gradle / Ivy
Show all versions of deephaven-engine-table Show documentation
/**
* Copyright (c) 2016-2022 Deephaven Data Labs and Patent Pending
*/
package io.deephaven.engine.table.impl.locations;
import io.deephaven.base.log.LogOutput;
import io.deephaven.base.log.LogOutputAppendable;
import io.deephaven.engine.table.ColumnDefinition;
import io.deephaven.engine.util.string.StringUtils;
import io.deephaven.chunk.attributes.Values;
import io.deephaven.engine.table.impl.sources.regioned.*;
import io.deephaven.util.type.NamedImplementation;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/**
* Per-TableLocation, per-column key, state, and factory object.
*/
public interface ColumnLocation extends StringUtils.StringKeyedObject, NamedImplementation, LogOutputAppendable {
/**
* Get the {@link TableLocation} enclosing this ColumnLocation.
*
* @return the {@link TableLocation} enclosing this ColumnLocation
*/
@NotNull
TableLocation getTableLocation();
/**
* Get the column name for this ColumnLocation.
*
* @return the column name for this ColumnLocation
*/
@NotNull
String getName();
/**
* Check for existence of this ColumnLocation.
*
* @return True iff the ColumnLocation actually exists
*/
boolean exists();
/**
*
* Get the metadata object stored with this column, or null if no such data exists.
*
* This is typically a value to range map (grouping metadata). The value to range map, if non-null, is a map from
* unique (boxed) column values for this location to the associated ranges in which they occur. Ranges are either
* 2-element int[]s, or 2-element long[]s.
*
* @return The metadata stored with this column, or null if no such data exists
*/
@Nullable
METADATA_TYPE getMetadata(@NotNull ColumnDefinition columnDefinition);
// ------------------------------------------------------------------------------------------------------------------
// ColumnRegion Factories
// ------------------------------------------------------------------------------------------------------------------
/**
* @param columnDefinition The {@link ColumnDefinition} used to lookup type information
* @return A {@link ColumnRegionChar} for reading data from this ColumnLocation
* @throws UnsupportedOperationException If this ColumnLocation does not contain char data
*/
ColumnRegionChar makeColumnRegionChar(@NotNull ColumnDefinition columnDefinition);
/**
* @param columnDefinition The {@link ColumnDefinition} used to lookup type information
* @return A {@link ColumnRegionByte} for reading data from this ColumnLocation
* @throws UnsupportedOperationException If this ColumnLocation does not contain byte data
*/
ColumnRegionByte makeColumnRegionByte(@NotNull ColumnDefinition columnDefinition);
/**
* @param columnDefinition The {@link ColumnDefinition} used to lookup type information
* @return A {@link ColumnRegionShort} for reading data from this ColumnLocation
* @throws UnsupportedOperationException If this ColumnLocation does not contain short data
*/
ColumnRegionShort makeColumnRegionShort(@NotNull ColumnDefinition columnDefinition);
/**
* @param columnDefinition The {@link ColumnDefinition} used to lookup type information
* @return A {@link ColumnRegionInt} for reading data from this ColumnLocation
* @throws UnsupportedOperationException If this ColumnLocation does not contain int data
*/
ColumnRegionInt makeColumnRegionInt(@NotNull ColumnDefinition columnDefinition);
/**
* @param columnDefinition The {@link ColumnDefinition} used to lookup type information
* @return A {@link ColumnRegionLong} for reading data from this ColumnLocation
* @throws UnsupportedOperationException If this ColumnLocation does not contain long data
*/
ColumnRegionLong makeColumnRegionLong(@NotNull ColumnDefinition columnDefinition);
/**
* @param columnDefinition The {@link ColumnDefinition} used to lookup type information
* @return A {@link ColumnRegionFloat} for reading data from this ColumnLocation
* @throws UnsupportedOperationException If this ColumnLocation does not contain float data
*/
ColumnRegionFloat makeColumnRegionFloat(@NotNull ColumnDefinition columnDefinition);
/**
* @param columnDefinition The {@link ColumnDefinition} used to lookup type information
* @return A {@link ColumnRegionDouble} for reading data from this ColumnLocation
* @throws UnsupportedOperationException If this ColumnLocation does not contain double data
*/
ColumnRegionDouble makeColumnRegionDouble(@NotNull ColumnDefinition columnDefinition);
/**
* @param columnDefinition The {@link ColumnDefinition} used to lookup type information
* @return A {@link ColumnRegionObject} for reading data from this ColumnLocation
* @throws UnsupportedOperationException If this ColumnLocation does not contain object data
*/
ColumnRegionObject makeColumnRegionObject(@NotNull ColumnDefinition columnDefinition);
// ------------------------------------------------------------------------------------------------------------------
// StringKeyedObject implementation
// ------------------------------------------------------------------------------------------------------------------
@Override
default String getStringRepresentation() {
return getName();
}
// ------------------------------------------------------------------------------------------------------------------
// LogOutputAppendable implementation / toString() override helper
// ------------------------------------------------------------------------------------------------------------------
@Override
default LogOutput append(@NotNull final LogOutput logOutput) {
return logOutput.append(getTableLocation())
.append(':').append(getImplementationName())
.append('[').append(getName())
.append(']');
}
default String toStringHelper() {
return getTableLocation().toString()
+ ':' + getImplementationName()
+ '[' + getName()
+ ']';
}
}