/*****************************************************************
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
****************************************************************/
package org.apache.cayenne.dba.ingres;
import java.util.Iterator;
import org.apache.cayenne.access.trans.TrimmingQualifierTranslator;
import org.apache.cayenne.access.trans.QueryAssembler;
import org.apache.cayenne.access.trans.QualifierTranslator;
import org.apache.cayenne.CayenneRuntimeException;
import org.apache.cayenne.access.types.ExtendedTypeMap;
import org.apache.cayenne.dba.JdbcAdapter;
import org.apache.cayenne.dba.PkGenerator;
import org.apache.cayenne.dba.TypesMapping;
import org.apache.cayenne.map.DbAttribute;
import org.apache.cayenne.map.DbEntity;
import org.apache.cayenne.map.DerivedDbEntity;
/**
* DbAdapter implementation for <a href="http://opensource.ca.com/projects/ingres/">Ingres</a>.
* Sample <a target="_top"
* href="../../../../../../../developerguide/unit-tests.html">connection settings</a> to
* use with Ingres are shown below:
*
* <pre>
* ingres.cayenne.adapter = org.apache.cayenne.dba.ingres.IngresAdapter
* ingres.jdbc.username = test
* ingres.jdbc.password = secret
* ingres.jdbc.url = jdbc:ingres://serverhostname:II7/cayenne
* ingres.jdbc.driver = ca.ingres.jdbc.IngresDriver
* </pre>
*/
public class IngresAdapter extends JdbcAdapter {
public static final String TRIM_FUNCTION = "TRIM";
public QualifierTranslator getQualifierTranslator(QueryAssembler queryAssembler) {
return new TrimmingQualifierTranslator(
queryAssembler,
IngresAdapter.TRIM_FUNCTION);
}
/**
* Returns a SQL string that can be used to create database table corresponding to
* <code>ent</code> parameter.
*/
public String createTable(DbEntity ent) {
// later we may support view creation
// for derived DbEntities
if (ent instanceof DerivedDbEntity) {
throw new CayenneRuntimeException("Can't create table for derived DbEntity '"
+ ent.getName()
+ "'.");
}
StringBuffer buf = new StringBuffer();
buf.append("CREATE TABLE ").append(ent.getFullyQualifiedName()).append(" (");
// columns
Iterator it = ent.getAttributes().iterator();
boolean first = true;
while (it.hasNext()) {
if (first) {
first = false;
}
else {
buf.append(", ");
}
DbAttribute at = (DbAttribute) it.next();
// attribute may not be fully valid, do a simple check
if (at.getType() == TypesMapping.NOT_DEFINED) {
throw new CayenneRuntimeException("Undefined type for attribute '"
+ ent.getFullyQualifiedName()
+ "."
+ at.getName()
+ "'.");
}
String[] types = externalTypesForJdbcType(at.getType());
if (types == null || types.length == 0) {
throw new CayenneRuntimeException("Undefined type for attribute '"
+ ent.getFullyQualifiedName()
+ "."
+ at.getName()
+ "': "
+ at.getType());
}
String type = types[0];
buf.append(at.getName()).append(' ').append(type);
// append size and precision (if applicable)
if (TypesMapping.supportsLength(at.getType())) {
int len = at.getMaxLength();
int scale = TypesMapping.isDecimal(at.getType()) ? at.getScale() : -1;
// sanity check
if (scale > len) {
scale = -1;
}
if (len > 0) {
buf.append('(').append(len);
if (scale >= 0) {
buf.append(", ").append(scale);
}
buf.append(')');
}
}
// Ingres does not like "null" for non mandatory fields
if (at.isMandatory()) {
buf.append(" NOT NULL");
}
}
// primary key clause
Iterator pkit = ent.getPrimaryKey().iterator();
if (pkit.hasNext()) {
if (first)
first = false;
else
buf.append(", ");
buf.append("PRIMARY KEY (");
boolean firstPk = true;
while (pkit.hasNext()) {
if (firstPk)
firstPk = false;
else
buf.append(", ");
DbAttribute at = (DbAttribute) pkit.next();
buf.append(at.getName());
}
buf.append(')');
}
buf.append(')');
return buf.toString();
}
protected void configureExtendedTypes(ExtendedTypeMap map) {
super.configureExtendedTypes(map);
map.registerType(new IngresCharType());
}
/**
* @see JdbcAdapter#createPkGenerator()
*/
protected PkGenerator createPkGenerator() {
return new IngresPkGenerator();
}
}