org.apache.metamodel.sugarcrm

Class SugarCrmDataContext

java.lang.Object

org.apache.metamodel.AbstractDataContext

org.apache.metamodel.QueryPostprocessDataContext

org.apache.metamodel.sugarcrm.SugarCrmDataContext

All Implemented Interfaces:

Closeable, AutoCloseable, HasReadTypeConverters, DataContext

public class SugarCrmDataContext
extends QueryPostprocessDataContext
implements Closeable

A DataContext that uses the SugarCRM SOAP web services to fetch data from the CRM system.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FETCH_SIZE

Fields inherited from class org.apache.metamodel.QueryPostprocessDataContext

INFORMATION_SCHEMA_NAME

Constructor Summary

Constructors

Constructor and Description
SugarCrmDataContext(String sugarCrmBaseUrl, String username, String password, String applicationName)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
protected Number	executeCountQuery(Table table, List<FilterItem> whereItems, boolean functionApproximationAllowed) Executes a simple count query, if possible.
protected Schema	getMainSchema()
protected String	getMainSchemaName()
protected DataSet	materializeMainSchemaTable(Table table, Column[] columns, 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, getDefaultSchemaName, getMainSchemaInternal, getSchemaByNameInternal, getSchemaNamesInternal, isMainSchemaTable, materializeFromItem, materializeMainSchemaTable, materializeMainSchemaTable, materializeTable

Methods inherited from class org.apache.metamodel.AbstractDataContext

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

Methods inherited from class java.lang.Object

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

Field Detail

FETCH_SIZE

public static final int FETCH_SIZE

See Also:

Constant Field Values

Constructor Detail

SugarCrmDataContext

public SugarCrmDataContext(String sugarCrmBaseUrl,
                   String username,
                   String password,
                   String applicationName)

Parameters:

sugarCrmBaseUrl - the base URL of the SugarCRM system, e.g. http://127.0.0.1:9090/sugarcrm

username -

password -

applicationName -

Method Detail

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

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

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.

materializeMainSchemaTable

protected DataSet materializeMainSchemaTable(Table table,
                                 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.