org.eclipse.jpt.jpa.core.context
Interface DbGenerator

All Superinterfaces:

Generator, IAdaptable, JpaContextModel, JpaModel, JpaNamedContextModel, JptResourceTypeReference, Model

All Known Subinterfaces:

JavaDbGenerator, JavaSequenceGenerator, JavaSequenceGenerator2_0, JavaTableGenerator, OrmSequenceGenerator, OrmSequenceGenerator2_0, OrmTableGenerator, SequenceGenerator, SequenceGenerator2_0, TableGenerator

public interface DbGenerator
extends Generator

Sequence and table generators.

Sequences can be defined on

• Java and orm.xml entities
• Java and orm.xml ID mappings
• orm.xml entity mappings elements

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Since:

3.3

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.context.JpaNamedContextModel

JpaNamedContextModel.NameTransformer

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.JpaModel

JpaModel.JpaVersionIsCompatibleWith

Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

JptResourceTypeReference.ResourceTypeIsKindOf, JptResourceTypeReference.ResourceTypeTransformer

Field Summary

static int	DEFAULT_ALLOCATION_SIZE
static String	DEFAULT_ALLOCATION_SIZE_PROPERTY
static String	DEFAULT_INITIAL_VALUE_PROPERTY
static String	SPECIFIED_ALLOCATION_SIZE_PROPERTY
static String	SPECIFIED_INITIAL_VALUE_PROPERTY

Fields inherited from interface org.eclipse.jpt.jpa.core.context.Generator

TYPES

Fields inherited from interface org.eclipse.jpt.jpa.core.context.JpaNamedContextModel

NAME_PROPERTY, NAME_TRANSFORMER

Fields inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

TRANSFORMER

Method Summary

int	getAllocationSize() Return the specified allocation size if present, otherwise return the default allocation size.
Catalog	getDbCatalog() Return the generator's database catalog.
Schema	getDbSchema() Return the generator's database schema.
SchemaContainer	getDbSchemaContainer() Return the schema container that holds the relevant schemata.
int	getDefaultAllocationSize()
int	getDefaultInitialValue()
int	getInitialValue() Return the specified initial value if present, otherwise return the default initial value.
Integer	getSpecifiedAllocationSize()
Integer	getSpecifiedInitialValue()
void	setSpecifiedAllocationSize(Integer value)
void	setSpecifiedInitialValue(Integer value)

Methods inherited from interface org.eclipse.jpt.jpa.core.context.Generator

getNameTextRange, getType, supportsValidationMessages

Methods inherited from interface org.eclipse.jpt.jpa.core.context.JpaNamedContextModel

getName, isEquivalentTo, setName

Methods inherited from interface org.eclipse.jpt.jpa.core.context.JpaContextModel

getCompletionProposals, getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getParent, getPersistenceUnit, getValidationTextRange, synchronizeWithResourceModel, update, validate

Methods inherited from interface org.eclipse.jpt.jpa.core.JpaModel

getJpaPlatform, getJpaProject, getJpaProjectManager, getResource, stateChanged

Methods inherited from interface org.eclipse.jpt.common.utility.model.Model

addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

getResourceType

Field Detail

SPECIFIED_INITIAL_VALUE_PROPERTY

static final String SPECIFIED_INITIAL_VALUE_PROPERTY

See Also:

Constant Field Values

DEFAULT_INITIAL_VALUE_PROPERTY

static final String DEFAULT_INITIAL_VALUE_PROPERTY

See Also:

Constant Field Values

SPECIFIED_ALLOCATION_SIZE_PROPERTY

static final String SPECIFIED_ALLOCATION_SIZE_PROPERTY

See Also:

Constant Field Values

DEFAULT_ALLOCATION_SIZE_PROPERTY

static final String DEFAULT_ALLOCATION_SIZE_PROPERTY

See Also:

Constant Field Values

DEFAULT_ALLOCATION_SIZE

static final int DEFAULT_ALLOCATION_SIZE

See Also:

Constant Field Values

Method Detail

getInitialValue

int getInitialValue()

Return the specified initial value if present, otherwise return the default initial value.

getSpecifiedInitialValue

Integer getSpecifiedInitialValue()

setSpecifiedInitialValue

void setSpecifiedInitialValue(Integer value)

getDefaultInitialValue

int getDefaultInitialValue()

getAllocationSize

int getAllocationSize()

Return the specified allocation size if present, otherwise return the default allocation size.

getSpecifiedAllocationSize

Integer getSpecifiedAllocationSize()

setSpecifiedAllocationSize

void setSpecifiedAllocationSize(Integer value)

getDefaultAllocationSize

int getDefaultAllocationSize()

getDbSchemaContainer

SchemaContainer getDbSchemaContainer()

Return the schema container that holds the relevant schemata.

getDbCatalog

Catalog getDbCatalog()

Return the generator's database catalog. Return null if the generator's catalog (name) is invalid.

getDbSchema

Schema getDbSchema()

Return the generator's database schema. Return null if the generator's schema (name) is invalid.