Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 3.1.0 / apidocs / org / apache / openjpa / jdbc / identifier / DBIdentifierRule.html
blob: 45a244de0ee889484b0264ded97713274c783bdb [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_201) on Wed Apr 24 20:07:09 CEST 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DBIdentifierRule (OpenJPA Parent POM 3.1.0 API)</title>
<meta name="date" content="2019-04-24">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DBIdentifierRule (OpenJPA Parent POM 3.1.0 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DBIdentifierRule.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.DBIdentifierType.html" title="enum in org.apache.openjpa.jdbc.identifier"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html" title="interface in org.apache.openjpa.jdbc.identifier"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/identifier/DBIdentifierRule.html" target="_top">Frames</a></li>
<li><a href="DBIdentifierRule.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.org.apache.openjpa.lib.identifier.IdentifierRule">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.openjpa.jdbc.identifier</div>
<h2 title="Class DBIdentifierRule" class="title">Class DBIdentifierRule</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html" title="class in org.apache.openjpa.lib.identifier">org.apache.openjpa.lib.identifier.IdentifierRule</a></li>
<li>
<ul class="inheritance">
<li>org.apache.openjpa.jdbc.identifier.DBIdentifierRule</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/openjpa/jdbc/identifier/ColumnDefIdentifierRule.html" title="class in org.apache.openjpa.jdbc.identifier">ColumnDefIdentifierRule</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">DBIdentifierRule</span>
extends <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html" title="class in org.apache.openjpa.lib.identifier">IdentifierRule</a></pre>
<div class="block">The default DBIdentifier rule. Closely matches SQL92 naming rules.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierRule.html#DEFAULT_SQL_92">DEFAULT_SQL_92</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierRule.html#SPECIAL_CHARS">SPECIAL_CHARS</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.openjpa.lib.identifier.IdentifierRule">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.openjpa.lib.identifier.<a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html" title="class in org.apache.openjpa.lib.identifier">IdentifierRule</a></h3>
<code><a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#DEFAULT_RULE">DEFAULT_RULE</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#EMPTY_SET">EMPTY_SET</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#UNDERSCORE">UNDERSCORE</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierRule.html#DBIdentifierRule--">DBIdentifierRule</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierRule.html#DBIdentifierRule-org.apache.openjpa.jdbc.identifier.DBIdentifier.DBIdentifierType-java.util.Set-">DBIdentifierRule</a></span>(<a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.DBIdentifierType.html" title="enum in org.apache.openjpa.jdbc.identifier">DBIdentifier.DBIdentifierType</a>&nbsp;id,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;reservedWords)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.openjpa.lib.identifier.IdentifierRule">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.openjpa.lib.identifier.<a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html" title="class in org.apache.openjpa.lib.identifier">IdentifierRule</a></h3>
<code><a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#getAllowCompaction--">getAllowCompaction</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#getCanDelimit--">getCanDelimit</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#getDelimitReservedWords--">getDelimitReservedWords</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#getMaxLength--">getMaxLength</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#getMustDelimit--">getMustDelimit</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#getName--">getName</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#getReservedWords--">getReservedWords</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#getSpecialCharacters--">getSpecialCharacters</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#isAllowTruncation--">isAllowTruncation</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#isMustBeginWithLetter--">isMustBeginWithLetter</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#isNullable--">isNullable</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#isOnlyLettersDigitsUnderscores--">isOnlyLettersDigitsUnderscores</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#isReservedWord-java.lang.String-">isReservedWord</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#requiresDelimiters-java.lang.String-">requiresDelimiters</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#setAllowCompaction-boolean-">setAllowCompaction</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#setAllowTruncation-boolean-">setAllowTruncation</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#setCanDelimit-boolean-">setCanDelimit</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#setDelimitReservedWords-boolean-">setDelimitReservedWords</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#setMaxLength-int-">setMaxLength</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#setMustBeginWithLetter-boolean-">setMustBeginWithLetter</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#setMustDelimit-boolean-">setMustDelimit</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#setName-java.lang.String-">setName</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#setNullable-boolean-">setNullable</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#setOnlyLettersDigitsUnderscores-boolean-">setOnlyLettersDigitsUnderscores</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#setReservedWords-java.util.Set-">setReservedWords</a>, <a href="../../../../../org/apache/openjpa/lib/identifier/IdentifierRule.html#setSpecialCharacters-java.lang.String-">setSpecialCharacters</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DEFAULT_SQL_92">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_SQL_92</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_SQL_92</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.identifier.DBIdentifierRule.DEFAULT_SQL_92">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="SPECIAL_CHARS">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SPECIAL_CHARS</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SPECIAL_CHARS</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.identifier.DBIdentifierRule.SPECIAL_CHARS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DBIdentifierRule--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DBIdentifierRule</h4>
<pre>public&nbsp;DBIdentifierRule()</pre>
</li>
</ul>
<a name="DBIdentifierRule-org.apache.openjpa.jdbc.identifier.DBIdentifier.DBIdentifierType-java.util.Set-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DBIdentifierRule</h4>
<pre>public&nbsp;DBIdentifierRule(<a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.DBIdentifierType.html" title="enum in org.apache.openjpa.jdbc.identifier">DBIdentifier.DBIdentifierType</a>&nbsp;id,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;reservedWords)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DBIdentifierRule.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.DBIdentifierType.html" title="enum in org.apache.openjpa.jdbc.identifier"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifierUtil.html" title="interface in org.apache.openjpa.jdbc.identifier"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/identifier/DBIdentifierRule.html" target="_top">Frames</a></li>
<li><a href="DBIdentifierRule.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.org.apache.openjpa.lib.identifier.IdentifierRule">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2019 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>