Module is.codion.framework.domain.db

Package is.codion.framework.domain.db

Class SchemaDomain

java.lang.Object

is.codion.framework.domain.DomainModel

is.codion.framework.domain.db.SchemaDomain

All Implemented Interfaces:

Domain

public final class SchemaDomain
extends DomainModel

A DomainModel generated from a database schema's DatabaseMetaData, with an EntityDefinition per table and foreign keys derived from the schema's referential constraints. The basis for the domain generator tooling. For instances use the available factory methods.

See Also:

• schemaDomain(DatabaseMetaData, String)
• schemaDomain(DatabaseMetaData, String, SchemaSettings)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SchemaDomain.SchemaSettings	Specifies the settings used when deriving a domain model from a database schema.

Method Summary

Modifier and Type	Method	Description
static SchemaDomain	schemaDomain(DatabaseMetaData metaData, String schemaName)	Factory method for creating a new SchemaDomain instance.
static SchemaDomain	schemaDomain(DatabaseMetaData metaData, String schemaName, SchemaDomain.SchemaSettings settings)	Factory method for creating a new SchemaDomain instance.
String	tableType(EntityType entityType)

Methods inherited from class is.codion.framework.domain.DomainModel

add, add, add, add, add, addEntities, addEntities, addEntities, addFunctions, addProcedures, addReports, entities, function, functions, procedure, procedures, report, reports, type, validateForeignKeys

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface is.codion.framework.domain.Domain

configure, configure

Method Details

schemaDomain

public static SchemaDomain schemaDomain(DatabaseMetaData metaData,
 String schemaName)

Factory method for creating a new SchemaDomain instance.

Parameters:

metaData - the database metadata

schemaName - the schema name

Returns:

a new SchemaDomain instance

schemaDomain

public static SchemaDomain schemaDomain(DatabaseMetaData metaData,
 String schemaName,
 SchemaDomain.SchemaSettings settings)

Factory method for creating a new SchemaDomain instance.

Parameters:

metaData - the database metadata

schemaName - the schema name

settings - the configuration

Returns:

a new SchemaDomain instance

tableType

public String tableType(EntityType entityType)

Parameters:

entityType - the entity type

Returns:

the table type for the given entity type, table or view