org.apache.metamodel.salesforce

Class SalesforceDataContext

java.lang.Object

org.apache.metamodel.AbstractDataContext

org.apache.metamodel.QueryPostprocessDataContext

org.apache.metamodel.salesforce.SalesforceDataContext

All Implemented Interfaces:

HasReadTypeConverters, DataContext, UpdateableDataContext

public class SalesforceDataContext
extends QueryPostprocessDataContext
implements UpdateableDataContext

A datacontext that uses the Salesforce API. Metadata about schema structure is explored using 'describe' SOAP web services. Queries are fired using the SOQL dialect of SQL, see SOQL reference.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SOQL_DATE_FORMAT_IN
static String	SOQL_DATE_FORMAT_OUT
static String	SOQL_DATE_TIME_FORMAT_IN
static String	SOQL_DATE_TIME_FORMAT_OUT
static String	SOQL_TIME_FORMAT_IN
static String	SOQL_TIME_FORMAT_OUT
static TimeZone	SOQL_TIMEZONE

Fields inherited from class org.apache.metamodel.QueryPostprocessDataContext

INFORMATION_SCHEMA_NAME, SYSTEM_PROPERTY_CREATE_DEFAULT_TABLE_ALIAS

Constructor Summary

Constructors

Constructor and Description
SalesforceDataContext(com.sforce.soap.partner.PartnerConnection connection) Creates a SalesforceDataContext instance , configured with given salesforce connection.
SalesforceDataContext(String username, String password)
SalesforceDataContext(String username, String password, String securityToken)
SalesforceDataContext(String endpoint, String username, String password, String securityToken)

Method Summary

Modifier and Type	Method and Description
protected Number	executeCountQuery(Table table, List<FilterItem> whereItems, boolean functionApproximationAllowed) Executes a simple count query, if possible.
DataSet	executeQuery(Query query) Executes a query against the DataContext.
UpdateSummary	executeUpdate(UpdateScript update) Submits an UpdateScript for execution on the DataContext.
com.sforce.soap.partner.PartnerConnection	getConnection() Returns the Salesforce connection being used by this datacontext.
protected Schema	getMainSchema()
protected String	getMainSchemaName()
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 static void	rewriteFilterItem(StringBuilder sb, FilterItem filterItem)

Methods inherited from class org.apache.metamodel.QueryPostprocessDataContext

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

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

Field Detail

SOQL_TIMEZONE

public static final TimeZone SOQL_TIMEZONE

SOQL_DATE_FORMAT_IN

public static final String SOQL_DATE_FORMAT_IN

See Also:

Constant Field Values

SOQL_DATE_FORMAT_OUT

public static final String SOQL_DATE_FORMAT_OUT

See Also:

Constant Field Values

SOQL_DATE_TIME_FORMAT_IN

public static final String SOQL_DATE_TIME_FORMAT_IN

See Also:

Constant Field Values

SOQL_DATE_TIME_FORMAT_OUT

public static final String SOQL_DATE_TIME_FORMAT_OUT

See Also:

Constant Field Values

SOQL_TIME_FORMAT_IN

public static final String SOQL_TIME_FORMAT_IN

See Also:

Constant Field Values

SOQL_TIME_FORMAT_OUT

public static final String SOQL_TIME_FORMAT_OUT

See Also:

Constant Field Values

Constructor Detail

SalesforceDataContext

public SalesforceDataContext(String endpoint,
                             String username,
                             String password,
                             String securityToken)

SalesforceDataContext

public SalesforceDataContext(String username,
                             String password,
                             String securityToken)

SalesforceDataContext

public SalesforceDataContext(String username,
                             String password)

SalesforceDataContext

public SalesforceDataContext(com.sforce.soap.partner.PartnerConnection connection)

Creates a SalesforceDataContext instance , configured with given salesforce connection.

Parameters:

connection - salesforce connection (cannot be null).

Method Detail

getConnection

public com.sforce.soap.partner.PartnerConnection getConnection()

Returns the Salesforce connection being used by this datacontext.

Returns:

the Salesforce connection

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

executeQuery

public DataSet executeQuery(Query query)

Description copied from interface: DataContext

Executes a query against the DataContext.

Specified by:

executeQuery in interface DataContext

Overrides:

executeQuery in class QueryPostprocessDataContext

Parameters:

query - the query object to execute

Returns:

the DataSet produced from executing the query

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.

rewriteFilterItem

protected static void rewriteFilterItem(StringBuilder sb,
                                        FilterItem filterItem)
                                 throws UnsupportedOperationException

Throws:

UnsupportedOperationException

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.

executeUpdate

public UpdateSummary executeUpdate(UpdateScript update)

Description copied from interface: UpdateableDataContext

Submits an UpdateScript for execution on the DataContext. Since implementations of the DataContext vary quite a lot, there is no golden rule as to how an update script will be executed. But the implementors should strive towards handling an UpdateScript as a single transactional change to the data store.

Specified by:

executeUpdate in interface UpdateableDataContext

Parameters:

update - the update script to execute

Returns:

a summary of the updates performed