org.eclipse.jpt.jpa.core.context.orm
Interface OrmEntity

All Superinterfaces:

Entity, IAdaptable, IdTypeMapping, JpaContextNode, JpaNode, JptResourceTypeReference, Model, OrmIdTypeMapping, OrmTypeMapping, TypeMapping, TypeRefactoringParticipant

All Known Subinterfaces:

OrmEclipseLinkEntity, OrmEntity2_0

public interface OrmEntity
extends Entity, OrmIdTypeMapping

orm.xml 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.EntityIsDescendant

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

TypeRefactoringParticipant.MoveTypeEditsTransformer, TypeRefactoringParticipant.RenamePackageEditsTransformer, TypeRefactoringParticipant.RenameTypeEditsTransformer

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

TypeMapping.GeneratorsTransformer, TypeMapping.QueriesTransformer

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

JptResourceTypeReference.ResourceTypeTransformer

Field Summary

static String	DEFAULT_PRIMARY_KEY_JOIN_COLUMNS_LIST
static String	VIRTUAL_SECONDARY_TABLES_LIST

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.orm.OrmTypeMapping

DEFAULT_PARENT_CLASS_PROPERTY, FULLY_QUALIFIED_PARENT_CLASS_PROPERTY, OVERRIDE_METADATA_COMPLETE_PROPERTY, SPECIFIED_METADATA_COMPLETE_PROPERTY, SPECIFIED_PARENT_CLASS_PROPERTY

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

GENERATORS_TRANSFORMER, QUERIES_TRANSFORMER

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

RESOURCE_TYPE_TRANSFORMER

Method Summary

OrmPrimaryKeyJoinColumn	addSpecifiedPrimaryKeyJoinColumn()
OrmPrimaryKeyJoinColumn	addSpecifiedPrimaryKeyJoinColumn(int index)
OrmSecondaryTable	addSpecifiedSecondaryTable() Add a specified secondary table to the entity return the object representing it.
OrmSecondaryTable	addSpecifiedSecondaryTable(int index) Add a specified secondary table to the entity return the object representing it.
OrmAssociationOverrideContainer	getAssociationOverrideContainer()
OrmAttributeOverrideContainer	getAttributeOverrideContainer()
org.eclipse.jpt.common.utility.iterable.ListIterable<ReadOnlyPrimaryKeyJoinColumn>	getDefaultPrimaryKeyJoinColumns()
int	getDefaultPrimaryKeyJoinColumnsSize()
OrmDiscriminatorColumn	getDiscriminatorColumn()
OrmGeneratorContainer	getGeneratorContainer()
JavaEntity	getJavaTypeMapping() Return the Java type mapping corresponding to the orm.xml type mapping.
JavaEntity	getJavaTypeMappingForDefaults() Check "metadata complete" before returning the Java type mapping.
org.eclipse.jpt.common.utility.iterable.ListIterable<ReadOnlyPrimaryKeyJoinColumn>	getPrimaryKeyJoinColumns()
OrmQueryContainer	getQueryContainer()
org.eclipse.jpt.common.utility.iterable.ListIterable<ReadOnlySecondaryTable>	getSecondaryTables() Return the secondary tables whether specified or default.
org.eclipse.jpt.common.utility.iterable.ListIterable<OrmPrimaryKeyJoinColumn>	getSpecifiedPrimaryKeyJoinColumns()
org.eclipse.jpt.common.utility.iterable.ListIterable<OrmSecondaryTable>	getSpecifiedSecondaryTables() Return a list iterator of the specified secondary tables.
OrmTable	getTable() Return the table for this entity, either specified or default.
org.eclipse.jpt.common.utility.iterable.ListIterable<OrmVirtualSecondaryTable>	getVirtualSecondaryTables() Return the virtual (not specified) secondary tables.
int	getVirtualSecondaryTablesSize() Return the number of virtual secondary tables.
org.eclipse.jpt.jpa.core.resource.orm.XmlEntity	getXmlTypeMapping()
boolean	secondaryTablesAreDefinedInXml() Return true if there are no virtual secondary tables on the orm entity.
void	setSecondaryTablesAreDefinedInXml(boolean defineInXml) If true, then all virtual secondary tables are added in as specified secondary tables to the xml.

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

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.orm.OrmIdTypeMapping

getIdClassReference

Methods inherited from interface org.eclipse.jpt.jpa.core.context.orm.OrmTypeMapping

addXmlTypeMappingTo, getAttributesTextRange, getDefaultParentClass, getFullyQualifiedParentClass, getParentClass, getPersistentType, getSelectionTextRange, getSpecifiedMetadataComplete, getSpecifiedParentClass, getXmlSequence, initializeFrom, isMetadataComplete, isOverrideMetadataComplete, removeXmlTypeMappingFrom, setSpecifiedMetadataComplete, setSpecifiedParentClass

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

createMoveTypeEdits, createRenamePackageEdits, createRenameTypeEdits

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

attributeIsDerivedId, attributeMappingKeyAllowed, getAllAssociatedTableNames, getAllAssociatedTables, getAllAttributeMappings, getAllAttributeMappings, getAllOverridableAssociationNames, getAllOverridableAttributeNames, getAssociatedTables, getAttributeMappings, getAttributeMappings, getDbSchema, getGenerators, getIdClass, getInheritanceHierarchy, getJavaResourceType, getKey, getName, getNonTransientAttributeMappings, getOverridableAssociationNames, getOverridableAttributeNames, getPrimaryDbTable, getPrimaryTableName, getQueries, getSuperTypeMapping, isMapped, isRootEntity, resolveDbTable, resolveOverriddenColumn, resolveOverriddenRelationship, tableNameIsInvalid, validatesAgainstDatabase

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

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

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

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

VIRTUAL_SECONDARY_TABLES_LIST

static final String VIRTUAL_SECONDARY_TABLES_LIST

See Also:

Constant Field Values

DEFAULT_PRIMARY_KEY_JOIN_COLUMNS_LIST

static final String DEFAULT_PRIMARY_KEY_JOIN_COLUMNS_LIST

See Also:

Constant Field Values

Method Detail

getXmlTypeMapping

org.eclipse.jpt.jpa.core.resource.orm.XmlEntity getXmlTypeMapping()

Specified by:

getXmlTypeMapping in interface OrmTypeMapping

getJavaTypeMapping

JavaEntity getJavaTypeMapping()

Description copied from interface: OrmTypeMapping

Return the Java type mapping corresponding to the orm.xml type mapping. Return null if there is no such Java type mapping; i.e. it does not exist or it is not the same type of type mapping (entity, mapped superclass, embeddable).

Specified by:

getJavaTypeMapping in interface OrmTypeMapping

See Also:

OrmTypeMapping.getJavaTypeMappingForDefaults()

getJavaTypeMappingForDefaults

JavaEntity getJavaTypeMappingForDefaults()

Description copied from interface: OrmTypeMapping

Check "metadata complete" before returning the Java type mapping. For orm.xml defaults, if "metadata complete" is true, return null.

Specified by:

getJavaTypeMappingForDefaults in interface OrmTypeMapping

See Also:

OrmTypeMapping.getJavaTypeMapping()

getTable

OrmTable 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

getDiscriminatorColumn

OrmDiscriminatorColumn getDiscriminatorColumn()

Specified by:

getDiscriminatorColumn in interface Entity

getSecondaryTables

org.eclipse.jpt.common.utility.iterable.ListIterable<ReadOnlySecondaryTable> 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<OrmSecondaryTable> 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

OrmSecondaryTable 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

OrmSecondaryTable 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

getVirtualSecondaryTables

org.eclipse.jpt.common.utility.iterable.ListIterable<OrmVirtualSecondaryTable> getVirtualSecondaryTables()

Return the virtual (not specified) secondary tables.

getVirtualSecondaryTablesSize

int getVirtualSecondaryTablesSize()

Return the number of virtual secondary tables.

secondaryTablesAreDefinedInXml

boolean secondaryTablesAreDefinedInXml()

Return true if there are no virtual secondary tables on the orm entity. This is used to determine whether you can add specified secondary tables. You must first make sure all virtual secondary tables have been specified in xml before adding more. This is because adding one secondary table to xml will override all the secondary tables specified in the java entity

setSecondaryTablesAreDefinedInXml

void setSecondaryTablesAreDefinedInXml(boolean defineInXml)

If true, then all virtual secondary tables are added in as specified secondary tables to the xml. If false, then all the specified secondary tables are remvoed from the xml.

getPrimaryKeyJoinColumns

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

Specified by:

getPrimaryKeyJoinColumns in interface Entity

getSpecifiedPrimaryKeyJoinColumns

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

Specified by:

getSpecifiedPrimaryKeyJoinColumns in interface Entity

addSpecifiedPrimaryKeyJoinColumn

OrmPrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn()

Specified by:

addSpecifiedPrimaryKeyJoinColumn in interface Entity

addSpecifiedPrimaryKeyJoinColumn

OrmPrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn(int index)

Specified by:

addSpecifiedPrimaryKeyJoinColumn in interface Entity

getDefaultPrimaryKeyJoinColumns

org.eclipse.jpt.common.utility.iterable.ListIterable<ReadOnlyPrimaryKeyJoinColumn> getDefaultPrimaryKeyJoinColumns()

getDefaultPrimaryKeyJoinColumnsSize

int getDefaultPrimaryKeyJoinColumnsSize()

getAttributeOverrideContainer

OrmAttributeOverrideContainer getAttributeOverrideContainer()

Specified by:

getAttributeOverrideContainer in interface Entity

getAssociationOverrideContainer

OrmAssociationOverrideContainer getAssociationOverrideContainer()

Specified by:

getAssociationOverrideContainer in interface Entity

getQueryContainer

OrmQueryContainer getQueryContainer()

Specified by:

getQueryContainer in interface Entity

getGeneratorContainer

OrmGeneratorContainer getGeneratorContainer()

Specified by:

getGeneratorContainer in interface Entity