org.apache.metamodel

Class DataContextFactory

java.lang.Object

org.apache.metamodel.DataContextFactory

public class DataContextFactory
extends Object

A factory for DataContext objects. This class substantially easens the task of creating and initializing DataContext objects and/or their strategies for reading datastores.

See Also:

DataContext

Field Summary

Fields

Modifier and Type	Field and Description
static char	DEFAULT_CSV_QUOTE_CHAR
static char	DEFAULT_CSV_SEPARATOR_CHAR

Method Summary

Methods

Modifier and Type	Method and Description
static DataContext	createCassandraDataContext(com.datastax.driver.core.Cluster cluster, String keySpaceName) Creates a new Cassandra datacontext.
static DataContext	createCompositeDataContext(Collection<DataContext> delegates) Creates a composite DataContext based on a set of delegate DataContexts.
static DataContext	createCompositeDataContext(DataContext... delegates) Creates a composite DataContext based on a set of delegate DataContexts.
static UpdateableDataContext	createCouchDbDataContext(String hostname, Integer port, String username, String password) Creates a new CouchDB datacontext.
static UpdateableDataContext	createCouchDbDataContext(String hostname, Integer port, String username, String password, SimpleTableDef[] tableDefs) Creates a new CouchDB datacontext.
static UpdateableDataContext	createCsvDataContext(File file) Creates a DataContext based on a CSV file
static UpdateableDataContext	createCsvDataContext(File file, char separatorChar, char quoteChar) Creates a DataContext based on a CSV file
static UpdateableDataContext	createCsvDataContext(File file, char separatorChar, char quoteChar, String encoding) Creates a DataContext based on a CSV file
static UpdateableDataContext	createCsvDataContext(File file, CsvConfiguration configuration) Creates a DataContext based on a CSV file
static DataContext	createCsvDataContext(InputStream inputStream, char separatorChar, char quoteChar) Creates a DataContext based on CSV-content through an input stream
static DataContext	createCsvDataContext(InputStream inputStream, char separatorChar, char quoteChar, String encoding) Creates a DataContext based on CSV-content through an input stream
static DataContext	createCsvDataContext(InputStream inputStream, CsvConfiguration configuration) Creates a DataContext based on CSV-content through an input stream
static DataContext	createElasticSearchDataContext(org.elasticsearch.client.Client client, String indexName) Creates a new ElasticSearch datacontext.
static UpdateableDataContext	createExcelDataContext(File file) Creates a DataContext based on an Excel spreadsheet file
static UpdateableDataContext	createExcelDataContext(File file, ExcelConfiguration configuration) Creates a DataContet based on an Excel spreadsheet file
static DataContext	createFixedWidthDataContext(File file, FixedWidthConfiguration configuration) Creates a DataContext based on a fixed width file.
static DataContext	createFixedWidthDataContext(File file, String fileEncoding, int fixedValueWidth) Creates a DataContext based on a fixed width file.
static DataContext	createFixedWidthDataContext(File file, String fileEncoding, int fixedValueWidth, int headerLineNumber) Creates a DataContext based on a fixed width file.
static UpdateableDataContext	createJdbcDataContext(Connection connection) Creates a DataContext based on a JDBC connection
static UpdateableDataContext	createJdbcDataContext(Connection connection, String catalogName) Creates a DataContext based on a JDBC connection
static UpdateableDataContext	createJdbcDataContext(Connection connection, String catalogName, TableType[] tableTypes) Creates a DataContext based on a JDBC connection
static UpdateableDataContext	createJdbcDataContext(Connection connection, TableType... tableTypes) Creates a DataContext based on a JDBC connection
static UpdateableDataContext	createJdbcDataContext(DataSource ds) Creates a DataContext based on a JDBC datasource
static UpdateableDataContext	createJdbcDataContext(DataSource ds, String catalogName) Creates a DataContext based on a JDBC datasource
static UpdateableDataContext	createJdbcDataContext(DataSource ds, String catalogName, TableType[] tableTypes) Creates a DataContext based on a JDBC datasource
static UpdateableDataContext	createJdbcDataContext(DataSource ds, TableType... tableTypes) Creates a DataContext based on a JDBC datasource
static DataContext	createJsonDataContext(File file) Creates a DataContext based on a JSON file
static UpdateableDataContext	createMongoDbDataContext(String hostname, Integer port, String databaseName, String username, char[] password) Creates a new MongoDB datacontext.
static UpdateableDataContext	createMongoDbDataContext(String hostname, Integer port, String databaseName, String username, char[] password, SimpleTableDef[] tableDefs) Creates a new MongoDB datacontext.
static DataContext	createOpenOfficeDataContext(File file) Creates a DataContext based on an OpenOffice.org database file.
static DataContext	createSalesforceDataContext(String username, String password, String securityToken) Creates a DataContext that connects to a Salesforce.com instance.
static DataContext	createSugarCrmDataContext(String baseUrl, String username, String password, String applicationName) Create a DataContext that connects to a SugarCRM system.
static DataContext	createXmlDataContext(File file, boolean autoFlattenTables) Creates a DataContext based on XML-content from a File.
static DataContext	createXmlDataContext(InputSource inputSource, String schemaName, boolean autoFlattenTables) Creates a DataContext based on XML-content from an input source.
static DataContext	createXmlDataContext(URL url, boolean autoFlattenTables) Creates a DataContext based on XML-content from a URL.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CSV_SEPARATOR_CHAR

public static final char DEFAULT_CSV_SEPARATOR_CHAR

See Also:

Constant Field Values

DEFAULT_CSV_QUOTE_CHAR

public static final char DEFAULT_CSV_QUOTE_CHAR

See Also:

Constant Field Values

Method Detail

createCompositeDataContext

public static DataContext createCompositeDataContext(DataContext... delegates)

Creates a composite DataContext based on a set of delegate DataContexts. Composite DataContexts enables cross-DataContext querying and unified schema exploration

Parameters:

delegates - an array/var-args of delegate DataContexts

Returns:

a DataContext that matches the request

createCompositeDataContext

public static DataContext createCompositeDataContext(Collection<DataContext> delegates)

Creates a composite DataContext based on a set of delegate DataContexts. Composite DataContexts enables cross-DataContext querying and unified schema exploration

Parameters:

delegates - a collection of delegate DataContexts

Returns:

a DataContext that matches the request

createSalesforceDataContext

public static DataContext createSalesforceDataContext(String username,
                                      String password,
                                      String securityToken)

Creates a DataContext that connects to a Salesforce.com instance.

Parameters:

username - the Salesforce username

password - the Salesforce password

securityToken - the Salesforce security token

Returns:

a DataContext object that matches the request

createSugarCrmDataContext

public static DataContext createSugarCrmDataContext(String baseUrl,
                                    String username,
                                    String password,
                                    String applicationName)

Create a DataContext that connects to a SugarCRM system.

Parameters:

baseUrl - the base URL of the system, e.g. http://localhost/sugarcrm

username - the SugarCRM username

password - the SugarCRM password

applicationName - the name of the application you are connecting with

Returns:

a DataContext object that matches the request

createCsvDataContext

public static UpdateableDataContext createCsvDataContext(File file)

Creates a DataContext based on a CSV file

Parameters:

file - a CSV file

Returns:

a DataContext object that matches the request

createJsonDataContext

public static DataContext createJsonDataContext(File file)

Creates a DataContext based on a JSON file

Parameters:

file -

Returns:

createCsvDataContext

public static UpdateableDataContext createCsvDataContext(File file,
                                         char separatorChar,
                                         char quoteChar)

Creates a DataContext based on a CSV file

Parameters:

file - a CSV file

separatorChar - the char to use for separating values

quoteChar - the char used for quoting values (typically if they include the separator char)

Returns:

a DataContext object that matches the request

createCsvDataContext

public static UpdateableDataContext createCsvDataContext(File file,
                                         char separatorChar,
                                         char quoteChar,
                                         String encoding)

Creates a DataContext based on a CSV file

Parameters:

file - a CSV file

separatorChar - the char to use for separating values

quoteChar - the char used for quoting values (typically if they include the separator char)

encoding - the character encoding of the file

Returns:

a DataContext object that matches the request

createCsvDataContext

public static UpdateableDataContext createCsvDataContext(File file,
                                         CsvConfiguration configuration)

Creates a DataContext based on a CSV file

Parameters:

file - a CSV file

configuration - the CSV configuration to use

Returns:

a DataContext object that matches the request

createCsvDataContext

public static DataContext createCsvDataContext(InputStream inputStream,
                               char separatorChar,
                               char quoteChar)

Creates a DataContext based on CSV-content through an input stream

Parameters:

inputStream - the input stream to read from

separatorChar - the char to use for separating values

quoteChar - the char used for quoting values (typically if they include the separator char)

Returns:

a DataContext object that matches the request

createCsvDataContext

public static DataContext createCsvDataContext(InputStream inputStream,
                               char separatorChar,
                               char quoteChar,
                               String encoding)

Creates a DataContext based on CSV-content through an input stream

Parameters:

inputStream - the input stream to read from

separatorChar - the char to use for separating values

quoteChar - the char used for quoting values (typically if they include the separator char)

Returns:

a DataContext object that matches the request

createCsvDataContext

public static DataContext createCsvDataContext(InputStream inputStream,
                               CsvConfiguration configuration)

Creates a DataContext based on CSV-content through an input stream

Parameters:

inputStream - the input stream to read from

configuration - the CSV configuration to use

Returns:

a DataContext object that matches the request

createFixedWidthDataContext

public static DataContext createFixedWidthDataContext(File file,
                                      String fileEncoding,
                                      int fixedValueWidth)

Creates a DataContext based on a fixed width file.

Parameters:

file - the file to read from.

fileEncoding - the character encoding of the file.

fixedValueWidth - the (fixed) width of values in the file.

Returns:

a DataContext object that matches the request

createFixedWidthDataContext

public static DataContext createFixedWidthDataContext(File file,
                                      FixedWidthConfiguration configuration)

Creates a DataContext based on a fixed width file.

Parameters:

file - the file to read from.

configuration - the fixed width configuration to use

Returns:

a DataContext object that matches the request

createFixedWidthDataContext

public static DataContext createFixedWidthDataContext(File file,
                                      String fileEncoding,
                                      int fixedValueWidth,
                                      int headerLineNumber)

Creates a DataContext based on a fixed width file.

Parameters:

file - the file to read from.

fileEncoding - the character encoding of the file.

fixedValueWidth - the (fixed) width of values in the file.

headerLineNumber - the line number of the column headers.

Returns:

a DataContext object that matches the request

createExcelDataContext

public static UpdateableDataContext createExcelDataContext(File file,
                                           ExcelConfiguration configuration)

Creates a DataContet based on an Excel spreadsheet file

Parameters:

file - an excel spreadsheet file

configuration - the configuration with metadata for reading the spreadsheet

Returns:

a DataContext object that matches the request

createExcelDataContext

public static UpdateableDataContext createExcelDataContext(File file)

Creates a DataContext based on an Excel spreadsheet file

Parameters:

file - an Excel spreadsheet file

Returns:

a DataContext object that matches the request

createXmlDataContext

public static DataContext createXmlDataContext(InputSource inputSource,
                               String schemaName,
                               boolean autoFlattenTables)

Creates a DataContext based on XML-content from an input source. Tables are created by examining the data in the XML file, NOT by reading XML Schemas (xsd/dtd's). This enables compliancy with ALL xml formats but also raises a risk that two XML files with the same format wont nescesarily yield the same table model if some optional attributes or tags are omitted in one of the files.

Parameters:

inputSource - an input source feeding XML content

schemaName - the name to be used for the main schema

autoFlattenTables - a boolean indicating if MetaModel should flatten very simple table structures (where tables only contain a single data-carrying column) for greater usability of the generated table-based model

Returns:

a DataContext object that matches the request

createXmlDataContext

public static DataContext createXmlDataContext(File file,
                               boolean autoFlattenTables)

Creates a DataContext based on XML-content from a File. Tables are created by examining the data in the XML file, NOT by reading XML Schemas (xsd/dtd's). This enables compliancy with ALL xml formats but also raises a risk that two XML files with the same format wont nescesarily yield the same table model if some optional attributes or tags are omitted in one of the files.

Parameters:

file - the File to use for feeding XML content

autoFlattenTables - a boolean indicating if MetaModel should flatten very simple table structures (where tables only contain a single data-carrying column) for greater usability of the generated table-based model

Returns:

a DataContext object that matches the request

createXmlDataContext

public static DataContext createXmlDataContext(URL url,
                               boolean autoFlattenTables)

Creates a DataContext based on XML-content from a URL. Tables are created by examining the data in the XML file, NOT by reading XML Schemas (xsd/dtd's). This enables compliancy with ALL xml formats but also raises a risk that two XML files with the same format wont nescesarily yield the same table model if some optional attributes or tags are omitted in one of the files.

Parameters:

url - the URL to use for feeding XML content

autoFlattenTables - a boolean indicating if MetaModel should flatten very simple table structures (where tables only contain a single data-carrying column) for greater usability of the generated table-based model

Returns:

a DataContext object that matches the request

createOpenOfficeDataContext

public static DataContext createOpenOfficeDataContext(File file)

Creates a DataContext based on an OpenOffice.org database file.

Parameters:

file - an OpenOffice.org database file

Returns:

a DataContext object that matches the request

createJdbcDataContext

public static UpdateableDataContext createJdbcDataContext(Connection connection)

Creates a DataContext based on a JDBC connection

Parameters:

connection - a JDBC connection

Returns:

a DataContext object that matches the request

createJdbcDataContext

public static UpdateableDataContext createJdbcDataContext(DataSource ds)

Creates a DataContext based on a JDBC datasource

Parameters:

ds - a JDBC datasource

Returns:

a DataContext object that matches the request

createJdbcDataContext

public static UpdateableDataContext createJdbcDataContext(Connection connection,
                                          String catalogName)

Creates a DataContext based on a JDBC connection

Parameters:

connection - a JDBC connection

catalogName - a catalog name to use

Returns:

a DataContext object that matches the request

createJdbcDataContext

public static UpdateableDataContext createJdbcDataContext(Connection connection,
                                          TableType... tableTypes)

Creates a DataContext based on a JDBC connection

Parameters:

connection - a JDBC connection

tableTypes - the types of tables to include in the generated schemas

Returns:

a DataContext object that matches the request

createJdbcDataContext

public static UpdateableDataContext createJdbcDataContext(Connection connection,
                                          String catalogName,
                                          TableType[] tableTypes)

Creates a DataContext based on a JDBC connection

Parameters:

connection - a JDBC connection

catalogName - a catalog name to use

tableTypes - the types of tables to include in the generated schemas

Returns:

a DataContext object that matches the request

createJdbcDataContext

public static UpdateableDataContext createJdbcDataContext(DataSource ds,
                                          TableType... tableTypes)

Creates a DataContext based on a JDBC datasource

Parameters:

ds - a JDBC datasource

tableTypes - the types of tables to include in the generated schemas

Returns:

a DataContext object that matches the request

createJdbcDataContext

public static UpdateableDataContext createJdbcDataContext(DataSource ds,
                                          String catalogName,
                                          TableType[] tableTypes)

Creates a DataContext based on a JDBC datasource

Parameters:

ds - a JDBC datasource

catalogName - a catalog name to use

tableTypes - the types of tables to include in the generated schemas

Returns:

a DataContext object that matches the request

createJdbcDataContext

public static UpdateableDataContext createJdbcDataContext(DataSource ds,
                                          String catalogName)

Creates a DataContext based on a JDBC datasource

Parameters:

ds - a JDBC datasource

catalogName - a catalog name to use

Returns:

a DataContext object that matches the request

createMongoDbDataContext

public static UpdateableDataContext createMongoDbDataContext(String hostname,
                                             Integer port,
                                             String databaseName,
                                             String username,
                                             char[] password,
                                             SimpleTableDef[] tableDefs)

Creates a new MongoDB datacontext.

Parameters:

hostname - The hostname of the MongoDB instance

port - the port of the MongoDB instance, or null if the default port should be used.

databaseName - the name of the database

username - the username, or null if unauthenticated access should be used

password - the password, or null if unathenticated access should be used

tableDefs - an array of table definitions, or null if table definitions should be autodetected.

Returns:

a DataContext object that matches the request

createMongoDbDataContext

public static UpdateableDataContext createMongoDbDataContext(String hostname,
                                             Integer port,
                                             String databaseName,
                                             String username,
                                             char[] password)

Creates a new MongoDB datacontext.

Parameters:

hostname - The hostname of the MongoDB instance

port - the port of the MongoDB instance, or null if the default port should be used.

databaseName - the name of the database

username - the username, or null if unauthenticated access should be used

password - the password, or null if unathenticated access should be used

Returns:

a DataContext object that matches the request

createCouchDbDataContext

public static UpdateableDataContext createCouchDbDataContext(String hostname,
                                             Integer port,
                                             String username,
                                             String password)

Creates a new CouchDB datacontext.

Parameters:

hostname - The hostname of the CouchDB instance

port - the port of the CouchDB instance, or null if the default port should be used.

username - the username, or null if unauthenticated access should be used

password - the password, or null if unathenticated access should be used

Returns:

a DataContext object that matches the request

createCouchDbDataContext

public static UpdateableDataContext createCouchDbDataContext(String hostname,
                                             Integer port,
                                             String username,
                                             String password,
                                             SimpleTableDef[] tableDefs)

Creates a new CouchDB datacontext.

Parameters:

hostname - The hostname of the CouchDB instance

port - the port of the CouchDB instance, or null if the default port should be used.

username - the username, or null if unauthenticated access should be used

password - the password, or null if unathenticated access should be used

tableDefs - an array of table definitions, or null if table definitions should be autodetected.

Returns:

a DataContext object that matches the request

createElasticSearchDataContext

public static DataContext createElasticSearchDataContext(org.elasticsearch.client.Client client,
                                         String indexName)

Creates a new ElasticSearch datacontext.

Parameters:

client - The ElasticSearch client

indexName - The ElasticSearch index name

Returns:

a DataContext object that matches the request

createCassandraDataContext

public static DataContext createCassandraDataContext(com.datastax.driver.core.Cluster cluster,
                                     String keySpaceName)

Creates a new Cassandra datacontext.

Parameters:

cluster - The Cassandra client

keySpaceName - The Cassandra key space name

Returns:

a DataContext object that matches the request