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

All Superinterfaces:

Entity, org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, Model, OrmTypeMapping, TypeMapping, XmlContextNode

All Known Subinterfaces:

OrmEclipseLinkEntity

public interface OrmEntity
extends Entity, OrmTypeMapping

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

Version:

2.3

Field Summary

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

CLASS_PROPERTY, OVERRIDE_METADATA_COMPLETE_PROPERTY, SPECIFIED_METADATA_COMPLETE_PROPERTY

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.
java.util.ListIterator<ReadOnlyPrimaryKeyJoinColumn>	defaultPrimaryKeyJoinColumns()
OrmAssociationOverrideContainer	getAssociationOverrideContainer()
OrmAttributeOverrideContainer	getAttributeOverrideContainer()
OrmDiscriminatorColumn	getDiscriminatorColumn()
OrmGeneratorContainer	getGeneratorContainer()
OrmIdClassReference	getIdClassReference() Return the (aggregate) class reference for configuring and validating id class
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.
OrmQueryContainer	getQueryContainer()
OrmTable	getTable() Return the table for this entity, either specified or default.
XmlEntity	getXmlTypeMapping()
java.util.ListIterator<ReadOnlyPrimaryKeyJoinColumn>	primaryKeyJoinColumns()
java.util.ListIterator<ReadOnlySecondaryTable>	secondaryTables() Return the secondary tables whether specified or default.
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.
java.util.ListIterator<OrmPrimaryKeyJoinColumn>	specifiedPrimaryKeyJoinColumns()
java.util.ListIterator<OrmSecondaryTable>	specifiedSecondaryTables() Return a list iterator of the specified secondary tables.
java.util.ListIterator<OrmVirtualSecondaryTable>	virtualSecondaryTables() Return the virtual (not specified) secondary tables.
int	virtualSecondaryTablesSize() Return the number of virtual secondary tables.

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

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

addXmlTypeMappingTo, containsOffset, createDeleteEdit, createMoveTypeEdits, createRenamePackageEdits, createRenameTypeEdits, getAttributesTextRange, getClass_, getClassTextRange, getPersistentType, getSelectionTextRange, getSpecifiedMetadataComplete, getXmlSequence, initializeFrom, isMetadataComplete, isOverrideMetadataComplete, removeXmlTypeMappingFrom, setClass, setSpecifiedMetadataComplete

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

allAssociatedTableNames, allAssociatedTables, allAttributeMappings, allOverridableAssociationNames, allOverridableAttributeNames, associatedTables, attributeMappingKeyAllowed, attributeMappings, getAllAttributeMappings, getAttributeMappings, 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.XmlContextNode

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

VIRTUAL_SECONDARY_TABLES_LIST

static final java.lang.String VIRTUAL_SECONDARY_TABLES_LIST

See Also:

Constant Field Values

DEFAULT_PRIMARY_KEY_JOIN_COLUMNS_LIST

static final java.lang.String DEFAULT_PRIMARY_KEY_JOIN_COLUMNS_LIST

See Also:

Constant Field Values

Method Detail

getXmlTypeMapping

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

getIdClassReference

OrmIdClassReference getIdClassReference()

Description copied from interface: Entity

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

Specified by:

getIdClassReference in interface Entity

getDiscriminatorColumn

OrmDiscriminatorColumn getDiscriminatorColumn()

Specified by:

getDiscriminatorColumn in interface Entity

secondaryTables

java.util.ListIterator<ReadOnlySecondaryTable> secondaryTables()

Description copied from interface: Entity

Return the secondary tables whether specified or default.

Specified by:

secondaryTables in interface Entity

specifiedSecondaryTables

java.util.ListIterator<OrmSecondaryTable> 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

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

virtualSecondaryTables

java.util.ListIterator<OrmVirtualSecondaryTable> virtualSecondaryTables()

Return the virtual (not specified) secondary tables.

virtualSecondaryTablesSize

int virtualSecondaryTablesSize()

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.

primaryKeyJoinColumns

java.util.ListIterator<ReadOnlyPrimaryKeyJoinColumn> primaryKeyJoinColumns()

Specified by:

primaryKeyJoinColumns in interface Entity

specifiedPrimaryKeyJoinColumns

java.util.ListIterator<OrmPrimaryKeyJoinColumn> specifiedPrimaryKeyJoinColumns()

Specified by:

specifiedPrimaryKeyJoinColumns in interface Entity

addSpecifiedPrimaryKeyJoinColumn

OrmPrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn()

Specified by:

addSpecifiedPrimaryKeyJoinColumn in interface Entity

addSpecifiedPrimaryKeyJoinColumn

OrmPrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn(int index)

Specified by:

addSpecifiedPrimaryKeyJoinColumn in interface Entity

defaultPrimaryKeyJoinColumns

java.util.ListIterator<ReadOnlyPrimaryKeyJoinColumn> defaultPrimaryKeyJoinColumns()

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