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

All Superinterfaces:

Entity, IAdaptable, IdTypeMapping, JavaIdTypeMapping, JavaTypeMapping, JpaContextModel, JpaModel, JptResourceTypeReference, Model, TypeMapping

All Known Subinterfaces:

EclipseLinkJavaEntity, JavaEntity2_0

public interface JavaEntity
extends Entity, JavaIdTypeMapping

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

Nested Class Summary

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

Entity.IsDescendant

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

IdTypeMapping.SuperTypeMappingTransformer

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

TypeMapping.GeneratorsTransformer, TypeMapping.MappingIsIdMapping, TypeMapping.PersistentTypeTransformer, TypeMapping.QueriesTransformer

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

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

GENERATORS_TRANSFORMER, ID_ATTRIBUTE_MAPPING_KEYS, PERSISTENT_TYPE_TRANSFORMER, QUERIES_TRANSFORMER, SUPER_TYPE_MAPPING_PROPERTY

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

TRANSFORMER

Method Summary

JavaSpecifiedPrimaryKeyJoinColumn	addSpecifiedPrimaryKeyJoinColumn(int index)
JavaSpecifiedSecondaryTable	addSpecifiedSecondaryTable() Add a specified secondary table to the entity return the object representing it.
JavaSpecifiedSecondaryTable	addSpecifiedSecondaryTable(int index) Add a specified secondary table to the entity return the object representing it.
JavaAssociationOverrideContainer	getAssociationOverrideContainer()
JavaAttributeOverrideContainer	getAttributeOverrideContainer()
JavaSpecifiedPrimaryKeyJoinColumn	getDefaultPrimaryKeyJoinColumn()
JavaSpecifiedDiscriminatorColumn	getDiscriminatorColumn()
JavaGeneratorContainer	getGeneratorContainer()
EntityAnnotation	getMappingAnnotation()
org.eclipse.jpt.common.utility.iterable.ListIterable<JavaSpecifiedPrimaryKeyJoinColumn>	getPrimaryKeyJoinColumns()
JavaQueryContainer	getQueryContainer()
org.eclipse.jpt.common.utility.iterable.ListIterable<JavaSpecifiedSecondaryTable>	getSecondaryTables() Return the secondary tables whether specified or default.
org.eclipse.jpt.common.utility.iterable.ListIterable<JavaSpecifiedPrimaryKeyJoinColumn>	getSpecifiedPrimaryKeyJoinColumns()
org.eclipse.jpt.common.utility.iterable.ListIterable<JavaSpecifiedSecondaryTable>	getSpecifiedSecondaryTables() Return a list iterator of the specified secondary tables.
JavaSpecifiedTable	getTable() Return the entity's table, either specified or default.

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

addSpecifiedPrimaryKeyJoinColumn, clearSpecifiedPrimaryKeyJoinColumns, convertDefaultPrimaryKeyJoinColumnsToSpecified, discriminatorColumnIsUndefined, discriminatorValueIsUndefined, getDefaultCatalog, getDefaultDiscriminatorValue, getDefaultInheritanceStrategy, getDefaultName, getDefaultSchema, getDefaultTableName, getDescendants, getDiscriminatorValue, getIdAttribute, getInheritanceStrategy, getNameTextRange, getParentEntity, getPrimaryKeyColumnName, getPrimaryKeyJoinColumnsSize, getRootEntity, getSecondaryTablesSize, getSpecifiedDiscriminatorValue, getSpecifiedInheritanceStrategy, getSpecifiedName, getSpecifiedPrimaryKeyJoinColumn, getSpecifiedPrimaryKeyJoinColumnsSize, getSpecifiedSecondaryTablesSize, moveSpecifiedPrimaryKeyJoinColumn, moveSpecifiedSecondaryTable, removeSpecifiedPrimaryKeyJoinColumn, removeSpecifiedPrimaryKeyJoinColumn, removeSpecifiedSecondaryTable, removeSpecifiedSecondaryTable, resolveAttributeMapping, setSpecifiedDiscriminatorValue, setSpecifiedInheritanceStrategy, setSpecifiedName, specifiedDiscriminatorColumnIsAllowed, specifiedDiscriminatorValueIsAllowed, specifiedTableIsAllowed, supportsValidationMessages, tableIsUndefined

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

getIdClassReference

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

getAttributeMappings, getAttributeMappings, getPersistentType

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

getInheritanceHierarchy, getPrimaryKeyClassName, isRootEntity

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

attributeIsDerivedId, attributeMappingKeyAllowed, getAllAssociatedTableNames, getAllAssociatedTables, getAllAttributeMappings, getAllAttributeMappings, getAllOverridableAssociationNames, getAllOverridableAttributeNames, getAncestors, getAssociatedTables, getDbSchema, getGenerators, getIdAttributeMapping, getIdAttributeMappings, getJavaResourceType, getKey, getName, getNonTransientAttributeMappings, getOverridableAssociationNames, getOverridableAttributeNames, getPrimaryDbTable, getPrimaryTableName, getQueries, getSuperTypeMapping, isMapped, resolveDbTable, resolveOverriddenColumn, resolveOverriddenRelationship, tableNameIsInvalid, validatesAgainstDatabase

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

DEFAULT_PRIMARY_KEY_JOIN_COLUMN_PROPERTY

static final String DEFAULT_PRIMARY_KEY_JOIN_COLUMN_PROPERTY

See Also:

Constant Field Values

Method Detail

getMappingAnnotation

EntityAnnotation getMappingAnnotation()

Specified by:

getMappingAnnotation in interface JavaTypeMapping

getTable

JavaSpecifiedTable getTable()

Description copied from interface: Entity

Return the entity's table, either specified or default. This will not be null.

Specified by:

getTable in interface Entity

See Also:

SpecifiedTable.isSpecifiedInResource()

getDiscriminatorColumn

JavaSpecifiedDiscriminatorColumn getDiscriminatorColumn()

Specified by:

getDiscriminatorColumn in interface Entity

getSecondaryTables

org.eclipse.jpt.common.utility.iterable.ListIterable<JavaSpecifiedSecondaryTable> getSecondaryTables()

Description copied from interface: Entity

Return the secondary tables whether specified or default.

Specified by:

getSecondaryTables in interface Entity

getSpecifiedSecondaryTables

org.eclipse.jpt.common.utility.iterable.ListIterable<JavaSpecifiedSecondaryTable> getSpecifiedSecondaryTables()

Description copied from interface: Entity

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

Specified by:

getSpecifiedSecondaryTables in interface Entity

addSpecifiedSecondaryTable

JavaSpecifiedSecondaryTable 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

JavaSpecifiedSecondaryTable 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

getPrimaryKeyJoinColumns

org.eclipse.jpt.common.utility.iterable.ListIterable<JavaSpecifiedPrimaryKeyJoinColumn> getPrimaryKeyJoinColumns()

Specified by:

getPrimaryKeyJoinColumns in interface Entity

getSpecifiedPrimaryKeyJoinColumns

org.eclipse.jpt.common.utility.iterable.ListIterable<JavaSpecifiedPrimaryKeyJoinColumn> getSpecifiedPrimaryKeyJoinColumns()

Specified by:

getSpecifiedPrimaryKeyJoinColumns in interface Entity

addSpecifiedPrimaryKeyJoinColumn

JavaSpecifiedPrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn(int index)

Specified by:

addSpecifiedPrimaryKeyJoinColumn in interface Entity

getDefaultPrimaryKeyJoinColumn

JavaSpecifiedPrimaryKeyJoinColumn 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