org.eclipse.jpt.jpa.core.context.java
Interface JavaEntity

All Superinterfaces:

Entity, org.eclipse.core.runtime.IAdaptable, IResourcePart, JavaJpaContextNode, JavaTypeMapping, JpaContextNode, JpaNode, Model, TypeMapping

All Known Subinterfaces:

JavaEclipseLinkEntity

public interface JavaEntity
extends Entity, JavaTypeMapping

Java entity

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.3

Field Summary

static java.lang.String

DEFAULT_PRIMARY_KEY_JOIN_COLUMN_PROPERTY

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

DEFAULT_DISCRIMINATOR_VALUE_PROPERTY, DEFAULT_INHERITANCE_STRATEGY_PROPERTY, DEFAULT_NAME_PROPERTY, DESCENDANTS_COLLECTION, DISCRIMINATOR_COLUMN_IS_UNDEFINED_PROPERTY, DISCRIMINATOR_VALUE_IS_UNDEFINED_PROPERTY, ROOT_ENTITY_PROPERTY, SPECIFIED_DISCRIMINATOR_COLUMN_IS_ALLOWED_PROPERTY, SPECIFIED_DISCRIMINATOR_VALUE_IS_ALLOWED_PROPERTY, SPECIFIED_DISCRIMINATOR_VALUE_PROPERTY, SPECIFIED_INHERITANCE_STRATEGY_PROPERTY, SPECIFIED_NAME_PROPERTY, SPECIFIED_PRIMARY_KEY_JOIN_COLUMNS_LIST, SPECIFIED_SECONDARY_TABLES_LIST, SPECIFIED_TABLE_IS_ALLOWED_PROPERTY, TABLE_IS_UNDEFINED_PROPERTY

Method Summary

JavaPrimaryKeyJoinColumn	addSpecifiedPrimaryKeyJoinColumn(int index)
JavaSecondaryTable	addSpecifiedSecondaryTable() Add a specified secondary table to the entity return the object representing it.
JavaSecondaryTable	addSpecifiedSecondaryTable(int index) Add a specified secondary table to the entity return the object representing it.
JavaAssociationOverrideContainer	getAssociationOverrideContainer()
JavaAttributeOverrideContainer	getAttributeOverrideContainer()
JavaPrimaryKeyJoinColumn	getDefaultPrimaryKeyJoinColumn()
JavaDiscriminatorColumn	getDiscriminatorColumn()
JavaGeneratorContainer	getGeneratorContainer()
JavaIdClassReference	getIdClassReference() Return the (aggregate) class reference for configuring and validating id class
EntityAnnotation	getMappingAnnotation()
JavaQueryContainer	getQueryContainer()
JavaTable	getTable() Return the table for this entity, either specified or default.
java.util.ListIterator<JavaPrimaryKeyJoinColumn>	primaryKeyJoinColumns()
java.util.ListIterator<JavaSecondaryTable>	secondaryTables() Return the secondary tables whether specified or default.
java.util.ListIterator<JavaPrimaryKeyJoinColumn>	specifiedPrimaryKeyJoinColumns()
java.util.ListIterator<JavaSecondaryTable>	specifiedSecondaryTables() Return a list iterator of the specified secondary tables.

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

addSpecifiedPrimaryKeyJoinColumn, discriminatorColumnIsUndefined, discriminatorValueIsUndefined, getDefaultCatalog, getDefaultDiscriminatorValue, getDefaultInheritanceStrategy, getDefaultName, getDefaultSchema, getDefaultTableName, getDescendants, getDiscriminatorValue, getIdAttribute, getInheritanceStrategy, getParentEntity, getPrimaryKeyColumnName, getRootEntity, getSpecifiedDiscriminatorValue, getSpecifiedInheritanceStrategy, getSpecifiedName, isRoot, moveSpecifiedPrimaryKeyJoinColumn, moveSpecifiedSecondaryTable, primaryKeyJoinColumnsSize, removeSpecifiedPrimaryKeyJoinColumn, removeSpecifiedPrimaryKeyJoinColumn, removeSpecifiedSecondaryTable, removeSpecifiedSecondaryTable, resolveAttributeMapping, secondaryTablesSize, setSpecifiedDiscriminatorValue, setSpecifiedInheritanceStrategy, setSpecifiedName, specifiedDiscriminatorColumnIsAllowed, specifiedDiscriminatorValueIsAllowed, specifiedPrimaryKeyJoinColumnsSize, specifiedSecondaryTablesSize, specifiedTableIsAllowed, tableIsUndefined

Methods inherited from interface org.eclipse.jpt.jpa.core.context.java.JavaTypeMapping

attributeMappings, getAttributeMappings, getPersistentType, getResourcePersistentType

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

allAssociatedTableNames, allAssociatedTables, allAttributeMappings, allOverridableAssociationNames, allOverridableAttributeNames, associatedTables, attributeMappingKeyAllowed, getAllAttributeMappings, getDbSchema, getIdClass, getKey, getName, getPrimaryDbTable, getPrimaryTableName, getSuperTypeMapping, inheritanceHierarchy, isMapped, overridableAssociationNames, overridableAttributeNames, resolveDbTable, resolveOverriddenColumn, resolveOverriddenRelationship, tableNameIsInvalid, validatesAgainstDatabase

Methods inherited from interface org.eclipse.jpt.jpa.core.context.java.JavaJpaContextNode

getValidationTextRange, javaCompletionProposals, validate

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

DEFAULT_PRIMARY_KEY_JOIN_COLUMN_PROPERTY

static final java.lang.String DEFAULT_PRIMARY_KEY_JOIN_COLUMN_PROPERTY

See Also:

Constant Field Values

Method Detail

getMappingAnnotation

EntityAnnotation getMappingAnnotation()

Specified by:

getMappingAnnotation in interface JavaTypeMapping

getTable

JavaTable getTable()

Description copied from interface: Entity

Return the table for this entity, either specified or default. This will not be null.

Specified by:

getTable in interface Entity

getIdClassReference

JavaIdClassReference getIdClassReference()

Description copied from interface: Entity

Return the (aggregate) class reference for configuring and validating id class

Specified by:

getIdClassReference in interface Entity

getDiscriminatorColumn

JavaDiscriminatorColumn getDiscriminatorColumn()

Specified by:

getDiscriminatorColumn in interface Entity

secondaryTables

java.util.ListIterator<JavaSecondaryTable> secondaryTables()

Description copied from interface: Entity

Return the secondary tables whether specified or default.

Specified by:

secondaryTables in interface Entity

specifiedSecondaryTables

java.util.ListIterator<JavaSecondaryTable> specifiedSecondaryTables()

Description copied from interface: Entity

Return a list iterator of the specified secondary tables. This will not be null.

Specified by:

specifiedSecondaryTables in interface Entity

addSpecifiedSecondaryTable

JavaSecondaryTable addSpecifiedSecondaryTable()

Description copied from interface: Entity

Add a specified secondary table to the entity return the object representing it.

Specified by:

addSpecifiedSecondaryTable in interface Entity

addSpecifiedSecondaryTable

JavaSecondaryTable addSpecifiedSecondaryTable(int index)

Description copied from interface: Entity

Add a specified secondary table to the entity return the object representing it.

Specified by:

addSpecifiedSecondaryTable in interface Entity

primaryKeyJoinColumns

java.util.ListIterator<JavaPrimaryKeyJoinColumn> primaryKeyJoinColumns()

Specified by:

primaryKeyJoinColumns in interface Entity

specifiedPrimaryKeyJoinColumns

java.util.ListIterator<JavaPrimaryKeyJoinColumn> specifiedPrimaryKeyJoinColumns()

Specified by:

specifiedPrimaryKeyJoinColumns in interface Entity

addSpecifiedPrimaryKeyJoinColumn

JavaPrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn(int index)

Specified by:

addSpecifiedPrimaryKeyJoinColumn in interface Entity

getDefaultPrimaryKeyJoinColumn

JavaPrimaryKeyJoinColumn getDefaultPrimaryKeyJoinColumn()

getAttributeOverrideContainer

JavaAttributeOverrideContainer getAttributeOverrideContainer()

Specified by:

getAttributeOverrideContainer in interface Entity

getAssociationOverrideContainer

JavaAssociationOverrideContainer getAssociationOverrideContainer()

Specified by:

getAssociationOverrideContainer in interface Entity

getQueryContainer

JavaQueryContainer getQueryContainer()

Specified by:

getQueryContainer in interface Entity

getGeneratorContainer

JavaGeneratorContainer getGeneratorContainer()

Specified by:

getGeneratorContainer in interface Entity