Top Description Fields Constructors Methods
org.jooq.impl

public abstract non-sealed Class CustomTable<R extends org.jooq.TableRecord<R>>

extends TableImpl<R extends TableRecord<R>>
implements UOpaque
Class Inheritance
All Implemented Interfaces
org.jooq.impl.QOM.UOpaque, org.jooq.impl.QOM.UEmpty, org.jooq.QueryPart, java.io.Serializable
Imports
java.util.List, org.jooq.Cursor, .ForeignKey, .Identity, .Name, .Record, .Result, .ResultQuery, .Schema, .Table, .TableRecord, .UniqueKey, org.jooq.impl.QOM.UOpaque

Deprecated

as a consequence of TableImpl being deprecated. See corresponding docs for further information.

A base class for custom Table implementations in client code.

Client code may provide proper Table implementations extending this useful base class. All necessary parts of the Table interface are already implemented. Only this method needs further implementation:

Refer to this method's Javadoc for further details about its expected behaviour.

Use this base class when providing custom tables to any of the following methods:

Author
Lukas Eder

Field Summary

Inherited from org.jooq.impl.TableImpl:
aliaschildchildPathfieldsparameters

Constructor Summary

AccessConstructor and Description
protected
CustomTable(Name name)

protected
CustomTable(Name name, Schema schema)

protected
CustomTable(String name)

Deprecated - 3.10 - [#5996] - Use CustomTable(Name) instead.
protected
CustomTable(String name, Schema schema)

Deprecated - 3.10 - [#5996] - Use CustomTable(Name, Schema) instead.

Method Summary

Modifier and TypeMethod and Description
public final boolean
declaresFields()

Overrides org.jooq.impl.AbstractQueryPart.declaresFields.

Implements org.jooq.QueryPartInternal.declaresFields.

Check whether this QueryPart is able to declare fields in a SELECT clause.
public final boolean
declaresTables()

Overrides org.jooq.impl.TableImpl.declaresTables.

Implements org.jooq.QueryPartInternal.declaresTables.

Check whether this QueryPart is able to declare tables in a FROM clause or JOIN clause.
public Identity<R, ?>
getIdentity()

Overrides org.jooq.impl.AbstractTable.getIdentity.

Implements org.jooq.Table.getIdentity.

Retrieve the table's IDENTITY information, if available.
public UniqueKey<R>
getPrimaryKey()

Overrides org.jooq.impl.AbstractTable.getPrimaryKey.

Implements org.jooq.Table.getPrimaryKey.

Retrieve the table's primary key

Subclasses may override this method

public abstract Class<? extends R>
getRecordType()

Redeclares org.jooq.RecordQualifier.getRecordType.

Overrides org.jooq.impl.TableImpl.getRecordType.

Subclasses must implement this method <hr> Subclasses must override this method if they use the generic type parameter R for other types than Record

The record type produced by this UDT or Table.

public List<ForeignKey<R, ?>>
getReferences()

Overrides org.jooq.impl.AbstractTable.getReferences.

Implements org.jooq.Table.getReferences.

Get the list of FOREIGN KEY's of this table

Subclasses should override this method

public List<UniqueKey<R>>
getUniqueKeys()

Overrides org.jooq.impl.AbstractTable.getUniqueKeys.

Implements org.jooq.Table.getUniqueKeys.

Retrieve all of the table's unique keys.
Inherited from org.jooq.impl.TableImpl:
acceptaliasedasasclausesequalsfieldfieldfieldfieldfieldfieldfields0fieldsRowgetAliasedTablehashCodeisSimpleisSyntheticjoinrenamerenamerenamerootChild

Constructor Detail

CustomTableback to summary
protected CustomTable(Name name)
CustomTableback to summary
protected CustomTable(Name name, Schema schema)
CustomTableback to summary
protected CustomTable(String name)

Deprecated

- 3.10 - [#5996] - Use CustomTable(Name) instead.

Annotations
@Deprecated
CustomTableback to summary
protected CustomTable(String name, Schema schema)

Deprecated

- 3.10 - [#5996] - Use CustomTable(Name, Schema) instead.

Annotations
@Deprecated

Method Detail

declaresFieldsback to summary
public final boolean declaresFields()

Overrides org.jooq.impl.AbstractQueryPart.declaresFields.

Implements org.jooq.QueryPartInternal.declaresFields.

Doc from org.jooq.QueryPartInternal.declaresFields.

Check whether this QueryPart is able to declare fields in a SELECT clause.

This method can be used by any Context to check how a certain SQL clause should be rendered.

This method is for JOOQ INTERNAL USE only. Do not reference directly

Annotations
@Override
declaresTablesback to summary
public final boolean declaresTables()

Overrides org.jooq.impl.TableImpl.declaresTables.

Implements org.jooq.QueryPartInternal.declaresTables.

Doc from org.jooq.QueryPartInternal.declaresTables.

Check whether this QueryPart is able to declare tables in a FROM clause or JOIN clause.

This method can be used by any Context to check how a certain SQL clause should be rendered.

This method is for JOOQ INTERNAL USE only. Do not reference directly

Annotations
@Override
getIdentityback to summary
public Identity<R, ?> getIdentity()

Overrides org.jooq.impl.AbstractTable.getIdentity.

Implements org.jooq.Table.getIdentity.

Doc from org.jooq.impl.AbstractTable.getIdentity.

Retrieve the table's IDENTITY information, if available.

With SQL:2003, the concept of IDENTITY columns was introduced in most RDBMS. These are special kinds of columns that have auto-increment functionality when INSERT statements are performed.

An IDENTITY column is usually part of the PRIMARY KEY or of a UNIQUE KEY in the table, although in some RDBMS, this is not required. There can only be at most one IDENTITY column.

Note

Unfortunately, this is not supported in the Oracle dialect, where identities emulated by triggers cannot be formally detected.

Subclasses should override this method

Returns:Identity<R, ?>

Doc from org.jooq.Table.getIdentity.

The table's IDENTITY information, or null, if no such information is available.

Annotations
@Override
getPrimaryKeyback to summary
public UniqueKey<R> getPrimaryKey()

Overrides org.jooq.impl.AbstractTable.getPrimaryKey.

Implements org.jooq.Table.getPrimaryKey.

Doc from org.jooq.impl.AbstractTable.getPrimaryKey.

Retrieve the table's primary key

Subclasses may override this method

Returns:UniqueKey<R>

Doc from org.jooq.Table.getPrimaryKey.

The primary key. This is never null for an updatable table.

Annotations
@Override
getRecordTypeback to summary
public abstract Class<? extends R> getRecordType()

Redeclares org.jooq.RecordQualifier.getRecordType.

Overrides org.jooq.impl.TableImpl.getRecordType.

Doc from org.jooq.impl.TableImpl.getRecordType.

Subclasses must implement this method

Subclasses must override this method if they use the generic type parameter R for other types than Record

The record type produced by this UDT or Table.

Annotations
@Override
getReferencesback to summary
public List<ForeignKey<R, ?>> getReferences()

Overrides org.jooq.impl.AbstractTable.getReferences.

Implements org.jooq.Table.getReferences.

Doc from org.jooq.impl.AbstractTable.getReferences.

Get the list of FOREIGN KEY's of this table

Subclasses should override this method

Returns:List<ForeignKey<R, ?>>

Doc from org.jooq.Table.getReferences.

This table's FOREIGN KEY's. This is never null.

Annotations
@Override
getUniqueKeysback to summary
public List<UniqueKey<R>> getUniqueKeys()

Overrides org.jooq.impl.AbstractTable.getUniqueKeys.

Implements org.jooq.Table.getUniqueKeys.

Doc from org.jooq.impl.AbstractTable.getUniqueKeys.

Retrieve all of the table's unique keys.

Subclasses should override this method

Returns:List<UniqueKey<R>>

Doc from org.jooq.Table.getUniqueKeys.

All keys. This is never null.

Annotations
@Override