org.apache.metamodel.elasticsearch

Class AbstractElasticSearchDataContext

java.lang.Object

org.apache.metamodel.AbstractDataContext

org.apache.metamodel.QueryPostprocessDataContext

org.apache.metamodel.elasticsearch.AbstractElasticSearchDataContext

All Implemented Interfaces:

HasReadTypeConverters, DataContext, UpdateableDataContext

Direct Known Subclasses:

ElasticSearchDataContext, ElasticSearchRestDataContext

public abstract class AbstractElasticSearchDataContext
extends QueryPostprocessDataContext
implements DataContext, UpdateableDataContext

Field Summary

Fields

Modifier and Type	Field and Description
protected List<SimpleTableDef>	dynamicTableDefinitions
protected String	indexName
protected List<SimpleTableDef>	staticTableDefinitions
static org.elasticsearch.common.unit.TimeValue	TIMEOUT_SCROLL

Fields inherited from class org.apache.metamodel.QueryPostprocessDataContext

INFORMATION_SCHEMA_NAME, SYSTEM_PROPERTY_CREATE_DEFAULT_TABLE_ALIAS

Constructor Summary

Constructors

Constructor and Description
AbstractElasticSearchDataContext(String indexName, SimpleTableDef... tableDefinitions) Constructs a AbstractElasticSearchDataContext.

Method Summary

Modifier and Type	Method and Description
protected abstract SimpleTableDef[]	detectSchema() Performs an analysis of the available indexes in an ElasticSearch cluster instance and detects the elasticsearch types structure based on the metadata provided by the ElasticSearch java client.
String	getIndexName() Gets the name of the index that this DataContext is working on.
protected Schema	getMainSchema()
protected String	getMainSchemaName()
protected boolean	limitMaxRowsIsSet(int maxRows)
protected static SimpleTableDef[]	sortTables(List<SimpleTableDef> result)

Methods inherited from class org.apache.metamodel.QueryPostprocessDataContext

addConverter, executeCountQuery, executePrimaryKeyLookupQuery, executeQuery, getDefaultSchemaName, getSchemaByNameInternal, getSchemaNamesInternal, isMainSchemaTable, isScalarFunctionMaterialized, materializeFromItem, materializeMainSchemaTable, materializeMainSchemaTable, materializeMainSchemaTable, materializeMainSchemaTableSelect, materializeTable

Methods inherited from class org.apache.metamodel.AbstractDataContext

compileQuery, executeQuery, executeQuery, getColumnByQualifiedLabel, getDefaultSchema, getSchemaByName, getSchemaNames, getSchemas, getTableByQualifiedLabel, isQualifiedPathDelim, onSchemaCacheRefreshed, parseQuery, query, refreshSchemas

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.metamodel.UpdateableDataContext

executeUpdate

Methods inherited from interface org.apache.metamodel.DataContext

compileQuery, executeQuery, executeQuery, executeQuery, getColumnByQualifiedLabel, getDefaultSchema, getSchemaByName, getSchemaNames, getSchemas, getTableByQualifiedLabel, parseQuery, query, refreshSchemas

Field Detail

TIMEOUT_SCROLL

public static final org.elasticsearch.common.unit.TimeValue TIMEOUT_SCROLL

indexName

protected final String indexName

staticTableDefinitions

protected final List<SimpleTableDef> staticTableDefinitions

dynamicTableDefinitions

protected final List<SimpleTableDef> dynamicTableDefinitions

Constructor Detail

AbstractElasticSearchDataContext

public AbstractElasticSearchDataContext(String indexName,
                                        SimpleTableDef... tableDefinitions)

Constructs a AbstractElasticSearchDataContext. This constructor accepts a custom array of SimpleTableDefs which allows the user to define his own view on the indexes in the engine.

Parameters:

indexName - the name of the ElasticSearch index to represent

tableDefinitions - an array of SimpleTableDefs, which define the table and column model of the ElasticSearch index.

Method Detail

detectSchema

protected abstract SimpleTableDef[] detectSchema()

Performs an analysis of the available indexes in an ElasticSearch cluster instance and detects the elasticsearch types structure based on the metadata provided by the ElasticSearch java client.

Returns:

a mutable schema instance, useful for further fine tuning by the user.

getMainSchema

protected Schema getMainSchema()
                        throws MetaModelException

Specified by:

getMainSchema in class QueryPostprocessDataContext

Returns:

the main schema that subclasses of this class produce

Throws:

MetaModelException

getMainSchemaName

protected String getMainSchemaName()
                            throws MetaModelException

Specified by:

getMainSchemaName in class QueryPostprocessDataContext

Returns:

the name of the main schema that subclasses of this class produce

Throws:

MetaModelException

getIndexName

public String getIndexName()

Gets the name of the index that this DataContext is working on.

limitMaxRowsIsSet

protected boolean limitMaxRowsIsSet(int maxRows)

sortTables

protected static SimpleTableDef[] sortTables(List<SimpleTableDef> result)