org.apache.metamodel.neo4j

Class Neo4jDataContext

java.lang.Object

org.apache.metamodel.AbstractDataContext

org.apache.metamodel.QueryPostprocessDataContext

org.apache.metamodel.neo4j.Neo4jDataContext

All Implemented Interfaces:

HasReadTypeConverters, DataContext, DocumentSourceProvider

public class Neo4jDataContext
extends QueryPostprocessDataContext
implements DataContext, DocumentSourceProvider

DataContext implementation for Neo4j

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PORT
static org.slf4j.Logger	logger
static String	RELATIONSHIP_COLUMN_SEPARATOR
static String	RELATIONSHIP_PREFIX
static String	SCHEMA_NAME

Fields inherited from class org.apache.metamodel.QueryPostprocessDataContext

INFORMATION_SCHEMA_NAME, SYSTEM_PROPERTY_CREATE_DEFAULT_TABLE_ALIAS

Constructor Summary

Constructors

Constructor and Description
Neo4jDataContext(String hostname, int port, org.apache.http.impl.client.CloseableHttpClient httpClient)
Neo4jDataContext(String hostname, int port, org.apache.http.impl.client.CloseableHttpClient httpClient, SimpleTableDef... tableDefs)
Neo4jDataContext(String hostname, int port, org.apache.http.impl.client.CloseableHttpClient httpClient, String serviceRoot)
Neo4jDataContext(String hostname, int port, org.apache.http.impl.client.CloseableHttpClient httpClient, String serviceRoot, SimpleTableDef... tableDefs)
Neo4jDataContext(String hostname, int port, String username, String password)
Neo4jDataContext(String hostname, int port, String username, String password, SimpleTableDef... tableDefs)
Neo4jDataContext(String hostname, int port, String username, String password, String serviceRoot)
Neo4jDataContext(String hostname, int port, String username, String password, String serviceRoot, SimpleTableDef... tableDefs)

Method Summary

Modifier and Type	Method and Description
SimpleTableDef[]	detectTableDefs()
protected Number	executeCountQuery(Table table, List<FilterItem> whereItems, boolean functionApproximationAllowed) Executes a simple count query, if possible.
protected String	getDefaultSchemaName() Gets the name of the default schema.
DocumentSource	getDocumentSourceForTable(String sourceCollectionName) Gets a DocumentSource for a particular source collection.
protected Schema	getMainSchema()
protected String	getMainSchemaName()
DocumentSource	getMixedDocumentSourceForSampling() Gets a DocumentSource containing documents of mixed origin and type.
protected DataSet	materializeMainSchemaTable(Table table, List<Column> columns, int maxRows) Executes a simple one-table query against a table in the main schema of the subclasses of this class.
protected DataSet	materializeMainSchemaTable(Table table, List<Column> columns, int firstRow, int maxRows) Executes a simple one-table query against a table in the main schema of the subclasses of this class.

Methods inherited from class org.apache.metamodel.QueryPostprocessDataContext

addConverter, executePrimaryKeyLookupQuery, executeQuery, getSchemaByNameInternal, getSchemaNamesInternal, isMainSchemaTable, isScalarFunctionMaterialized, materializeFromItem, 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.DataContext

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

Field Detail

logger

public static final org.slf4j.Logger logger

SCHEMA_NAME

public static final String SCHEMA_NAME

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

RELATIONSHIP_PREFIX

public static final String RELATIONSHIP_PREFIX

See Also:

Constant Field Values

RELATIONSHIP_COLUMN_SEPARATOR

public static final String RELATIONSHIP_COLUMN_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

Neo4jDataContext

public Neo4jDataContext(String hostname,
                        int port,
                        String username,
                        String password,
                        SimpleTableDef... tableDefs)

Neo4jDataContext

public Neo4jDataContext(String hostname,
                        int port,
                        String username,
                        String password,
                        String serviceRoot,
                        SimpleTableDef... tableDefs)

Neo4jDataContext

public Neo4jDataContext(String hostname,
                        int port,
                        String username,
                        String password)

Neo4jDataContext

public Neo4jDataContext(String hostname,
                        int port,
                        String username,
                        String password,
                        String serviceRoot)

Neo4jDataContext

public Neo4jDataContext(String hostname,
                        int port,
                        org.apache.http.impl.client.CloseableHttpClient httpClient)

Neo4jDataContext

public Neo4jDataContext(String hostname,
                        int port,
                        org.apache.http.impl.client.CloseableHttpClient httpClient,
                        String serviceRoot)

Neo4jDataContext

public Neo4jDataContext(String hostname,
                        int port,
                        org.apache.http.impl.client.CloseableHttpClient httpClient,
                        SimpleTableDef... tableDefs)

Neo4jDataContext

public Neo4jDataContext(String hostname,
                        int port,
                        org.apache.http.impl.client.CloseableHttpClient httpClient,
                        String serviceRoot,
                        SimpleTableDef... tableDefs)

Method Detail

getDefaultSchemaName

protected String getDefaultSchemaName()
                               throws MetaModelException

Description copied from class: AbstractDataContext

Gets the name of the default schema.

Overrides:

getDefaultSchemaName in class QueryPostprocessDataContext

Returns:

the default schema name.

Throws:

MetaModelException

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

detectTableDefs

public SimpleTableDef[] detectTableDefs()

materializeMainSchemaTable

protected DataSet materializeMainSchemaTable(Table table,
                                             List<Column> columns,
                                             int firstRow,
                                             int maxRows)

Description copied from class: QueryPostprocessDataContext

Executes a simple one-table query against a table in the main schema of the subclasses of this class. This default implementation will delegate to QueryPostprocessDataContext.materializeMainSchemaTable(Table, List, int) and apply a FirstRowDataSet if necessary.

Overrides:

materializeMainSchemaTable in class QueryPostprocessDataContext

Returns:

materializeMainSchemaTable

protected DataSet materializeMainSchemaTable(Table table,
                                             List<Column> columns,
                                             int maxRows)

Description copied from class: QueryPostprocessDataContext

Executes a simple one-table query against a table in the main schema of the subclasses of this class.

Specified by:

materializeMainSchemaTable in class QueryPostprocessDataContext

Parameters:

table - the table to query

columns - the columns of the table to query

maxRows - the maximum amount of rows needed or -1 if all rows are wanted.

Returns:

a dataset with the raw table/column content.

executeCountQuery

protected Number executeCountQuery(Table table,
                                   List<FilterItem> whereItems,
                                   boolean functionApproximationAllowed)

Description copied from class: QueryPostprocessDataContext

Executes a simple count query, if possible. This method is provided to allow subclasses to optimize count queries since they are quite common and often a datastore can retrieve the count using some specialized means which is much more performant than counting all records manually.

Overrides:

executeCountQuery in class QueryPostprocessDataContext

Parameters:

table - the table on which the count is requested.

whereItems - a (sometimes empty) list of WHERE items.

functionApproximationAllowed - whether approximation is allowed or not.

Returns:

the count of the particular table, or null if not available.

getMixedDocumentSourceForSampling

public DocumentSource getMixedDocumentSourceForSampling()

Description copied from interface: DocumentSourceProvider

Gets a DocumentSource containing documents of mixed origin and type.

Specified by:

getMixedDocumentSourceForSampling in interface DocumentSourceProvider

Returns:

getDocumentSourceForTable

public DocumentSource getDocumentSourceForTable(String sourceCollectionName)

Description copied from interface: DocumentSourceProvider

Gets a DocumentSource for a particular source collection. See Document.getSourceCollectionName().

Specified by:

getDocumentSourceForTable in interface DocumentSourceProvider

Returns: