org.apache.drill.exec.record.metadata

Interface Propertied

All Known Subinterfaces:

ColumnMetadata, TupleMetadata

All Known Implementing Classes:

AbstractColumnMetadata, AbstractMapColumnMetadata, AbstractPropertied, DictColumnMetadata, DynamicColumn, MapColumnMetadata, PrimitiveColumnMetadata, ProjectedColumn, RepeatedListColumnMetadata, TupleSchema, VariantColumnMetadata

public interface Propertied

Interface for an object that defines properties. Used in conjunction with PropertyAccessor.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DRILL_PROP_PREFIX Base name for properties which Drill itself defines.

Method Summary

Modifier and Type	Method and Description
boolean	booleanProperty(String key)
boolean	booleanProperty(String key, boolean defaultValue)
boolean	hasProperties()
int	intProperty(String key)
int	intProperty(String key, int defaultValue)
static String	pluginPrefix(String pluginName) Drill-wide properties are of the form: drill. While plugin-specific properties are of the form: drill.. Where "config prop name" is the field name in the plugin config.
Map<String,String>	properties()
String	property(String key)
String	property(String key, String defValue)
void	removeProperty(String key)
void	setBooleanProperty(String key, boolean value)
void	setIntProperty(String key, int value)
void	setProperties(Map<String,String> properties) Sets schema properties if not null.
void	setProperty(String key, String value)

Field Detail

DRILL_PROP_PREFIX

static final String DRILL_PROP_PREFIX

Base name for properties which Drill itself defines. Provides a separate "name space" from user-defined properties which should have some other prefix.

See Also:

Constant Field Values

Method Detail

setProperties

void setProperties(Map<String,String> properties)

Sets schema properties if not null.

Parameters:

properties - schema properties

hasProperties

boolean hasProperties()

properties

Map<String,String> properties()

property

String property(String key)

property

String property(String key,
                String defValue)

setProperty

void setProperty(String key,
                 String value)

booleanProperty

boolean booleanProperty(String key)

booleanProperty

boolean booleanProperty(String key,
                        boolean defaultValue)

setBooleanProperty

void setBooleanProperty(String key,
                        boolean value)

intProperty

int intProperty(String key)

intProperty

int intProperty(String key,
                int defaultValue)

setIntProperty

void setIntProperty(String key,
                    int value)

removeProperty

void removeProperty(String key)

pluginPrefix

static String pluginPrefix(String pluginName)

Drill-wide properties are of the form:
drill.
While plugin-specific properties are of the form:
drill..
Where "config prop name" is the field name in the plugin config.

This function generates the "drill.." prefix.

Parameters:

pluginName - name used in the "type" field of the plugin config

Returns:

the "drill.." prefix