Package 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:

org.apache.metamodel.convert.HasReadTypeConverters, org.apache.metamodel.DataContext, org.apache.metamodel.UpdateableDataContext

public class SalesforceDataContext
extends org.apache.metamodel.QueryPostprocessDataContext
implements org.apache.metamodel.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	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	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	Description
protected Number	executeCountQuery(org.apache.metamodel.schema.Table table, List<org.apache.metamodel.query.FilterItem> whereItems, boolean functionApproximationAllowed)
org.apache.metamodel.data.DataSet	executeQuery(org.apache.metamodel.query.Query query)
org.apache.metamodel.UpdateSummary	executeUpdate(org.apache.metamodel.UpdateScript update)
com.sforce.soap.partner.PartnerConnection	getConnection()	Returns the Salesforce connection being used by this datacontext.
protected org.apache.metamodel.schema.Schema	getMainSchema()
protected String	getMainSchemaName()
protected org.apache.metamodel.data.DataSet	materializeMainSchemaTable(org.apache.metamodel.schema.Table table, List<org.apache.metamodel.schema.Column> columns, int maxRows)
protected static void	rewriteFilterItem(StringBuilder sb, org.apache.metamodel.query.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 org.apache.metamodel.schema.Schema getMainSchema()
                                                    throws org.apache.metamodel.MetaModelException

Specified by:

getMainSchema in class org.apache.metamodel.QueryPostprocessDataContext

Throws:

org.apache.metamodel.MetaModelException

getMainSchemaName

protected String getMainSchemaName()
                            throws org.apache.metamodel.MetaModelException

Specified by:

getMainSchemaName in class org.apache.metamodel.QueryPostprocessDataContext

Throws:

org.apache.metamodel.MetaModelException

executeQuery

public org.apache.metamodel.data.DataSet executeQuery(org.apache.metamodel.query.Query query)

Specified by:

executeQuery in interface org.apache.metamodel.DataContext

Overrides:

executeQuery in class org.apache.metamodel.QueryPostprocessDataContext

executeCountQuery

protected Number executeCountQuery(org.apache.metamodel.schema.Table table,
                                   List<org.apache.metamodel.query.FilterItem> whereItems,
                                   boolean functionApproximationAllowed)

Overrides:

executeCountQuery in class org.apache.metamodel.QueryPostprocessDataContext

rewriteFilterItem

protected static void rewriteFilterItem(StringBuilder sb,
                                        org.apache.metamodel.query.FilterItem filterItem)
                                 throws UnsupportedOperationException

Throws:

UnsupportedOperationException

materializeMainSchemaTable

protected org.apache.metamodel.data.DataSet materializeMainSchemaTable(org.apache.metamodel.schema.Table table,
                                                                       List<org.apache.metamodel.schema.Column> columns,
                                                                       int maxRows)

Specified by:

materializeMainSchemaTable in class org.apache.metamodel.QueryPostprocessDataContext

executeUpdate

public org.apache.metamodel.UpdateSummary executeUpdate(org.apache.metamodel.UpdateScript update)

Specified by:

executeUpdate in interface org.apache.metamodel.UpdateableDataContext