org.apache.cayenne.dba.openbase

Class OpenBaseAdapter

java.lang.Object

org.apache.cayenne.dba.JdbcAdapter

org.apache.cayenne.dba.openbase.OpenBaseAdapter

All Implemented Interfaces:

DbAdapter

public class OpenBaseAdapter
extends JdbcAdapter

DbAdapter implementation for OpenBase. Sample connection settings to use with OpenBase are shown below:

 openbase.jdbc.username = test
 openbase.jdbc.password = secret
 openbase.jdbc.url = jdbc:openbase://serverhostname/cayenne
 openbase.jdbc.driver = com.openbase.jdbc.ObDriver
 

Since:

1.1

Field Summary

Fields inherited from class org.apache.cayenne.dba.JdbcAdapter

batchQueryBuilderFactory, caseInsensitiveCollations, ejbqlTranslatorFactory, extendedTypes, logger, quotingStrategy, resourceLocator, supportsBatchUpdates, supportsGeneratedKeys, supportsUniqueConstraints, typesHandler

Constructor Summary

Constructors

Constructor and Description
OpenBaseAdapter(RuntimeProperties runtimeProperties, List<ExtendedType> defaultExtendedTypes, List<ExtendedType> userExtendedTypes, List<ExtendedTypeFactory> extendedTypeFactories, ResourceLocator resourceLocator, ValueObjectTypeRegistry valueObjectTypeRegistry)

Method Summary

Modifier and Type	Method and Description
DbAttribute	buildAttribute(String name, String typeName, int type, int size, int scale, boolean allowNulls) Creates and returns a DbAttribute based on supplied parameters (usually obtained from database meta data).
protected void	configureExtendedTypes(ExtendedTypeMap map) Called from JdbcAdapter.initExtendedTypes(List, List, List, ValueObjectTypeRegistry) to load adapter-specific types into the ExtendedTypeMap right after the default types are loaded, but before the DI overrides are.
String	createFkConstraint(DbRelationship rel) Returns a SQL string that can be used to create a foreign key constraint for the relationship.
protected PkGenerator	createPkGenerator() Creates and returns a primary key generator.
String	createTable(DbEntity ent) Returns a SQL string that can be used to create database table corresponding to ent parameter.
String	getBatchTerminator() Returns word "go".
QualifierTranslator	getQualifierTranslator(QueryAssembler queryAssembler) Returns OpenBase-specific translator for queries.
SelectTranslator	getSelectTranslator(SelectQuery<?> query, EntityResolver entityResolver) Returns a SelectTranslator that works with the adapter target database.
String	tableTypeForView() Returns null, since views are not yet supported in openbase.

Methods inherited from class org.apache.cayenne.dba.JdbcAdapter

bindParameter, createEJBQLTranslatorFactory, createQuotingStrategy, createTableAppendColumn, createTableAppendPKClause, createUniqueConstraint, dropTableStatements, externalTypesForJdbcType, findResource, getAction, getBatchQueryBuilderFactory, getEjbqlTranslatorFactory, getExtendedTypes, getJdbcEventLogger, getPkGenerator, getQuotingStrategy, getQuotingStrategy, getType, initExtendedTypes, setBatchQueryBuilderFactory, setEjbqlTranslatorFactory, setPkGenerator, setSupportsBatchUpdates, setSupportsGeneratedKeys, setSupportsUniqueConstraints, sizeAndPrecision, supportsBatchUpdates, supportsCatalogsOnReverseEngineering, supportsGeneratedKeys, supportsUniqueConstraints, tableTypeForTable, typeSupportsLength, unwrap

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenBaseAdapter

public OpenBaseAdapter(RuntimeProperties runtimeProperties,
                       List<ExtendedType> defaultExtendedTypes,
                       List<ExtendedType> userExtendedTypes,
                       List<ExtendedTypeFactory> extendedTypeFactories,
                       ResourceLocator resourceLocator,
                       ValueObjectTypeRegistry valueObjectTypeRegistry)

Method Detail

getSelectTranslator

public SelectTranslator getSelectTranslator(SelectQuery<?> query,
                                            EntityResolver entityResolver)

Description copied from interface: DbAdapter

Returns a SelectTranslator that works with the adapter target database.

Specified by:

getSelectTranslator in interface DbAdapter

Overrides:

getSelectTranslator in class JdbcAdapter

Since:

4.0

configureExtendedTypes

protected void configureExtendedTypes(ExtendedTypeMap map)

Description copied from class: JdbcAdapter

Called from JdbcAdapter.initExtendedTypes(List, List, List, ValueObjectTypeRegistry) to load adapter-specific types into the ExtendedTypeMap right after the default types are loaded, but before the DI overrides are. This method has specific implementations in JdbcAdapter subclasses.

Overrides:

configureExtendedTypes in class JdbcAdapter

buildAttribute

public DbAttribute buildAttribute(String name,
                                  String typeName,
                                  int type,
                                  int size,
                                  int scale,
                                  boolean allowNulls)

Description copied from interface: DbAdapter

Creates and returns a DbAttribute based on supplied parameters (usually obtained from database meta data).

Specified by:

buildAttribute in interface DbAdapter

Overrides:

buildAttribute in class JdbcAdapter

Parameters:

name - database column name

typeName - database specific type name, may be used as a hint to determine the right JDBC type.

type - JDBC column type

size - database column size (ignored if less than zero)

scale - database column scale, i.e. the number of decimal digits (ignored if less than zero)

allowNulls - database column nullable parameter

getBatchTerminator

public String getBatchTerminator()

Returns word "go".

Specified by:

getBatchTerminator in interface DbAdapter

Overrides:

getBatchTerminator in class JdbcAdapter

tableTypeForView

public String tableTypeForView()

Returns null, since views are not yet supported in openbase.

Specified by:

tableTypeForView in interface DbAdapter

Overrides:

tableTypeForView in class JdbcAdapter

getQualifierTranslator

public QualifierTranslator getQualifierTranslator(QueryAssembler queryAssembler)

Returns OpenBase-specific translator for queries.

Specified by:

getQualifierTranslator in interface DbAdapter

Overrides:

getQualifierTranslator in class JdbcAdapter

createPkGenerator

protected PkGenerator createPkGenerator()

Creates and returns a primary key generator. Overrides superclass implementation to return an instance of OpenBasePkGenerator that uses built-in multi-server primary key generation.

Overrides:

createPkGenerator in class JdbcAdapter

createTable

public String createTable(DbEntity ent)

Returns a SQL string that can be used to create database table corresponding to ent parameter.

Specified by:

createTable in interface DbAdapter

Overrides:

createTable in class JdbcAdapter

createFkConstraint

public String createFkConstraint(DbRelationship rel)

Returns a SQL string that can be used to create a foreign key constraint for the relationship.

Specified by:

createFkConstraint in interface DbAdapter

Overrides:

createFkConstraint in class JdbcAdapter