Package org.apache.drill.exec.store

Enum ColumnExplorer.ImplicitFileColumns

java.lang.Object

java.lang.Enum<ColumnExplorer.ImplicitFileColumns>

org.apache.drill.exec.store.ColumnExplorer.ImplicitFileColumns

All Implemented Interfaces:

Serializable, Comparable<ColumnExplorer.ImplicitFileColumns>, ColumnExplorer.ImplicitFileColumn

Enclosing class:

ColumnExplorer

public static enum ColumnExplorer.ImplicitFileColumns
extends Enum<ColumnExplorer.ImplicitFileColumns>
implements ColumnExplorer.ImplicitFileColumn

Columns that give information from where file data comes from. Columns are implicit, so should be called explicitly in query

Enum Constant Summary

Enum Constants

Enum Constant	Description
FILENAME	File name with extension without path
FILEPATH	Full path to file without file name
FQN	Fully qualified name, contains full path to file and file name
SUFFIX	File suffix (without dot at the beginning)

Method Summary

Modifier and Type	Method	Description
abstract String	getValue(org.apache.hadoop.fs.Path path)	Using file path calculates value for each implicit file column
String	optionName()	The name of the session/system option that gives the effective name of this implicit column when parsing columns by name.
String	propertyValue()	The name of the column property that indicates the implicit column type when using a provided schema.
static ColumnExplorer.ImplicitFileColumns	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ColumnExplorer.ImplicitFileColumns[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.drill.exec.store.ColumnExplorer.ImplicitFileColumn

isOptional

Enum Constant Details

FQN

public static final ColumnExplorer.ImplicitFileColumns FQN

Fully qualified name, contains full path to file and file name

FILEPATH

public static final ColumnExplorer.ImplicitFileColumns FILEPATH

Full path to file without file name

FILENAME

public static final ColumnExplorer.ImplicitFileColumns FILENAME

File name with extension without path

SUFFIX

public static final ColumnExplorer.ImplicitFileColumns SUFFIX

File suffix (without dot at the beginning)

Method Details

values

public static ColumnExplorer.ImplicitFileColumns[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ColumnExplorer.ImplicitFileColumns valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

optionName

public String optionName()

The name of the session/system option that gives the effective name of this implicit column when parsing columns by name.

Specified by:

optionName in interface ColumnExplorer.ImplicitFileColumn

Returns:

option name for obtaining implicit column name.

propertyValue

public String propertyValue()

The name of the column property that indicates the implicit column type when using a provided schema. The property value lives in a name space separate from column names and so is fixed: it remains the same independent of system/session options.

getValue

public abstract String getValue(org.apache.hadoop.fs.Path path)

Using file path calculates value for each implicit file column