org.eclipse.jpt.core.context
Interface Generator

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, Model

All Known Subinterfaces:

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

public interface Generator
extends JpaContextNode

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.String	NAME_PROPERTY
static java.lang.String	SEQUENCE_GENERATOR
static java.lang.String	SPECIFIED_ALLOCATION_SIZE_PROPERTY
static java.lang.String	SPECIFIED_INITIAL_VALUE_PROPERTY
static java.lang.String	TABLE_GENERATOR

Method Summary

boolean	duplicates(Generator generator) Return whether the generator is a duplicate of the given generator.
int	getAllocationSize()
Catalog	getDbCatalog() Return a db Catalog object with the specified/default catalog name.
Schema	getDbSchema() Return a db Schema object with the specified/default schema name.
SchemaContainer	getDbSchemaContainer() Return a db container object that hold the relevant schemata.
int	getDefaultAllocationSize()
int	getDefaultInitialValue()
int	getInitialValue()
java.lang.String	getName()
java.lang.Integer	getSpecifiedAllocationSize()
java.lang.Integer	getSpecifiedInitialValue()
boolean	isVirtual()
boolean	overrides(Generator generator) Return whether the generator overrides the definition of the given generator (e.g.
void	setName(java.lang.String value)
void	setSpecifiedAllocationSize(java.lang.Integer value)
void	setSpecifiedInitialValue(java.lang.Integer value)

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

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, getResourceType, postUpdate

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

getJpaProject, getParent

Methods inherited from interface org.eclipse.jpt.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.core.IResourcePart

getResource

Field Detail

SEQUENCE_GENERATOR

static final java.lang.String SEQUENCE_GENERATOR

See Also:

Constant Field Values

TABLE_GENERATOR

static final java.lang.String TABLE_GENERATOR

See Also:

Constant Field Values

NAME_PROPERTY

static final java.lang.String NAME_PROPERTY

See Also:

Constant Field Values

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

static final int DEFAULT_ALLOCATION_SIZE

See Also:

Constant Field Values

DEFAULT_ALLOCATION_SIZE_PROPERTY

static final java.lang.String DEFAULT_ALLOCATION_SIZE_PROPERTY

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

setName

void setName(java.lang.String value)

getInitialValue

int getInitialValue()

getSpecifiedInitialValue

java.lang.Integer getSpecifiedInitialValue()

setSpecifiedInitialValue

void setSpecifiedInitialValue(java.lang.Integer value)

getDefaultInitialValue

int getDefaultInitialValue()

getAllocationSize

int getAllocationSize()

getSpecifiedAllocationSize

java.lang.Integer getSpecifiedAllocationSize()

setSpecifiedAllocationSize

void setSpecifiedAllocationSize(java.lang.Integer value)

getDefaultAllocationSize

int getDefaultAllocationSize()

overrides

boolean overrides(Generator generator)

Return whether the generator overrides the definition of the given generator (e.g. a generator defined in orm.xml overrides one defined in java).

duplicates

boolean duplicates(Generator generator)

Return whether the generator is a duplicate of the given generator. A generator is not a duplicate of another generator if is the same exact generator, if it is a nameless generator (which is an error condition), or if it overrides or is overridden by the other generator.

isVirtual

boolean isVirtual()

getDbSchema

Schema getDbSchema()

Return a db Schema object with the specified/default schema name. This can return null if no Schema exists on the database with that name.

getDbCatalog

Catalog getDbCatalog()

Return a db Catalog object with the specified/default catalog name. This can return null if no Catalog exists on the database with that name.

getDbSchemaContainer

SchemaContainer getDbSchemaContainer()

Return a db container object that hold the relevant schemata.