|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OrmEntity
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.
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.core.context.orm.OrmTypeMapping |
---|
CLASS_PROPERTY, DEFAULT_ACCESS_PROPERTY, DEFAULT_METADATA_COMPLETE_PROPERTY, JAVA_PERSISTENT_TYPE_PROPERTY, SPECIFIED_ACCESS_PROPERTY, SPECIFIED_METADATA_COMPLETE_PROPERTY |
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.QueryHolder |
---|
NAMED_NATIVE_QUERIES_LIST, NAMED_QUERIES_LIST |
Fields inherited from interface org.eclipse.jpt.core.context.IdClass |
---|
ID_CLASS_PROPERTY |
Fields inherited from interface org.eclipse.jpt.core.context.GeneratorHolder |
---|
SEQUENCE_GENERATOR_PROPERTY, TABLE_GENERATOR_PROPERTY |
Method Summary | |
---|---|
OrmNamedNativeQuery |
addNamedNativeQuery(int index)
Add a named native query to the entity return the object representing it. |
OrmNamedQuery |
addNamedQuery(int index)
Add a named query to the entity return the object representing it. |
OrmPrimaryKeyJoinColumn |
addSpecifiedPrimaryKeyJoinColumn(int index)
|
OrmSecondaryTable |
addSpecifiedSecondaryTable(int index)
Add a specified secondary table to the entity return the object representing it. |
java.util.ListIterator<OrmAssociationOverride> |
associationOverrides()
Return a list iterator of the association overrides whether specified or default. |
java.util.ListIterator<OrmAttributeOverride> |
attributeOverrides()
Return a list iterator of the attribute overrides whether specified or default. |
boolean |
containsVirtualSecondaryTable(OrmSecondaryTable secondaryTable)
Return whether the entity contains the given secondary table in its list of virtual secondary tables |
java.util.ListIterator<OrmPrimaryKeyJoinColumn> |
defaultPrimaryKeyJoinColumns()
|
OrmAttributeOverride |
getAttributeOverrideNamed(java.lang.String name)
Return the attribute overrides, whether specified or default, with the given name. |
OrmPrimaryKeyJoinColumn |
getDefaultPrimaryKeyJoinColumn()
|
OrmDiscriminatorColumn |
getDiscriminatorColumn()
|
JavaEntity |
getJavaEntity()
Return the Java Entity this ORM Entity corresponds to. |
OrmTable |
getTable()
Return the table for this entity, either specified or default. |
void |
initialize(XmlEntity entity)
|
java.util.ListIterator<OrmNamedNativeQuery> |
namedNativeQueries()
Return a list iterator of the specified named native queries. |
java.util.ListIterator<OrmNamedQuery> |
namedQueries()
Return a list iterator of the named queries. |
java.util.Iterator<OrmPersistentAttribute> |
overridableAssociations()
Return an Iterator of associations that can be overriden. |
java.util.Iterator<OrmPersistentAttribute> |
overridableAttributes()
Return an Iterator of attributes. |
java.util.ListIterator<OrmPrimaryKeyJoinColumn> |
primaryKeyJoinColumns()
|
java.util.ListIterator<OrmSecondaryTable> |
secondaryTables()
Return a list iterator of the secondary tables whether specified or default. |
boolean |
secondaryTablesDefinedInXml()
Return true if there are no virtual secondary tables on the orm entity. |
void |
setSecondaryTablesDefinedInXml(boolean defineInXml)
If true, then all virtual secondary tables are added in as specified secondary tables to the xml. |
java.util.ListIterator<OrmAssociationOverride> |
specifiedAssociationOverrides()
Return a list iterator of the specified association overrides. |
java.util.ListIterator<OrmAttributeOverride> |
specifiedAttributeOverrides()
Return a list iterator of the specified attribute overrides. |
java.util.ListIterator<OrmPrimaryKeyJoinColumn> |
specifiedPrimaryKeyJoinColumns()
|
java.util.ListIterator<OrmSecondaryTable> |
specifiedSecondaryTables()
Return a list iterator of the specified secondary tables. |
void |
update(XmlEntity entity)
|
java.util.ListIterator<OrmAssociationOverride> |
virtualAssociationOverrides()
Return the number of default association overrides. |
java.util.ListIterator<OrmAttributeOverride> |
virtualAttributeOverrides()
Return a list iterator of the virtual attribute overrides, those not specified. |
java.util.ListIterator<OrmSecondaryTable> |
virtualSecondaryTables()
Return a list iterator of the virtual(not specified) secondary tables. |
int |
virtualSecondaryTablesSize()
Return the number of virtual secondary tables. |
Methods inherited from interface org.eclipse.jpt.core.context.orm.OrmTypeMapping |
---|
addToResourceModel, containsOffset, getAccess, getAttributesTextRange, getClass_, getDefaultAccess, getJavaPersistentType, getPersistentType, getSelectionTextRange, getSpecifiedAccess, getSpecifiedMetadataComplete, getTypeMappingResource, getXmlSequence, initializeFrom, isDefaultMetadataComplete, isMetadataComplete, removeFromResourceModel, setClass, setSpecifiedAccess, setSpecifiedMetadataComplete |
Methods inherited from interface org.eclipse.jpt.core.context.TypeMapping |
---|
allOverridableAssociationNames, allOverridableAssociations, allOverridableAttributeNames, allOverridableAttributes, associatedTableNamesIncludingInherited, associatedTables, associatedTablesIncludingInherited, attributeMappingKeyAllowed, getDbSchema, getDbTable, getKey, getPrimaryDbTable, getTableName, isMapped, overridableAssociationNames, overridableAttributeNames, tableNameIsInvalid |
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode |
---|
getEntityMappings, getOrmPersistentType, getPersistenceUnit |
Methods inherited from interface org.eclipse.jpt.core.JpaNode |
---|
getJpaProject, getParent, getResource |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
---|
getAdapter |
Methods inherited from interface org.eclipse.jpt.core.context.orm.OrmJpaContextNode |
---|
addToMessages, getValidationTextRange |
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode |
---|
getEntityMappings, getOrmPersistentType, getPersistenceUnit |
Methods inherited from interface org.eclipse.jpt.core.JpaNode |
---|
getJpaProject, getParent, getResource |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
---|
getAdapter |
Methods inherited from interface org.eclipse.jpt.core.context.TypeMapping |
---|
allOverridableAssociationNames, allOverridableAssociations, allOverridableAttributeNames, allOverridableAttributes, associatedTableNamesIncludingInherited, associatedTables, associatedTablesIncludingInherited, attributeMappingKeyAllowed, getDbSchema, getDbTable, getKey, getPrimaryDbTable, getTableName, isMapped, overridableAssociationNames, overridableAttributeNames, tableNameIsInvalid |
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode |
---|
getEntityMappings, getOrmPersistentType, getPersistenceUnit |
Methods inherited from interface org.eclipse.jpt.core.JpaNode |
---|
getJpaProject, getParent, getResource |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
---|
getAdapter |
Methods inherited from interface org.eclipse.jpt.core.context.GeneratorHolder |
---|
removeSequenceGenerator, removeTableGenerator |
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode |
---|
getEntityMappings, getOrmPersistentType, getPersistenceUnit |
Methods inherited from interface org.eclipse.jpt.core.JpaNode |
---|
getJpaProject, getParent, getResource |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
---|
getAdapter |
Methods inherited from interface org.eclipse.jpt.core.context.QueryHolder |
---|
moveNamedNativeQuery, moveNamedQuery, namedNativeQueriesSize, namedQueriesSize, removeNamedNativeQuery, removeNamedNativeQuery, removeNamedQuery, removeNamedQuery |
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode |
---|
getEntityMappings, getOrmPersistentType, getPersistenceUnit |
Methods inherited from interface org.eclipse.jpt.core.JpaNode |
---|
getJpaProject, getParent, getResource |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
---|
getAdapter |
Methods inherited from interface org.eclipse.jpt.core.context.IdClass |
---|
getIdClass, setIdClass |
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode |
---|
getEntityMappings, getOrmPersistentType, getPersistenceUnit |
Methods inherited from interface org.eclipse.jpt.core.JpaNode |
---|
getJpaProject, getParent, getResource |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
---|
getAdapter |
Methods inherited from interface org.eclipse.jpt.core.context.orm.OrmGeneratorHolder |
---|
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 |
---|
getEntityMappings, getOrmPersistentType, getPersistenceUnit |
Methods inherited from interface org.eclipse.jpt.core.JpaNode |
---|
getJpaProject, getParent, getResource |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
---|
getAdapter |
Field Detail |
---|
static final java.lang.String VIRTUAL_SECONDARY_TABLES_LIST
static final java.lang.String DEFAULT_PRIMARY_KEY_JOIN_COLUMNS_LIST
Method Detail |
---|
java.util.ListIterator<OrmSecondaryTable> virtualSecondaryTables()
int virtualSecondaryTablesSize()
boolean containsVirtualSecondaryTable(OrmSecondaryTable secondaryTable)
boolean secondaryTablesDefinedInXml()
void setSecondaryTablesDefinedInXml(boolean defineInXml)
JavaEntity getJavaEntity()
void initialize(XmlEntity entity)
void update(XmlEntity entity)
OrmTable getTable()
Entity
getTable
in interface Entity
OrmDiscriminatorColumn getDiscriminatorColumn()
getDiscriminatorColumn
in interface Entity
java.util.ListIterator<OrmSecondaryTable> secondaryTables()
Entity
secondaryTables
in interface Entity
java.util.ListIterator<OrmSecondaryTable> specifiedSecondaryTables()
Entity
specifiedSecondaryTables
in interface Entity
OrmSecondaryTable addSpecifiedSecondaryTable(int index)
Entity
addSpecifiedSecondaryTable
in interface Entity
java.util.ListIterator<OrmPrimaryKeyJoinColumn> primaryKeyJoinColumns()
primaryKeyJoinColumns
in interface Entity
OrmPrimaryKeyJoinColumn getDefaultPrimaryKeyJoinColumn()
getDefaultPrimaryKeyJoinColumn
in interface Entity
java.util.ListIterator<OrmPrimaryKeyJoinColumn> defaultPrimaryKeyJoinColumns()
java.util.ListIterator<OrmPrimaryKeyJoinColumn> specifiedPrimaryKeyJoinColumns()
specifiedPrimaryKeyJoinColumns
in interface Entity
OrmPrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn(int index)
addSpecifiedPrimaryKeyJoinColumn
in interface Entity
java.util.ListIterator<OrmAttributeOverride> attributeOverrides()
Entity
attributeOverrides
in interface Entity
java.util.ListIterator<OrmAttributeOverride> specifiedAttributeOverrides()
Entity
AttributeOverride.setVirtual(boolean)
to add/remove the attribute
override from the source
specifiedAttributeOverrides
in interface Entity
java.util.ListIterator<OrmAttributeOverride> virtualAttributeOverrides()
Entity
virtualAttributeOverrides
in interface Entity
OrmAttributeOverride getAttributeOverrideNamed(java.lang.String name)
Entity
getAttributeOverrideNamed
in interface Entity
java.util.ListIterator<OrmAssociationOverride> associationOverrides()
Entity
associationOverrides
in interface Entity
java.util.ListIterator<OrmAssociationOverride> specifiedAssociationOverrides()
Entity
AssociationOverride.setVirtual(boolean)
to add/remove the association
override from the source
specifiedAssociationOverrides
in interface Entity
java.util.ListIterator<OrmAssociationOverride> virtualAssociationOverrides()
Entity
virtualAssociationOverrides
in interface Entity
java.util.ListIterator<OrmNamedQuery> namedQueries()
QueryHolder
namedQueries
in interface QueryHolder
OrmNamedQuery addNamedQuery(int index)
QueryHolder
addNamedQuery
in interface QueryHolder
java.util.ListIterator<OrmNamedNativeQuery> namedNativeQueries()
QueryHolder
namedNativeQueries
in interface QueryHolder
OrmNamedNativeQuery addNamedNativeQuery(int index)
QueryHolder
addNamedNativeQuery
in interface QueryHolder
java.util.Iterator<OrmPersistentAttribute> overridableAttributes()
TypeMapping
overridableAttributes
in interface OrmTypeMapping
overridableAttributes
in interface TypeMapping
java.util.Iterator<OrmPersistentAttribute> overridableAssociations()
TypeMapping
overridableAssociations
in interface OrmTypeMapping
overridableAssociations
in interface TypeMapping
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |