org.datanucleus.store.schema.naming.NamingFactory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of datanucleus-core Show documentation
Show all versions of datanucleus-core Show documentation
DataNucleus Core provides the primary components of a heterogenous Java persistence solution.
It supports persistence API's being layered on top of the core functionality.
/**********************************************************************
Copyright (c) 2011 Andy Jefferson and others. All rights reserved.
Licensed 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.
Contributors:
...
**********************************************************************/
package org.datanucleus.store.schema.naming;
import java.util.List;
import java.util.Set;
import org.datanucleus.metadata.AbstractClassMetaData;
import org.datanucleus.metadata.ConstraintMetaData;
import org.datanucleus.metadata.AbstractMemberMetaData;
import org.datanucleus.metadata.SequenceMetaData;
/**
* Representation of a naming factory for schema components (tables, columns, etc).
*/
public interface NamingFactory
{
/**
* Method to set the provided list of keywords as names that identifiers have to surround by quotes to use.
* @param keywords The keywords
* @return This naming factory
*/
NamingFactory setReservedKeywords(Set keywords);
/**
* Method to set the maximum length of the name of the specified schema component.
* @param cmpt The component
* @param max The maximum it accepts
* @return This naming factory
*/
NamingFactory setMaximumLength(SchemaComponent cmpt, int max);
/**
* Method to set the quote string to use (when the identifiers need to be quoted).
* See setIdentifierCase
.
* @param quote The quote string
* @return This naming factory
*/
NamingFactory setQuoteString(String quote);
/**
* Method to set the word separator of the names.
* @param sep Separator
* @return This naming factory
*/
NamingFactory setWordSeparator(String sep);
/**
* Method to set the required case of the names.
* @param nameCase Required case
* @return This naming factory
*/
NamingFactory setNamingCase(NamingCase nameCase);
/**
* Method to return the name of the table for the specified class.
* @param cmd Metadata for the class
* @return Name of the table
*/
String getTableName(AbstractClassMetaData cmd);
/**
* Method to return the name of the (join) table for the specified field.
* @param mmd Metadata for the field/property needing a join table
* @return Name of the table
*/
String getTableName(AbstractMemberMetaData mmd);
/**
* Method to return the name of the column for the specified class (version, datastore-id, discriminator etc).
* @param cmd Metadata for the class
* @param type Column type
* @return Name of the column
*/
String getColumnName(AbstractClassMetaData cmd, ColumnType type);
/**
* Method to return the name of the column for the specified field.
* If you have multiple columns for a field then call the other getColumnName
method.
* @param mmd Metadata for the field
* @param type Type of column
* @return The column name
*/
String getColumnName(AbstractMemberMetaData mmd, ColumnType type);
/**
* Method to return the name of the column for the position of the specified field.
* Normally the position will be 0 since most fields map to a single column, but where you have a FK
* to an object with composite id, or where the Java type maps to multiple columns then the position is used.
* @param mmd Metadata for the field
* @param type Type of column
* @param position Position of the column
* @return The column name
*/
String getColumnName(AbstractMemberMetaData mmd, ColumnType type, int position);
/**
* Method to return the name of the column for the position of the specified EMBEDDED field, within the specified owner field.
* For example, say we have a class Type1 with field "field1" that is marked as embedded, and this is of type Type2.
* In turn Type2 has a field "field2" that is also embedded, of type Type3. Type3 has a field "name". So to get the column name for
* Type3.name in the table for Type1 we call "getColumnName({mmdForField1InType1, mmdForField2InType2, mmdForNameInType3}, 0)".
* @param mmds MetaData for the field(s) with the column. The first value is the original field that is embedded, followed by fields of the embedded object(s).
* @param position The position of the column (where this field has multiple columns)
* @return The column name
*/
String getColumnName(List mmds, int position);
/**
* Method to return the name of a constraint specified at class level.
* @param cmd Metadata for the class
* @param cnstrmd The constraint metadata
* @param position Number of the constraint at class level (first is 0)
* @return Name of the constraint
*/
String getConstraintName(AbstractClassMetaData cmd, ConstraintMetaData cnstrmd, int position);
/**
* Method to return the name of a constraint specified at member level.
* @param className Name of the class that this constraint is for.
* @param mmd Metadata for the member
* @param cnstrmd The constraint metadata
* @return Name of the constraint
*/
String getConstraintName(String className, AbstractMemberMetaData mmd, ConstraintMetaData cnstrmd);
/**
* Method to return the name of the constraint for the specified class (version, datastore-id, discriminator etc).
* @param cmd Metadata for the class
* @param cnstrmd The constraint metadata
* @param type Column type
* @return Name of the constraint
*/
String getConstraintName(AbstractClassMetaData cmd, ConstraintMetaData cnstrmd, ColumnType type);
/**
* Method to return the name of sequence.
* @param seqmd Metadata for the sequence
* @return Name of the sequence
*/
String getSequenceName(SequenceMetaData seqmd);
}