SchemaTable

All Known Implementing Classes:

ContentTableType, CoreTableType, LegacyTableType
```
public interface SchemaTable
```
SchemaTable specifies a database table definition.
While not required, the SDK recommends defining the database tables in your application (or service) via an enum class (as does the SDK itself).

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default int`	`getColumnCount()` Returns the count of the table's fields (aka columns).
`java.util.List<Pair<java.lang.Enum<?>,java.lang.String>>`	`getColumnDefns()` Returns this table's column definitions.
`java.util.List<java.lang.String>`	`getColumnNames()` Returns a list of the table's field (aka column) names.
`static java.util.List<java.lang.String>`	`getColumnNames(java.util.List<Pair<java.lang.Enum<?>,java.lang.String>> defns)` Returns a list of table column name extracted from the list of table column definitions.
`javax.sql.DataSource`	`getDataSource()` Returns a the data source containing this table.
`java.lang.String`	`getDataSourceType()` Returns the DataSourceType of this table.
`SdkDataSourceWrapper`	`getDataSourceWrapper()` Returns the data source wrapper.
`static java.lang.String`	`getName(java.lang.Enum<?> enumElt)`
`static java.lang.String`	`getPkName(java.util.List<Pair<java.lang.Enum<?>,java.lang.String>> defns)` Returns the name of the primary key found in a table's column definitions
`java.lang.String`	`getPrimaryKeyName()` Returns the name of this table's primary key; or `null` if none.
`static int`	`getRequiredColumnCount(java.util.List<Pair<java.lang.Enum<?>,java.lang.String>> defns)`
`static SchemaTable`	`getTableForType(java.lang.Enum<?> type)` Returns the `SchemaTable` type tagged with a specified Enum type.
`java.lang.String`	`getTableName()` Return this table's name as it appears in the database
`default java.lang.Enum<?>[]`	`getTypes()` Returns the list of enum values associated with this table.
`default boolean`	`hasPrimaryKey()` Returns whether this table contains a primary key.
`void`	`init(DataSourceRegistry dsr)` Sets the data source registry and provides post-constructor setup which depends on that registry.
`boolean`	`isExactFieldCountRequired()`
`static boolean`	`isPrimaryKey(java.lang.Enum<?> enumElt)` Returns whether a particular column definition specifies that it is a primary key.

- Method Detail
  - init
```
void init(DataSourceRegistry dsr)
```
    Sets the data source registry and provides post-constructor setup which depends on that registry.
    
    Parameters:
    
    dsr - The data source registry
  - getDataSource
```
javax.sql.DataSource getDataSource()
```
    Returns a the data source containing this table.
  - getDataSourceWrapper
```
SdkDataSourceWrapper getDataSourceWrapper()
```
    Returns the data source wrapper.
  - getDataSourceType
```
java.lang.String getDataSourceType()
```
    Returns the DataSourceType of this table.
  - getTableName
```
java.lang.String getTableName()
```
    Return this table's name as it appears in the database
  - getColumnDefns
```
java.util.List<Pair<java.lang.Enum<?>,java.lang.String>> getColumnDefns()
```
    Returns this table's column definitions.
  - getPrimaryKeyName
```
java.lang.String getPrimaryKeyName()
```
    Returns the name of this table's primary key; or null if none.
  - getColumnNames
```
java.util.List<java.lang.String> getColumnNames()
```
    Returns a list of the table's field (aka column) names. This include the primary key name.
  - isExactFieldCountRequired
```
boolean isExactFieldCountRequired()
```
  - hasPrimaryKey
```
default boolean hasPrimaryKey()
```
    Returns whether this table contains a primary key.
  - getTypes
```
default java.lang.Enum<?>[] getTypes()
```
    Returns the list of enum values associated with this table.
  - getColumnCount
```
default int getColumnCount()
```
    Returns the count of the table's fields (aka columns). This include the primary key field.
  - getColumnNames
```
static java.util.List<java.lang.String> getColumnNames(java.util.List<Pair<java.lang.Enum<?>,java.lang.String>> defns)
```
    Returns a list of table column name extracted from the list of table column definitions.
    
    Parameters:
    
    defns - Column definitions
  - getRequiredColumnCount
```
static int getRequiredColumnCount(java.util.List<Pair<java.lang.Enum<?>,java.lang.String>> defns)
```
  - getPkName
```
static java.lang.String getPkName(java.util.List<Pair<java.lang.Enum<?>,java.lang.String>> defns)
```
    Returns the name of the primary key found in a table's column definitions
    
    Parameters:
    
    defns - Column definitions
    
    Returns:
    
    The primary key name or null if none is defined for the table.
  - getTableForType
```
static SchemaTable getTableForType(java.lang.Enum<?> type)
```
    Returns the SchemaTable type tagged with a specified Enum type.
    For example: Find the SchemaTable type tagged with ExternalReferenceType.GROUP.
    
    Parameters:
    
    type - Enum type to look for among the schema tables.
    
    Returns:
    
    The SchemaTable type tagged with type, or null if none.
  - getName
```
static java.lang.String getName(java.lang.Enum<?> enumElt)
```
  - isPrimaryKey
```
static boolean isPrimaryKey(java.lang.Enum<?> enumElt)
```
    Returns whether a particular column definition specifies that it is a primary key.
    
    Parameters:
    
    enumElt - Column definition
    
    Returns:
    
    true if the column is the primary key; otherwiser false

Interface SchemaTable

Method Summary

Method Detail

init

getDataSource

getDataSourceWrapper

getDataSourceType

getTableName

getColumnDefns

getPrimaryKeyName

getColumnNames

isExactFieldCountRequired

hasPrimaryKey

getTypes

getColumnCount

getColumnNames

getRequiredColumnCount

getPkName

getTableForType

getName

isPrimaryKey