|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface 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.
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_DISCRIMINATOR_VALUE_PROPERTY
|
static java.lang.String |
DEFAULT_INHERITANCE_STRATEGY_PROPERTY
|
static java.lang.String |
DEFAULT_NAME_PROPERTY
|
static java.lang.String |
DEFAULT_PRIMARY_KEY_JOIN_COLUMN
|
static java.lang.String |
DISCRIMINATOR_VALUE_ALLOWED_PROPERTY
|
static java.lang.String |
SPECIFIED_ASSOCIATION_OVERRIDES_LIST
|
static java.lang.String |
SPECIFIED_ATTRIBUTE_OVERRIDES_LIST
|
static java.lang.String |
SPECIFIED_DISCRIMINATOR_VALUE_PROPERTY
|
static java.lang.String |
SPECIFIED_INHERITANCE_STRATEGY_PROPERTY
|
static java.lang.String |
SPECIFIED_NAME_PROPERTY
|
static java.lang.String |
SPECIFIED_PRIMARY_KEY_JOIN_COLUMNS_LIST
|
static java.lang.String |
SPECIFIED_SECONDARY_TABLES_LIST
|
static java.lang.String |
VIRTUAL_ASSOCIATION_OVERRIDES_LIST
|
static java.lang.String |
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.QueryHolder |
---|
NAMED_NATIVE_QUERIES_LIST, NAMED_QUERIES_LIST |
Fields inherited from interface org.eclipse.jpt.core.context.IdClass |
---|
ID_CLASS_PROPERTY |
Method Summary | ||
---|---|---|
PrimaryKeyJoinColumn |
addSpecifiedPrimaryKeyJoinColumn(int index)
|
|
SecondaryTable |
addSpecifiedSecondaryTable(int index)
Add a specified secondary table to the entity return the object representing it. |
|
|
associationOverrides()
Return a list iterator of the association overrides whether specified or default. |
|
int |
associationOverridesSize()
Return the number of association overrides, both specified and default. |
|
|
attributeOverrides()
Return a list iterator of the attribute overrides whether specified or default. |
|
int |
attributeOverridesSize()
Return the number of attribute overrides, both specified and default. |
|
AttributeOverride |
getAttributeOverrideNamed(java.lang.String name)
Return the attribute overrides, whether specified or default, with the given name. |
|
java.lang.String |
getDefaultDiscriminatorValue()
|
|
InheritanceType |
getDefaultInheritanceStrategy()
|
|
java.lang.String |
getDefaultName()
Return the default name, based on the class name. |
|
PrimaryKeyJoinColumn |
getDefaultPrimaryKeyJoinColumn()
|
|
DiscriminatorColumn |
getDiscriminatorColumn()
|
|
java.lang.String |
getDiscriminatorValue()
|
|
InheritanceType |
getInheritanceStrategy()
|
|
java.lang.String |
getName()
Return the name, specified or default if not specified. |
|
Entity |
getParentEntity()
The first parent in the class hierarchy that is an entity. |
|
java.lang.String |
getPrimaryKeyColumnName()
Return the name of the entity's primary key column. |
|
Entity |
getRootEntity()
Return the ultimate top of the inheritance hierarchy This method should never return null. |
|
java.lang.String |
getSpecifiedDiscriminatorValue()
|
|
InheritanceType |
getSpecifiedInheritanceStrategy()
|
|
java.lang.String |
getSpecifiedName()
Return the specified name. |
|
Table |
getTable()
Return the table for this entity, either specified or default. |
|
boolean |
isDiscriminatorValueAllowed()
Return whether a DiscriminatorValue is allowed for this Entity It is allowed if the IType is concrete (not abstract) |
|
void |
moveSpecifiedAssociationOverride(int targetIndex,
int sourceIndex)
Move the specified association override from the source index to the target index. |
|
void |
moveSpecifiedAttributeOverride(int targetIndex,
int sourceIndex)
Move the specified attribute override from the source index to the target index. |
|
void |
moveSpecifiedPrimaryKeyJoinColumn(int targetIndex,
int sourceIndex)
|
|
void |
moveSpecifiedSecondaryTable(int targetIndex,
int sourceIndex)
Move the specified secondary table from the source index to the target index. |
|
|
primaryKeyJoinColumns()
|
|
int |
primaryKeyJoinColumnsSize()
|
|
void |
removeSpecifiedPrimaryKeyJoinColumn(int index)
|
|
void |
removeSpecifiedPrimaryKeyJoinColumn(PrimaryKeyJoinColumn primaryKeyJoinColumn)
|
|
void |
removeSpecifiedSecondaryTable(int index)
Remove the specified secondary table from the entity. |
|
void |
removeSpecifiedSecondaryTable(SecondaryTable secondaryTable)
Remove the specified secondary table at the index from the entity. |
|
|
secondaryTables()
Return a list iterator of the secondary tables whether specified or default. |
|
int |
secondaryTablesSize()
Return the number of secondary tables, both specified and default. |
|
void |
setSpecifiedDiscriminatorValue(java.lang.String value)
|
|
void |
setSpecifiedInheritanceStrategy(InheritanceType newInheritanceType)
|
|
void |
setSpecifiedName(java.lang.String value)
Set the specified name on the entity. |
|
|
specifiedAssociationOverrides()
Return a list iterator of the specified association overrides. |
|
int |
specifiedAssociationOverridesSize()
Return the number of specified association overrides. |
|
|
specifiedAttributeOverrides()
Return a list iterator of the specified attribute overrides. |
|
int |
specifiedAttributeOverridesSize()
Return the number of specified attribute overrides. |
|
|
specifiedPrimaryKeyJoinColumns()
|
|
int |
specifiedPrimaryKeyJoinColumnsSize()
|
|
|
specifiedSecondaryTables()
Return a list iterator of the specified secondary tables. |
|
int |
specifiedSecondaryTablesSize()
Return the number of specified secondary tables. |
|
|
virtualAssociationOverrides()
Return the number of default association overrides. |
|
int |
virtualAssociationOverridesSize()
Return the number of default association overrides. |
|
|
virtualAttributeOverrides()
Return a list iterator of the virtual attribute overrides, those not specified. |
|
int |
virtualAttributeOverridesSize()
Return the number of default attribute overrides. |
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 |
---|
addSequenceGenerator, addTableGenerator, getSequenceGenerator, getTableGenerator, 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 |
---|
addNamedNativeQuery, addNamedQuery, moveNamedNativeQuery, moveNamedQuery, namedNativeQueries, namedNativeQueriesSize, namedQueries, 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 |
Field Detail |
---|
static final java.lang.String SPECIFIED_NAME_PROPERTY
static final java.lang.String DEFAULT_NAME_PROPERTY
static final java.lang.String SPECIFIED_SECONDARY_TABLES_LIST
static final java.lang.String DEFAULT_INHERITANCE_STRATEGY_PROPERTY
static final java.lang.String SPECIFIED_INHERITANCE_STRATEGY_PROPERTY
static final java.lang.String DEFAULT_DISCRIMINATOR_VALUE_PROPERTY
static final java.lang.String SPECIFIED_DISCRIMINATOR_VALUE_PROPERTY
static final java.lang.String DISCRIMINATOR_VALUE_ALLOWED_PROPERTY
static final java.lang.String SPECIFIED_PRIMARY_KEY_JOIN_COLUMNS_LIST
static final java.lang.String DEFAULT_PRIMARY_KEY_JOIN_COLUMN
static final java.lang.String SPECIFIED_ATTRIBUTE_OVERRIDES_LIST
static final java.lang.String VIRTUAL_ATTRIBUTE_OVERRIDES_LIST
static final java.lang.String SPECIFIED_ASSOCIATION_OVERRIDES_LIST
static final java.lang.String VIRTUAL_ASSOCIATION_OVERRIDES_LIST
Method Detail |
---|
java.lang.String getName()
java.lang.String getSpecifiedName()
void setSpecifiedName(java.lang.String value)
java.lang.String getDefaultName()
Table getTable()
<T extends SecondaryTable> java.util.ListIterator<T> secondaryTables()
int secondaryTablesSize()
<T extends SecondaryTable> java.util.ListIterator<T> specifiedSecondaryTables()
int specifiedSecondaryTablesSize()
SecondaryTable addSpecifiedSecondaryTable(int index)
void removeSpecifiedSecondaryTable(int index)
void removeSpecifiedSecondaryTable(SecondaryTable secondaryTable)
void moveSpecifiedSecondaryTable(int targetIndex, int sourceIndex)
InheritanceType getInheritanceStrategy()
InheritanceType getDefaultInheritanceStrategy()
InheritanceType getSpecifiedInheritanceStrategy()
void setSpecifiedInheritanceStrategy(InheritanceType newInheritanceType)
DiscriminatorColumn getDiscriminatorColumn()
java.lang.String getDiscriminatorValue()
java.lang.String getDefaultDiscriminatorValue()
java.lang.String getSpecifiedDiscriminatorValue()
void setSpecifiedDiscriminatorValue(java.lang.String value)
boolean isDiscriminatorValueAllowed()
<T extends PrimaryKeyJoinColumn> java.util.ListIterator<T> primaryKeyJoinColumns()
int primaryKeyJoinColumnsSize()
<T extends PrimaryKeyJoinColumn> java.util.ListIterator<T> specifiedPrimaryKeyJoinColumns()
int specifiedPrimaryKeyJoinColumnsSize()
PrimaryKeyJoinColumn getDefaultPrimaryKeyJoinColumn()
PrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn(int index)
void removeSpecifiedPrimaryKeyJoinColumn(int index)
void removeSpecifiedPrimaryKeyJoinColumn(PrimaryKeyJoinColumn primaryKeyJoinColumn)
void moveSpecifiedPrimaryKeyJoinColumn(int targetIndex, int sourceIndex)
<T extends AttributeOverride> java.util.ListIterator<T> attributeOverrides()
int attributeOverridesSize()
<T extends AttributeOverride> java.util.ListIterator<T> specifiedAttributeOverrides()
AttributeOverride.setVirtual(boolean)
to add/remove the attribute
override from the source
int specifiedAttributeOverridesSize()
<T extends AttributeOverride> java.util.ListIterator<T> virtualAttributeOverrides()
int virtualAttributeOverridesSize()
void moveSpecifiedAttributeOverride(int targetIndex, int sourceIndex)
AttributeOverride getAttributeOverrideNamed(java.lang.String name)
<T extends AssociationOverride> java.util.ListIterator<T> associationOverrides()
int associationOverridesSize()
<T extends AssociationOverride> java.util.ListIterator<T> specifiedAssociationOverrides()
AssociationOverride.setVirtual(boolean)
to add/remove the association
override from the source
int specifiedAssociationOverridesSize()
<T extends AssociationOverride> java.util.ListIterator<T> virtualAssociationOverrides()
int virtualAssociationOverridesSize()
void moveSpecifiedAssociationOverride(int targetIndex, int sourceIndex)
Entity getRootEntity()
Entity getParentEntity()
java.lang.String getPrimaryKeyColumnName()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |