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

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNamedContextNode<Generator>, JpaNode, Model

All Known Subinterfaces:

JavaGenerator, JavaSequenceGenerator, JavaSequenceGenerator2_0, JavaTableGenerator, OrmGenerator, OrmSequenceGenerator, OrmSequenceGenerator2_0, OrmTableGenerator, SequenceGenerator, SequenceGenerator2_0, TableGenerator

public interface Generator
extends JpaNamedContextNode<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:

2.0

Version:

2.2

Field Summary

static int	DEFAULT_ALLOCATION_SIZE
static java.lang.String	DEFAULT_ALLOCATION_SIZE_PROPERTY
static java.lang.String	DEFAULT_INITIAL_VALUE_PROPERTY
static java.lang.Iterable<java.lang.Class<? extends Generator>>	PRECEDENCE_TYPE_LIST TODO bjv remove!
static java.lang.String	SPECIFIED_ALLOCATION_SIZE_PROPERTY
static java.lang.String	SPECIFIED_INITIAL_VALUE_PROPERTY

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

NAME_PROPERTY

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.
java.lang.Integer	getSpecifiedAllocationSize()
java.lang.Integer	getSpecifiedInitialValue()
void	setSpecifiedAllocationSize(java.lang.Integer value)
void	setSpecifiedInitialValue(java.lang.Integer value)

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

duplicates, getName, overrides, setName

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

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, getResourceType, synchronizeWithResourceModel, update

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

getJpaProject, getParent, stateChanged

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

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

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

getAdapter

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

getResource

Field Detail

PRECEDENCE_TYPE_LIST

static final java.lang.Iterable<java.lang.Class<? extends Generator>> PRECEDENCE_TYPE_LIST

TODO bjv remove!

SPECIFIED_INITIAL_VALUE_PROPERTY

static final java.lang.String SPECIFIED_INITIAL_VALUE_PROPERTY

See Also:

Constant Field Values

DEFAULT_INITIAL_VALUE_PROPERTY

static final java.lang.String DEFAULT_INITIAL_VALUE_PROPERTY

See Also:

Constant Field Values

SPECIFIED_ALLOCATION_SIZE_PROPERTY

static final java.lang.String SPECIFIED_ALLOCATION_SIZE_PROPERTY

See Also:

Constant Field Values

DEFAULT_ALLOCATION_SIZE_PROPERTY

static final java.lang.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

java.lang.Integer getSpecifiedInitialValue()

setSpecifiedInitialValue

void setSpecifiedInitialValue(java.lang.Integer value)

getDefaultInitialValue

int getDefaultInitialValue()

getAllocationSize

int getAllocationSize()

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

getSpecifiedAllocationSize

java.lang.Integer getSpecifiedAllocationSize()

setSpecifiedAllocationSize

void setSpecifiedAllocationSize(java.lang.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.