Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 2.2.1 / apidocs / org / apache / openjpa / jdbc / identifier / DBIdentifierUtil.html
blob: 39ebb892b5aeb8cef6a19203a7baa56fd1283094 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_35) on Wed Oct 10 18:40:39 CDT 2012 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
DBIdentifierUtil (OpenJPA Parent POM 2.2.1 API)
</TITLE>
<META NAME="date" CONTENT="2012-10-10">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DBIdentifierUtil (OpenJPA Parent POM 2.2.1 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DBIdentifierUtil.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierRule.html" title="class in org.apache.openjpa.jdbc.identifier"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtilImpl.html" title="class in org.apache.openjpa.jdbc.identifier"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="DBIdentifierUtil.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.openjpa.jdbc.identifier</FONT>
<BR>
Interface DBIdentifierUtil</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html" title="interface in org.apache.openjpa.lib.identifier">IdentifierUtil</A></DD>
</DL>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtilImpl.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifierUtilImpl</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>DBIdentifierUtil</B><DT>extends <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html" title="interface in org.apache.openjpa.lib.identifier">IdentifierUtil</A></DL>
</PRE>
<P>
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.
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html#ANY">ANY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html#COLUMN">COLUMN</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html#SEQUENCE">SEQUENCE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html#TABLE">TABLE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_org.apache.openjpa.lib.identifier.IdentifierUtil"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from interface org.apache.openjpa.lib.identifier.<A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html" title="interface in org.apache.openjpa.lib.identifier">IdentifierUtil</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#BAR">BAR</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#CASE_LOWER">CASE_LOWER</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#CASE_PRESERVE">CASE_PRESERVE</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#CASE_UPPER">CASE_UPPER</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#DOLLAR_CHAR">DOLLAR_CHAR</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#DOT">DOT</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#DOUBLE_QUOTE">DOUBLE_QUOTE</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#EMPTY">EMPTY</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#PERCENT">PERCENT</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#SPACE">SPACE</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#UNDERSCORE">UNDERSCORE</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#UNDERSCORE_CHAR">UNDERSCORE_CHAR</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html#append(org.apache.openjpa.jdbc.identifier.DBIdentifier.DBIdentifierType, org.apache.openjpa.jdbc.identifier.DBIdentifier...)">append</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.DBIdentifierType.html" title="enum in org.apache.openjpa.jdbc.identifier">DBIdentifier.DBIdentifierType</A>&nbsp;resultId,
<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A>...&nbsp;names)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends multiple names together using the appropriate name delimiter.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html#appendColumns(org.apache.openjpa.jdbc.schema.Column[])">appendColumns</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[]&nbsp;columns)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends multiple columns names together into comma delimited string.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html#convertAlias(java.lang.String)">convertAlias</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;alias)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts a provided alias to a format specified in the configuration.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html#convertSchemaCase(org.apache.openjpa.jdbc.identifier.DBIdentifier)">convertSchemaCase</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A>&nbsp;schema)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts the name of the specified delimiter to the appropriate
case as defined by the configuration.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html#fromDBName(java.lang.String, org.apache.openjpa.jdbc.identifier.DBIdentifier.DBIdentifierType)">fromDBName</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name,
<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.DBIdentifierType.html" title="enum in org.apache.openjpa.jdbc.identifier">DBIdentifier.DBIdentifierType</A>&nbsp;id)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts the name returned by the database to an identifier of the
specified type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html#getGeneratedKeySequenceName(org.apache.openjpa.jdbc.schema.Column, int)">getGeneratedKeySequenceName</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>&nbsp;col,
int&nbsp;maxLen)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a generated key sequence identifier for the column.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html#getValidColumnIdentifier(org.apache.openjpa.jdbc.identifier.DBIdentifier, org.apache.openjpa.jdbc.schema.Table, int, boolean)">getValidColumnIdentifier</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A>&nbsp;name,
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A>&nbsp;table,
int&nbsp;maxLen,
boolean&nbsp;checkForUniqueness)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a valid column name/identifier, based upon the configuration and
provided parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html#getValidForeignKeyIdentifier(org.apache.openjpa.jdbc.identifier.DBIdentifier, org.apache.openjpa.jdbc.schema.Table, org.apache.openjpa.jdbc.schema.Table, int)">getValidForeignKeyIdentifier</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A>&nbsp;name,
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A>&nbsp;table,
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A>&nbsp;toTable,
int&nbsp;maxLen)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a valid foreign key identifier, based upon the configuration and
provided parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html#getValidIndexIdentifier(org.apache.openjpa.jdbc.identifier.DBIdentifier, org.apache.openjpa.jdbc.schema.Table, int)">getValidIndexIdentifier</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A>&nbsp;name,
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A>&nbsp;table,
int&nbsp;maxLen)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a valid index identifier, based upon the configuration and
provided parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html#getValidSequenceIdentifier(org.apache.openjpa.jdbc.identifier.DBIdentifier, org.apache.openjpa.jdbc.schema.Schema, int)">getValidSequenceIdentifier</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A>&nbsp;name,
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Schema.html" title="class in org.apache.openjpa.jdbc.schema">Schema</A>&nbsp;schema,
int&nbsp;maxLen)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a valid index identifier, based upon the configuration and
provided parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html#getValidTableIdentifier(org.apache.openjpa.jdbc.identifier.DBIdentifier, org.apache.openjpa.jdbc.schema.Schema, int)">getValidTableIdentifier</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A>&nbsp;name,
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Schema.html" title="class in org.apache.openjpa.jdbc.schema">Schema</A>&nbsp;schema,
int&nbsp;maxLen)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a valid table identifier, based upon the configuration and provided
parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html#getValidUniqueIdentifier(org.apache.openjpa.jdbc.identifier.DBIdentifier, org.apache.openjpa.jdbc.schema.Table, int)">getValidUniqueIdentifier</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A>&nbsp;name,
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A>&nbsp;table,
int&nbsp;maxLen)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a valid unique constraint identifier, based upon the configuration and
provided parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html#makeIdentifierValid(org.apache.openjpa.jdbc.identifier.DBIdentifier, org.apache.openjpa.jdbc.schema.NameSet, int, boolean)">makeIdentifierValid</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A>&nbsp;sname,
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/NameSet.html" title="class in org.apache.openjpa.jdbc.schema">NameSet</A>&nbsp;set,
int&nbsp;maxLen,
boolean&nbsp;checkForUniqueness)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Shortens the given name to the given maximum length, then checks that
it is not a reserved word.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html#makeNameValid(java.lang.String, org.apache.openjpa.jdbc.schema.NameSet, int, int, boolean)">makeNameValid</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name,
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/NameSet.html" title="class in org.apache.openjpa.jdbc.schema">NameSet</A>&nbsp;set,
int&nbsp;maxLen,
int&nbsp;nameType,
boolean&nbsp;checkForUniqueness)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Shortens the given name to the given maximum length, then checks that
it is not a reserved word.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html#toDBName(org.apache.openjpa.jdbc.identifier.DBIdentifier)">toDBName</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A>&nbsp;name)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts the specified identifier to a format required by the database.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html#toDBName(org.apache.openjpa.jdbc.identifier.DBIdentifier, boolean)">toDBName</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A>&nbsp;name,
boolean&nbsp;delimit)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts the specified identifier to a format required by the database,
optionally delimiting the name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html#toDBName(java.lang.String)">toDBName</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts the specified string to a format required by the database.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html#toDBName(java.lang.String, boolean)">toDBName</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name,
boolean&nbsp;delimit)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts the specified string to a format required by the database,
optionally delimiting the name.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.openjpa.lib.identifier.IdentifierUtil"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface org.apache.openjpa.lib.identifier.<A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html" title="interface in org.apache.openjpa.lib.identifier">IdentifierUtil</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#appendNames(org.apache.openjpa.lib.identifier.IdentifierRule, java.lang.String, java.lang.String)">appendNames</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#appendNames(java.lang.String, java.lang.String, java.lang.String)">appendNames</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#canSplit(org.apache.openjpa.lib.identifier.IdentifierRule, java.lang.String)">canSplit</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#canSplit(org.apache.openjpa.lib.identifier.IdentifierRule, java.lang.String, java.lang.String)">canSplit</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#canSplit(java.lang.String, java.lang.String)">canSplit</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#canSplit(java.lang.String, java.lang.String, java.lang.String)">canSplit</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#combineNames(org.apache.openjpa.lib.identifier.IdentifierRule, org.apache.openjpa.lib.identifier.IdentifierRule[], java.lang.String[])">combineNames</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#combineNames(org.apache.openjpa.lib.identifier.IdentifierRule, java.lang.String[])">combineNames</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#combineNames(org.apache.openjpa.lib.identifier.IdentifierRule, java.lang.String, java.lang.String)">combineNames</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#combineNames(java.lang.String, java.lang.String[])">combineNames</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#combineNames(java.lang.String, java.lang.String[], java.lang.String[])">combineNames</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#combineNames(java.lang.String, java.lang.String, java.lang.String)">combineNames</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#convert(org.apache.openjpa.lib.identifier.IdentifierConfiguration, java.lang.String, java.lang.String)">convert</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#convertFull(org.apache.openjpa.lib.identifier.IdentifierConfiguration, java.lang.String, java.lang.String)">convertFull</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#delimit(org.apache.openjpa.lib.identifier.IdentifierRule, java.lang.String)">delimit</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#delimit(org.apache.openjpa.lib.identifier.IdentifierRule, java.lang.String, boolean)">delimit</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#delimit(java.lang.String, java.lang.String)">delimit</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#delimit(java.lang.String, java.lang.String, boolean)">delimit</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#getIdentifierConfiguration()">getIdentifierConfiguration</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#isDelimited(org.apache.openjpa.lib.identifier.IdentifierRule, java.lang.String)">isDelimited</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#isDelimited(java.lang.String, java.lang.String)">isDelimited</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#isReservedWord(org.apache.openjpa.lib.identifier.IdentifierRule, java.lang.String)">isReservedWord</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#isReservedWord(java.lang.String, java.lang.String)">isReservedWord</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#joinNames(org.apache.openjpa.lib.identifier.IdentifierRule[], java.lang.String[])">joinNames</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#joinNames(org.apache.openjpa.lib.identifier.IdentifierRule, java.lang.String[])">joinNames</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#joinNames(org.apache.openjpa.lib.identifier.IdentifierRule, java.lang.String[], java.lang.String)">joinNames</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#joinNames(java.lang.String[], java.lang.String[])">joinNames</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#joinNames(java.lang.String, java.lang.String[])">joinNames</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#joinNames(java.lang.String, java.lang.String[], java.lang.String)">joinNames</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#removeDelimiters(org.apache.openjpa.lib.identifier.IdentifierConfiguration, java.lang.String, java.lang.String)">removeDelimiters</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#removeDelimiters(org.apache.openjpa.lib.identifier.IdentifierRule, java.lang.String)">removeDelimiters</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#removeDelimiters(java.lang.String, java.lang.String)">removeDelimiters</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#removeHungarianNotation(org.apache.openjpa.lib.identifier.IdentifierRule, java.lang.String)">removeHungarianNotation</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#removeHungarianNotation(java.lang.String, java.lang.String)">removeHungarianNotation</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#requiresDelimiters(org.apache.openjpa.lib.identifier.IdentifierRule, java.lang.String)">requiresDelimiters</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#requiresDelimiters(java.lang.String, java.lang.String)">requiresDelimiters</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#setIdentifierConfiguration(org.apache.openjpa.lib.identifier.IdentifierConfiguration)">setIdentifierConfiguration</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#splitName(org.apache.openjpa.lib.identifier.IdentifierRule, java.lang.String)">splitName</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#splitName(org.apache.openjpa.lib.identifier.IdentifierRule, java.lang.String, java.lang.String)">splitName</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#splitName(java.lang.String, java.lang.String)">splitName</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#splitName(java.lang.String, java.lang.String, java.lang.String)">splitName</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#truncateName(org.apache.openjpa.lib.identifier.IdentifierRule, java.lang.String, int)">truncateName</A>, <A HREF="../../../../../org/apache/openjpa/lib/identifier/IdentifierUtil.html#truncateName(java.lang.String, java.lang.String, int)">truncateName</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="ANY"><!-- --></A><H3>
ANY</H3>
<PRE>
static final int <B>ANY</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.identifier.DBIdentifierUtil.ANY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="TABLE"><!-- --></A><H3>
TABLE</H3>
<PRE>
static final int <B>TABLE</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.identifier.DBIdentifierUtil.TABLE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SEQUENCE"><!-- --></A><H3>
SEQUENCE</H3>
<PRE>
static final int <B>SEQUENCE</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.identifier.DBIdentifierUtil.SEQUENCE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="COLUMN"><!-- --></A><H3>
COLUMN</H3>
<PRE>
static final int <B>COLUMN</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.identifier.DBIdentifierUtil.COLUMN">Constant Field Values</A></DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="makeIdentifierValid(org.apache.openjpa.jdbc.identifier.DBIdentifier, org.apache.openjpa.jdbc.schema.NameSet, int, boolean)"><!-- --></A><H3>
makeIdentifierValid</H3>
<PRE>
<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A> <B>makeIdentifierValid</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A>&nbsp;sname,
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/NameSet.html" title="class in org.apache.openjpa.jdbc.schema">NameSet</A>&nbsp;set,
int&nbsp;maxLen,
boolean&nbsp;checkForUniqueness)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="makeNameValid(java.lang.String, org.apache.openjpa.jdbc.schema.NameSet, int, int, boolean)"><!-- --></A><H3>
makeNameValid</H3>
<PRE>
<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A> <B>makeNameValid</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name,
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/NameSet.html" title="class in org.apache.openjpa.jdbc.schema">NameSet</A>&nbsp;set,
int&nbsp;maxLen,
int&nbsp;nameType,
boolean&nbsp;checkForUniqueness)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getValidColumnIdentifier(org.apache.openjpa.jdbc.identifier.DBIdentifier, org.apache.openjpa.jdbc.schema.Table, int, boolean)"><!-- --></A><H3>
getValidColumnIdentifier</H3>
<PRE>
<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A> <B>getValidColumnIdentifier</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A>&nbsp;name,
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A>&nbsp;table,
int&nbsp;maxLen,
boolean&nbsp;checkForUniqueness)</PRE>
<DL>
<DD>Returns a valid column name/identifier, based upon the configuration and
provided parameters.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - <DD><CODE>table</CODE> - <DD><CODE>maxLen</CODE> - <DD><CODE>checkForUniqueness</CODE> -
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="getValidIndexIdentifier(org.apache.openjpa.jdbc.identifier.DBIdentifier, org.apache.openjpa.jdbc.schema.Table, int)"><!-- --></A><H3>
getValidIndexIdentifier</H3>
<PRE>
<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A> <B>getValidIndexIdentifier</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A>&nbsp;name,
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A>&nbsp;table,
int&nbsp;maxLen)</PRE>
<DL>
<DD>Returns a valid index identifier, based upon the configuration and
provided parameters.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - <DD><CODE>table</CODE> - <DD><CODE>maxLen</CODE> - <DD><CODE>checkForUniqueness</CODE> -
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="getValidSequenceIdentifier(org.apache.openjpa.jdbc.identifier.DBIdentifier, org.apache.openjpa.jdbc.schema.Schema, int)"><!-- --></A><H3>
getValidSequenceIdentifier</H3>
<PRE>
<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A> <B>getValidSequenceIdentifier</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A>&nbsp;name,
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Schema.html" title="class in org.apache.openjpa.jdbc.schema">Schema</A>&nbsp;schema,
int&nbsp;maxLen)</PRE>
<DL>
<DD>Returns a valid index identifier, based upon the configuration and
provided parameters.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - <DD><CODE>table</CODE> - <DD><CODE>maxLen</CODE> - <DD><CODE>checkForUniqueness</CODE> -
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="getValidTableIdentifier(org.apache.openjpa.jdbc.identifier.DBIdentifier, org.apache.openjpa.jdbc.schema.Schema, int)"><!-- --></A><H3>
getValidTableIdentifier</H3>
<PRE>
<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A> <B>getValidTableIdentifier</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A>&nbsp;name,
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Schema.html" title="class in org.apache.openjpa.jdbc.schema">Schema</A>&nbsp;schema,
int&nbsp;maxLen)</PRE>
<DL>
<DD>Returns a valid table identifier, based upon the configuration and provided
parameters.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - <DD><CODE>schema</CODE> - <DD><CODE>maxLen</CODE> -
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="getValidUniqueIdentifier(org.apache.openjpa.jdbc.identifier.DBIdentifier, org.apache.openjpa.jdbc.schema.Table, int)"><!-- --></A><H3>
getValidUniqueIdentifier</H3>
<PRE>
<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A> <B>getValidUniqueIdentifier</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A>&nbsp;name,
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A>&nbsp;table,
int&nbsp;maxLen)</PRE>
<DL>
<DD>Returns a valid unique constraint identifier, based upon the configuration and
provided parameters.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - <DD><CODE>table</CODE> - <DD><CODE>maxLen</CODE> -
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="getValidForeignKeyIdentifier(org.apache.openjpa.jdbc.identifier.DBIdentifier, org.apache.openjpa.jdbc.schema.Table, org.apache.openjpa.jdbc.schema.Table, int)"><!-- --></A><H3>
getValidForeignKeyIdentifier</H3>
<PRE>
<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A> <B>getValidForeignKeyIdentifier</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A>&nbsp;name,
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A>&nbsp;table,
<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A>&nbsp;toTable,
int&nbsp;maxLen)</PRE>
<DL>
<DD>Returns a valid foreign key identifier, based upon the configuration and
provided parameters.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - <DD><CODE>table</CODE> - <DD><CODE>toTable</CODE> - <DD><CODE>maxLen</CODE> -
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="toDBName(org.apache.openjpa.jdbc.identifier.DBIdentifier)"><!-- --></A><H3>
toDBName</H3>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toDBName</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A>&nbsp;name)</PRE>
<DL>
<DD>Converts the specified identifier to a format required by the database.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> -
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="toDBName(org.apache.openjpa.jdbc.identifier.DBIdentifier, boolean)"><!-- --></A><H3>
toDBName</H3>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toDBName</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A>&nbsp;name,
boolean&nbsp;delimit)</PRE>
<DL>
<DD>Converts the specified identifier to a format required by the database,
optionally delimiting the name.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - <DD><CODE>delimit</CODE> -
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="toDBName(java.lang.String)"><!-- --></A><H3>
toDBName</H3>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toDBName</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
<DL>
<DD>Converts the specified string to a format required by the database.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> -
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="toDBName(java.lang.String, boolean)"><!-- --></A><H3>
toDBName</H3>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toDBName</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name,
boolean&nbsp;delimit)</PRE>
<DL>
<DD>Converts the specified string to a format required by the database,
optionally delimiting the name.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> -
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="fromDBName(java.lang.String, org.apache.openjpa.jdbc.identifier.DBIdentifier.DBIdentifierType)"><!-- --></A><H3>
fromDBName</H3>
<PRE>
<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A> <B>fromDBName</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name,
<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.DBIdentifierType.html" title="enum in org.apache.openjpa.jdbc.identifier">DBIdentifier.DBIdentifierType</A>&nbsp;id)</PRE>
<DL>
<DD>Converts the name returned by the database to an identifier of the
specified type.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> -
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="appendColumns(org.apache.openjpa.jdbc.schema.Column[])"><!-- --></A><H3>
appendColumns</H3>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>appendColumns</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[]&nbsp;columns)</PRE>
<DL>
<DD>Appends multiple columns names together into comma delimited string.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>columns</CODE> -
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="convertSchemaCase(org.apache.openjpa.jdbc.identifier.DBIdentifier)"><!-- --></A><H3>
convertSchemaCase</H3>
<PRE>
<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A> <B>convertSchemaCase</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A>&nbsp;schema)</PRE>
<DL>
<DD>Converts the name of the specified delimiter to the appropriate
case as defined by the configuration.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>columns</CODE> -
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="append(org.apache.openjpa.jdbc.identifier.DBIdentifier.DBIdentifierType, org.apache.openjpa.jdbc.identifier.DBIdentifier...)"><!-- --></A><H3>
append</H3>
<PRE>
<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A> <B>append</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.DBIdentifierType.html" title="enum in org.apache.openjpa.jdbc.identifier">DBIdentifier.DBIdentifierType</A>&nbsp;resultId,
<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A>...&nbsp;names)</PRE>
<DL>
<DD>Appends multiple names together using the appropriate name delimiter.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>resultId</CODE> - <DD><CODE>names</CODE> -
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="getGeneratedKeySequenceName(org.apache.openjpa.jdbc.schema.Column, int)"><!-- --></A><H3>
getGeneratedKeySequenceName</H3>
<PRE>
<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</A> <B>getGeneratedKeySequenceName</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>&nbsp;col,
int&nbsp;maxLen)</PRE>
<DL>
<DD>Returns a generated key sequence identifier for the column.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>col</CODE> - <DD><CODE>maxLen</CODE> -
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="convertAlias(java.lang.String)"><!-- --></A><H3>
convertAlias</H3>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>convertAlias</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;alias)</PRE>
<DL>
<DD>Converts a provided alias to a format specified in the configuration.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>alias</CODE> -
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DBIdentifierUtil.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierRule.html" title="class in org.apache.openjpa.jdbc.identifier"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtilImpl.html" title="class in org.apache.openjpa.jdbc.identifier"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="DBIdentifierUtil.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright &#169; 2006-2012 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.
</BODY>
</HTML>