Package io.deephaven.engine.table.impl.locations.local

Class URITableLocationKey

java.lang.Object

io.deephaven.engine.table.impl.locations.impl.PartitionedTableLocationKey

io.deephaven.engine.table.impl.locations.local.URITableLocationKey

All Implemented Interfaces:

LogOutputAppendable, ImmutableTableLocationKey, TableLocationKey, NamedImplementation, Comparable<TableLocationKey>

Direct Known Subclasses:

ParquetTableLocationKey

public class URITableLocationKey
extends PartitionedTableLocationKey

Base ImmutableTableLocationKey implementation for table locations that may be enclosed by partitions and described by a URI. Sub-classes should override compareTo(TableLocationKey) and equals(Object) only if they need to prevent equality with other URITableLocationKey implementations.

Nested Class Summary

Nested classes/interfaces inherited from class io.deephaven.engine.table.impl.locations.impl.PartitionedTableLocationKey

PartitionedTableLocationKey.PartitionsComparator, PartitionedTableLocationKey.PartitionsFormatter

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	order
protected final URI	uri

Fields inherited from class io.deephaven.engine.table.impl.locations.impl.PartitionedTableLocationKey

partitions

Constructor Summary

Constructors

Constructor	Description
URITableLocationKey(@NotNull URI uri, int order, @Nullable Map<String,Comparable<?>> partitions)	Construct a new URITableLocationKey for the supplied uri and partitions.

Method Summary

Modifier and Type	Method	Description
LogOutput	append(@NotNull LogOutput logOutput)
int	compareTo(@NotNull TableLocationKey other)	When comparing with another URITableLocationKey, precedence-wise this implementation compares order, then applies a PartitionedTableLocationKey.PartitionsComparator to partitions, then compares uri.
boolean	equals(@Nullable Object other)
String	getImplementationName()	Get a name for the implementing class.
final URI	getURI()
int	hashCode()
String	toString()

Methods inherited from class io.deephaven.engine.table.impl.locations.impl.PartitionedTableLocationKey

getPartitionKeys, getPartitionValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.deephaven.engine.table.impl.locations.ImmutableTableLocationKey

makeImmutable

Methods inherited from interface io.deephaven.engine.table.impl.locations.TableLocationKey

clear

Field Details

uri

protected final URI uri

order

protected final int order

Constructor Details

URITableLocationKey

public URITableLocationKey(@NotNull
 @NotNull URI uri,
 int order,
 @Nullable
 @Nullable Map<String,Comparable<?>> partitions)

Construct a new URITableLocationKey for the supplied uri and partitions.

Parameters:

uri - The uri (or directory) that backs the keyed location. Will be adjusted to an absolute path.

order - Explicit ordering value for this location key. Comparable.compareTo(Object) will sort URITableLocationKeys with a lower order before other keys. Comparing this ordering value takes precedence over other fields.

partitions - The table partitions enclosing the table location keyed by this. Note that if this parameter is null, the location will be a member of no partitions. An ordered copy of the map will be made, so the calling code is free to mutate the map after this call completes, but the partition keys and values themselves must be effectively immutable.

Method Details

getURI

public final URI getURI()

append

public LogOutput append(@NotNull
 @NotNull LogOutput logOutput)

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(@NotNull
 @NotNull TableLocationKey other)

When comparing with another URITableLocationKey, precedence-wise this implementation compares order, then applies a PartitionedTableLocationKey.PartitionsComparator to partitions, then compares uri. Otherwise, it delegates to parent class.

By default, compare fully qualified class names of the implementing classes. This method is a fallback where the implementing classes are not directly comparable, and should help establish a consistent ordering between distinct implementations.

Specified by:

compareTo in interface Comparable<TableLocationKey>

Specified by:

compareTo in interface TableLocationKey

Overrides:

compareTo in class PartitionedTableLocationKey

hashCode

public int hashCode()

Overrides:

hashCode in class PartitionedTableLocationKey

equals

public boolean equals(@Nullable
 @Nullable Object other)

Overrides:

equals in class PartitionedTableLocationKey

getImplementationName

public String getImplementationName()

Description copied from interface: NamedImplementation

Get a name for the implementing class. Useful for abstract classes that implement LogOutputAppendable or override toString.

The default implementation is correct, but not suitable for high-frequency usage.

Returns:

A name for the implementing class