org.eclipse.jpt.eclipselink.core.context.java
Interface EclipseLinkJavaEntity

All Superinterfaces:

EclipseLinkEntity, Entity, GeneratorHolder, org.eclipse.core.runtime.IAdaptable, IdClassHolder, IResourcePart, JavaEntity, JavaGeneratorHolder, JavaJpaContextNode, JavaTypeMapping, JpaContextNode, JpaNode, Model, QueryContainer, TypeMapping

public interface EclipseLinkJavaEntity
extends EclipseLinkEntity, JavaEntity

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

Version:

2.1

Field Summary

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

DEFAULT_DISCRIMINATOR_VALUE_PROPERTY, DEFAULT_INHERITANCE_STRATEGY_PROPERTY, DEFAULT_NAME_PROPERTY, DEFAULT_PRIMARY_KEY_JOIN_COLUMN, DISCRIMINATOR_COLUMN_IS_UNDEFINED_PROPERTY, DISCRIMINATOR_VALUE_IS_UNDEFINED_PROPERTY, SPECIFIED_ASSOCIATION_OVERRIDES_LIST, SPECIFIED_ATTRIBUTE_OVERRIDES_LIST, 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, VIRTUAL_ASSOCIATION_OVERRIDES_LIST, VIRTUAL_ATTRIBUTE_OVERRIDES_LIST

Fields inherited from interface org.eclipse.jpt.core.context.GeneratorHolder

SEQUENCE_GENERATOR_PROPERTY, TABLE_GENERATOR_PROPERTY

Fields inherited from interface org.eclipse.jpt.core.context.QueryContainer

NAMED_NATIVE_QUERIES_LIST, NAMED_QUERIES_LIST

Fields inherited from interface org.eclipse.jpt.core.context.IdClassHolder

ID_CLASS_PROPERTY

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

DEFAULT_DISCRIMINATOR_VALUE_PROPERTY, DEFAULT_INHERITANCE_STRATEGY_PROPERTY, DEFAULT_NAME_PROPERTY, DEFAULT_PRIMARY_KEY_JOIN_COLUMN, DISCRIMINATOR_COLUMN_IS_UNDEFINED_PROPERTY, DISCRIMINATOR_VALUE_IS_UNDEFINED_PROPERTY, SPECIFIED_ASSOCIATION_OVERRIDES_LIST, SPECIFIED_ATTRIBUTE_OVERRIDES_LIST, 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, VIRTUAL_ASSOCIATION_OVERRIDES_LIST, VIRTUAL_ATTRIBUTE_OVERRIDES_LIST

Fields inherited from interface org.eclipse.jpt.core.context.GeneratorHolder

SEQUENCE_GENERATOR_PROPERTY, TABLE_GENERATOR_PROPERTY

Fields inherited from interface org.eclipse.jpt.core.context.QueryContainer

NAMED_NATIVE_QUERIES_LIST, NAMED_QUERIES_LIST

Fields inherited from interface org.eclipse.jpt.core.context.IdClassHolder

ID_CLASS_PROPERTY

Fields inherited from interface org.eclipse.jpt.core.context.GeneratorHolder

SEQUENCE_GENERATOR_PROPERTY, TABLE_GENERATOR_PROPERTY

Method Summary

java.util.ListIterator<JavaAssociationOverride>	associationOverrides() Return a list iterator of the association overrides whether specified or default.
java.util.ListIterator<JavaAttributeOverride>	attributeOverrides() Return a list iterator of the attribute overrides whether specified or default.
JavaCaching	getCaching()
JavaConverterHolder	getConverterHolder()
java.util.ListIterator<JavaNamedNativeQuery>	namedNativeQueries() Return a list iterator of the specified named native queries.
java.util.ListIterator<JavaNamedQuery>	namedQueries() Return a list iterator of the named queries.
java.util.ListIterator<JavaPrimaryKeyJoinColumn>	primaryKeyJoinColumns()
java.util.ListIterator<JavaSecondaryTable>	secondaryTables() Return a list iterator of the secondary tables whether specified or default.
java.util.ListIterator<JavaAssociationOverride>	specifiedAssociationOverrides() Return a list iterator of the specified association overrides.
java.util.ListIterator<JavaAttributeOverride>	specifiedAttributeOverrides() Return a list iterator of the specified attribute overrides.
java.util.ListIterator<JavaPrimaryKeyJoinColumn>	specifiedPrimaryKeyJoinColumns()
java.util.ListIterator<JavaSecondaryTable>	specifiedSecondaryTables() Return a list iterator of the specified secondary tables.
java.util.ListIterator<JavaAssociationOverride>	virtualAssociationOverrides() Return the number of default association overrides.
java.util.ListIterator<JavaAttributeOverride>	virtualAttributeOverrides() Return a list iterator of the virtual attribute overrides, those not specified.

Methods inherited from interface org.eclipse.jpt.eclipselink.core.context.EclipseLinkEntity

getChangeTracking, getCustomizer, getReadOnly

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

addSubEntity, associationOverridesSize, attributeOverridesSize, discriminatorColumnIsUndefined, discriminatorValueIsUndefined, getDefaultCatalog, getDefaultDiscriminatorValue, getDefaultInheritanceStrategy, getDefaultName, getDefaultSchema, getDefaultTableName, getDiscriminatorValue, getInheritanceStrategy, getName, getParentEntity, getPrimaryKeyColumnName, getSpecifiedDiscriminatorValue, getSpecifiedInheritanceStrategy, getSpecifiedName, moveSpecifiedAssociationOverride, moveSpecifiedAttributeOverride, moveSpecifiedPrimaryKeyJoinColumn, moveSpecifiedSecondaryTable, primaryKeyJoinColumnsSize, removeSpecifiedPrimaryKeyJoinColumn, removeSpecifiedPrimaryKeyJoinColumn, removeSpecifiedSecondaryTable, removeSpecifiedSecondaryTable, secondaryTablesSize, setSpecifiedDiscriminatorValue, setSpecifiedInheritanceStrategy, setSpecifiedName, specifiedAssociationOverridesSize, specifiedAttributeOverridesSize, specifiedDiscriminatorColumnIsAllowed, specifiedDiscriminatorValueIsAllowed, specifiedPrimaryKeyJoinColumnsSize, specifiedSecondaryTablesSize, specifiedTableIsAllowed, tableIsUndefined, virtualAssociationOverridesSize, virtualAttributeOverridesSize

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

allOverridableAssociationNames, allOverridableAssociations, allOverridableAttributeNames, allOverridableAttributes, associatedTableNamesIncludingInherited, associatedTables, associatedTablesIncludingInherited, attributeMappingKeyAllowed, getDbSchema, getDbTable, getKey, getPrimaryDbTable, getPrimaryTableName, isMapped, overridableAssociationNames, overridableAttributeNames, shouldValidateAgainstDatabase, tableNameIsInvalid

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

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, postUpdate

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

removeSequenceGenerator, removeTableGenerator

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

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, postUpdate

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

moveNamedNativeQuery, moveNamedQuery, namedNativeQueriesSize, namedQueriesSize, removeNamedNativeQuery, removeNamedNativeQuery, removeNamedQuery, removeNamedQuery

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

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, postUpdate

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

getIdClass, getIdClassEnclosingTypeSeparator, setIdClass

Methods inherited from interface org.eclipse.jpt.core.context.java.JavaEntity

addNamedNativeQuery, addNamedQuery, addSpecifiedPrimaryKeyJoinColumn, addSpecifiedSecondaryTable, addSpecifiedSecondaryTable, getAttributeOverrideNamed, getDefaultPrimaryKeyJoinColumn, getDiscriminatorColumn, getTable, overridableAssociations, overridableAttributes

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

correspondingAnnotationNames, getAnnotationName, getPersistentType, initialize, update

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

allOverridableAssociationNames, allOverridableAssociations, allOverridableAttributeNames, allOverridableAttributes, associatedTableNamesIncludingInherited, associatedTables, associatedTablesIncludingInherited, attributeMappingKeyAllowed, getDbSchema, getDbTable, getKey, getPrimaryDbTable, getPrimaryTableName, isMapped, overridableAssociationNames, overridableAttributeNames, shouldValidateAgainstDatabase, tableNameIsInvalid

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

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, postUpdate

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

getValidationTextRange, javaCompletionProposals, validate

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

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, postUpdate

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

addSubEntity, associationOverridesSize, attributeOverridesSize, discriminatorColumnIsUndefined, discriminatorValueIsUndefined, getDefaultCatalog, getDefaultDiscriminatorValue, getDefaultInheritanceStrategy, getDefaultName, getDefaultSchema, getDefaultTableName, getDiscriminatorValue, getInheritanceStrategy, getName, getParentEntity, getPrimaryKeyColumnName, getSpecifiedDiscriminatorValue, getSpecifiedInheritanceStrategy, getSpecifiedName, moveSpecifiedAssociationOverride, moveSpecifiedAttributeOverride, moveSpecifiedPrimaryKeyJoinColumn, moveSpecifiedSecondaryTable, primaryKeyJoinColumnsSize, removeSpecifiedPrimaryKeyJoinColumn, removeSpecifiedPrimaryKeyJoinColumn, removeSpecifiedSecondaryTable, removeSpecifiedSecondaryTable, secondaryTablesSize, setSpecifiedDiscriminatorValue, setSpecifiedInheritanceStrategy, setSpecifiedName, specifiedAssociationOverridesSize, specifiedAttributeOverridesSize, specifiedDiscriminatorColumnIsAllowed, specifiedDiscriminatorValueIsAllowed, specifiedPrimaryKeyJoinColumnsSize, specifiedSecondaryTablesSize, specifiedTableIsAllowed, tableIsUndefined, virtualAssociationOverridesSize, virtualAttributeOverridesSize

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

allOverridableAssociationNames, allOverridableAssociations, allOverridableAttributeNames, allOverridableAttributes, associatedTableNamesIncludingInherited, associatedTables, associatedTablesIncludingInherited, attributeMappingKeyAllowed, getDbSchema, getDbTable, getKey, getPrimaryDbTable, getPrimaryTableName, isMapped, overridableAssociationNames, overridableAttributeNames, shouldValidateAgainstDatabase, tableNameIsInvalid

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

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, postUpdate

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

removeSequenceGenerator, removeTableGenerator

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

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, postUpdate

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

moveNamedNativeQuery, moveNamedQuery, namedNativeQueriesSize, namedQueriesSize, removeNamedNativeQuery, removeNamedNativeQuery, removeNamedQuery, removeNamedQuery

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

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, postUpdate

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

getIdClass, getIdClassEnclosingTypeSeparator, setIdClass

Methods inherited from interface org.eclipse.jpt.core.context.java.JavaGeneratorHolder

addSequenceGenerator, addTableGenerator, getSequenceGenerator, getTableGenerator

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

removeSequenceGenerator, removeTableGenerator

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

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, postUpdate

Method Detail

getConverterHolder

JavaConverterHolder getConverterHolder()

getCaching

JavaCaching getCaching()

Specified by:

getCaching in interface EclipseLinkEntity

secondaryTables

java.util.ListIterator<JavaSecondaryTable> secondaryTables()

Description copied from interface: Entity

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

Specified by:

secondaryTables in interface Entity

Specified by:

secondaryTables in interface JavaEntity

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

Specified by:

specifiedSecondaryTables in interface JavaEntity

primaryKeyJoinColumns

java.util.ListIterator<JavaPrimaryKeyJoinColumn> primaryKeyJoinColumns()

Specified by:

primaryKeyJoinColumns in interface Entity

Specified by:

primaryKeyJoinColumns in interface JavaEntity

specifiedPrimaryKeyJoinColumns

java.util.ListIterator<JavaPrimaryKeyJoinColumn> specifiedPrimaryKeyJoinColumns()

Specified by:

specifiedPrimaryKeyJoinColumns in interface Entity

Specified by:

specifiedPrimaryKeyJoinColumns in interface JavaEntity

attributeOverrides

java.util.ListIterator<JavaAttributeOverride> attributeOverrides()

Description copied from interface: Entity

Return a list iterator of the attribute overrides whether specified or default. This will not be null.

Specified by:

attributeOverrides in interface Entity

Specified by:

attributeOverrides in interface JavaEntity

specifiedAttributeOverrides

java.util.ListIterator<JavaAttributeOverride> specifiedAttributeOverrides()

Description copied from interface: Entity

Return a list iterator of the specified attribute overrides. This will not be null. No add/remove for specified attribute overrides, the virtual attribute overrides will be populated from superclasses, then use AttributeOverride.setVirtual(boolean) to add/remove the attribute override from the source

Specified by:

specifiedAttributeOverrides in interface Entity

Specified by:

specifiedAttributeOverrides in interface JavaEntity

virtualAttributeOverrides

java.util.ListIterator<JavaAttributeOverride> virtualAttributeOverrides()

Description copied from interface: Entity

Return a list iterator of the virtual attribute overrides, those not specified. This will not be null.

Specified by:

virtualAttributeOverrides in interface Entity

Specified by:

virtualAttributeOverrides in interface JavaEntity

associationOverrides

java.util.ListIterator<JavaAssociationOverride> associationOverrides()

Description copied from interface: Entity

Return a list iterator of the association overrides whether specified or default. This will not be null.

Specified by:

associationOverrides in interface Entity

Specified by:

associationOverrides in interface JavaEntity

specifiedAssociationOverrides

java.util.ListIterator<JavaAssociationOverride> specifiedAssociationOverrides()

Description copied from interface: Entity

Return a list iterator of the specified association overrides. This will not be null. No add/remove for specified association overrides, the virtual association overrides will be populated from superclasses, then use AssociationOverride.setVirtual(boolean) to add/remove the association override from the source

Specified by:

specifiedAssociationOverrides in interface Entity

Specified by:

specifiedAssociationOverrides in interface JavaEntity

virtualAssociationOverrides

java.util.ListIterator<JavaAssociationOverride> virtualAssociationOverrides()

Description copied from interface: Entity

Return the number of default association overrides.

Specified by:

virtualAssociationOverrides in interface Entity

Specified by:

virtualAssociationOverrides in interface JavaEntity

namedQueries

java.util.ListIterator<JavaNamedQuery> namedQueries()

Description copied from interface: QueryContainer

Return a list iterator of the named queries. This will not be null.

Specified by:

namedQueries in interface JavaEntity

Specified by:

namedQueries in interface QueryContainer

namedNativeQueries

java.util.ListIterator<JavaNamedNativeQuery> namedNativeQueries()

Description copied from interface: QueryContainer

Return a list iterator of the specified named native queries. This will not be null.

Specified by:

namedNativeQueries in interface JavaEntity

Specified by:

namedNativeQueries in interface QueryContainer