Package io.deephaven.api

Class ColumnName

java.lang.Object

io.deephaven.api.ColumnName

All Implemented Interfaces:

Expression, JoinAddition, JoinMatch, Pair, Selectable

@Immutable
public abstract class ColumnName
extends Object
implements Selectable, Expression, Pair, JoinMatch, JoinAddition

Represents a column name.

Nested Class Summary

Nested classes/interfaces inherited from interface io.deephaven.api.expression.Expression

Expression.Visitor<T>

Constructor Summary

Constructors

Constructor	Description
ColumnName()

Method Summary

Modifier and Type	Method	Description
final SortColumn	asc()	Equivalent to SortColumn.asc(this).
static Optional<Collection<ColumnName>>	cast(Collection<? extends Selectable> columns)
final SortColumn	desc()	Equivalent to SortColumn.desc(this).
final ColumnName	existingColumn()	The existing column name, from the right table of a join operation.
final Expression	expression()	The expression.
static List<ColumnName>	from(String... values)
static List<ColumnName>	from(Collection<String> values)
final ColumnName	input()	The input column.
static boolean	isValidParsedColumnName(String value)
final ColumnName	left()	The column from the left table.
abstract String	name()	The column name.
static List<String>	names(Collection<? extends ColumnName> columns)
final ColumnName	newColumn()	The new column name, to be added to the new table.
static ColumnName	of(String name)
final ColumnName	output()	The output column.
static ColumnName	parse(String value)
final ColumnName	right()	The column name from the right table.
final String	toString()
final <T> T	walk(Expression.Visitor<T> visitor)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ColumnName

public ColumnName()

Method Details

isValidParsedColumnName

public static boolean isValidParsedColumnName(String value)

of

public static ColumnName of(String name)

parse

public static ColumnName parse(String value)

from

public static List<ColumnName> from(String... values)

from

public static List<ColumnName> from(Collection<String> values)

names

public static List<String> names(Collection<? extends ColumnName> columns)

cast

public static Optional<Collection<ColumnName>> cast(Collection<? extends Selectable> columns)

name

@Parameter
public abstract String name()

The column name.

Returns:

the column name

asc

public final SortColumn asc()

Equivalent to SortColumn.asc(this).

Returns:

the ascending sort column

See Also:

• SortColumn.asc(ColumnName)

desc

public final SortColumn desc()

Equivalent to SortColumn.desc(this).

Returns:

the descending sort column

See Also:

• SortColumn.desc(ColumnName)

walk

public final <T> T walk(Expression.Visitor<T> visitor)

Specified by:

walk in interface Expression

newColumn

public final ColumnName newColumn()

Description copied from interface: Selectable

The new column name, to be added to the new table.

Specified by:

newColumn in interface JoinAddition

Specified by:

newColumn in interface Selectable

Returns:

the new column name

expression

public final Expression expression()

Description copied from interface: Selectable

The expression.

Specified by:

expression in interface Selectable

Returns:

the expression

input

public final ColumnName input()

Description copied from interface: Pair

The input column.

Specified by:

input in interface Pair

Returns:

the input column

output

public final ColumnName output()

Description copied from interface: Pair

The output column.

Specified by:

output in interface Pair

Returns:

the output column

left

public final ColumnName left()

Description copied from interface: JoinMatch

The column from the left table.

Specified by:

left in interface JoinMatch

Returns:

the left column name

right

public final ColumnName right()

Description copied from interface: JoinMatch

The column name from the right table.

Specified by:

right in interface JoinMatch

Returns:

the right column name

existingColumn

public final ColumnName existingColumn()

Description copied from interface: JoinAddition

The existing column name, from the right table of a join operation.

Specified by:

existingColumn in interface JoinAddition

Returns:

the existing column name

toString

public final String toString()

Overrides:

toString in class Object