/*
* 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.openjpa.jdbc.identifier;
import org.apache.openjpa.jdbc.schema.Column;
import org.apache.openjpa.jdbc.schema.NameSet;
import org.apache.openjpa.jdbc.schema.Schema;
import org.apache.openjpa.jdbc.schema.Table;
import org.apache.openjpa.lib.identifier.IdentifierUtil;
import static org.apache.openjpa.jdbc.identifier.DBIdentifier.DBIdentifierType;
/**
* An interface for DB identifier utility-style operations. This interface
* extends the basic operations provided by IdentifierUtil with additional
* operations those specific to DBIdentifiers and identifier conversion.
*/
public interface DBIdentifierUtil extends IdentifierUtil {
// Legacy values for naming operations
public static final int ANY = 0;
public static final int TABLE = 1;
public static final int SEQUENCE = 2;
public static final int COLUMN = 3;
/**
* Shortens the given name to the given maximum length, then checks that
* it is not a reserved word. If it is reserved, appends a "0". If
* the name conflicts with an existing schema component and uniqueness
* checking is enabled, the last character is replace with '0', then
* '1', etc.
* Note that the given max len may be 0 if the database metadata is
* incomplete.
*
* Note: If the name is delimited, make sure the ending delimiter is
* not stripped off.
*/
public DBIdentifier makeIdentifierValid(DBIdentifier sname, NameSet set, int maxLen,
boolean checkForUniqueness);
/**
* Shortens the given name to the given maximum length, then checks that
* it is not a reserved word. If it is reserved, appends a "0". If
* the name conflicts with an existing schema component and uniqueness
* checking is enabled, the last character is replace with '0', then
* '1', etc.
* Note that the given max len may be 0 if the database metadata is
* incomplete.
*
* Note: If the name is delimited, make sure the ending delimiter is
* not stripped off.
*/
public DBIdentifier makeNameValid(String name, NameSet set, int maxLen,
int nameType, boolean checkForUniqueness);
/**
* Returns a valid column name/identifier, based upon the configuration and
* provided parameters.
* @param name
* @param table
* @param maxLen
* @param checkForUniqueness
*/
public DBIdentifier getValidColumnIdentifier(DBIdentifier name, Table table, int maxLen,
boolean checkForUniqueness);
/**
* Returns a valid index identifier, based upon the configuration and
* provided parameters.
* @param name
* @param table
* @param maxLen
* @param checkForUniqueness
*/
public DBIdentifier getValidIndexIdentifier(DBIdentifier name, Table table, int maxLen);
/**
* Returns a valid index identifier, based upon the configuration and
* provided parameters.
* @param name
* @param table
* @param maxLen
* @param checkForUniqueness
*/
public DBIdentifier getValidSequenceIdentifier(DBIdentifier name, Schema schema, int maxLen);
/**
* Returns a valid table identifier, based upon the configuration and provided
* parameters.
* @param name
* @param schema
* @param maxLen
*/
public DBIdentifier getValidTableIdentifier(DBIdentifier name, Schema schema, int maxLen);
/**
* Returns a valid unique constraint identifier, based upon the configuration and
* provided parameters.
* @param name
* @param table
* @param maxLen
*/
public DBIdentifier getValidUniqueIdentifier(DBIdentifier name, Table table, int maxLen);
/**
* Returns a valid foreign key identifier, based upon the configuration and
* provided parameters.
* @param name
* @param table
* @param toTable
* @param maxLen
*/
public DBIdentifier getValidForeignKeyIdentifier(DBIdentifier name, Table table, Table toTable, int maxLen);
/**
* Converts the specified identifier to a format required by the database.
* @param name
*/
public String toDBName(DBIdentifier name);
/**
* Converts the specified identifier to a format required by the database,
* optionally delimiting the name.
* @param name
* @param delimit
*/
public String toDBName(DBIdentifier name, boolean delimit);
/**
* Converts the specified string to a format required by the database.
* @param name
*/
public String toDBName(String name);
/**
* Converts the specified string to a format required by the database,
* optionally delimiting the name.
* @param name
*/
public String toDBName(String name, boolean delimit);
/**
* Converts the name returned by the database to an identifier of the
* specified type.
* @param name
*/
public DBIdentifier fromDBName(String name, DBIdentifierType id);
/**
* Appends multiple columns names together into comma delimited string.
* @param columns
*/
public String appendColumns(Column[] columns);
/**
* Converts the name of the specified delimiter to the appropriate
* case as defined by the configuration.
* @param columns
*/
public DBIdentifier convertSchemaCase(DBIdentifier schema);
/**
* Appends multiple names together using the appropriate name delimiter.
* @param resultId
* @param names
*/
public DBIdentifier append(DBIdentifierType resultId, DBIdentifier...names);
/**
* Returns a generated key sequence identifier for the column.
* @param col
* @param maxLen
*/
public DBIdentifier getGeneratedKeySequenceName(Column col, int maxLen);
/**
* Converts a provided alias to a format specified in the configuration.
* @param alias
*/
public String convertAlias(String alias);
}