github/jooq
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[#1983] Improve the Javadoc on Table.as() and Field.as() to hint at

Browse Source 
case-sensitivity and RenderNameStyle
This commit is contained in:
Lukas Eder 2012-11-28 19:57:06 +01:00
parent d61f8d30ba
commit 46f5d7c0e6
4 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
jOOQ/src/main/java/org/jooq/Field.java
View File

@ -55,6 +55,7 @@ import java.math.BigDecimal;
import java.util.Collection;
import java.util.Map;
import org.jooq.conf.Settings;
import org.jooq.impl.Executor;
import org.jooq.impl.Factory;
import org.jooq.types.Interval;
@ -106,6 +107,10 @@ public interface Field<T> extends GroupField {
/**
* Create an alias for this field
* <p>
* Note that the case-sensitivity of the returned field depends on
* {@link Settings#getRenderNameStyle()}. By default, field aliases are
* quoted, and thus case-sensitive!
*
* @param alias The alias name
* @return The field alias

6
jOOQ/src/main/java/org/jooq/FieldLike.java
View File

@ -35,6 +35,8 @@
*/
package org.jooq;
import org.jooq.conf.Settings;
/**
* An object that can behave like a field (a field-like object)
*
@ -57,6 +59,10 @@ public interface FieldLike {
* <p>
* This method is useful for things like
* <code>SELECT y.*, (SELECT a FROM x) [alias] FROM y</code>
* <p>
* Note that the case-sensitivity of the returned field depends on
* {@link Settings#getRenderNameStyle()}. By default, field aliases are
* quoted, and thus case-sensitive!
*
* @return This result provider as a Field&lt;?&gt; object
*/

5
jOOQ/src/main/java/org/jooq/Table.java
View File

@ -53,6 +53,7 @@ import static org.jooq.SQLDialect.SYBASE;
import java.util.Collection;
import java.util.List;
import org.jooq.conf.Settings;
import org.jooq.impl.Factory;
/**
@ -80,6 +81,10 @@ public interface Table<R extends Record> extends FieldProvider, TableLike<R> {
/**
* Create an alias for this table
* <p>
* Note that the case-sensitivity of the returned table depends on
* {@link Settings#getRenderNameStyle()}. By default, table aliases are
* quoted, and thus case-sensitive!
*
* @param alias The alias name
* @return The table alias

6
jOOQ/src/main/java/org/jooq/TableLike.java
View File

@ -35,6 +35,8 @@
*/
package org.jooq;
import org.jooq.conf.Settings;
/**
* An object that can behave like a table (a table-like object)
*
@ -56,6 +58,10 @@ public interface TableLike<R extends Record> extends QueryPart {
* <p>
* This method is useful for things like
* <code>SELECT * FROM (SELECT * FROM x WHERE x.a = '1') [alias] WHERE ... </code>
* <p>
* Note that the case-sensitivity of the returned table depends on
* {@link Settings#getRenderNameStyle()}. By default, table aliases are
* quoted, and thus case-sensitive!
*/
Table<R> asTable(String alias);
}