org.eclipse.jpt.jpa.core.context
Interface IdClassReference

All Superinterfaces:

IAdaptable, JpaContextNode, JpaNode, JptResourceTypeReference, Model, PersistentType.Owner

All Known Subinterfaces:

JavaIdClassReference, OrmIdClassReference

public interface IdClassReference
extends PersistentType.Owner

ID class reference

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

Nested Class Summary

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

JptResourceTypeReference.ResourceTypeTransformer

Field Summary

static String	DEFAULT_ID_CLASS_NAME_PROPERTY Property string associated with changes to the IdClassHolder's default id class name
static String	FULLY_QUALIFIED_ID_CLASS_PROPERTY
static String	ID_CLASS_PROPERTY Property string associated with changes to the IdClassHolder's id class.
static String	SPECIFIED_ID_CLASS_NAME_PROPERTY Property string associated with changes to the IdClassHolder's specified id class name

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

RESOURCE_TYPE_TRANSFORMER

Method Summary

String	getDefaultIdClassName() Return the default name of the id class, null if there is none
String	getFullyQualifiedIdClassName() Return the fully qualified name of the id class, taking into consideration the default value if applicable
JavaPersistentType	getIdClass() Return the JavaPersistentType that is resolved from the id class name.
char	getIdClassEnclosingTypeSeparator() Return the char to be used for browsing or creating the id class IType.
String	getIdClassName() Return the name of the id class, taking into consideration the default value if applicable
String	getSpecifiedIdClassName() Return the specified name of the id class, null if none is specified in the resource model
boolean	isSpecified() Return whether the id class has been specified.
void	setSpecifiedIdClassName(String value) Set the specified name of the id class.

Methods inherited from interface org.eclipse.jpt.jpa.core.context.PersistentType.Owner

getDefaultPersistentTypeAccess, getOverridePersistentTypeAccess

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

SPECIFIED_ID_CLASS_NAME_PROPERTY

static final String SPECIFIED_ID_CLASS_NAME_PROPERTY

Property string associated with changes to the IdClassHolder's specified id class name

See Also:

Constant Field Values

DEFAULT_ID_CLASS_NAME_PROPERTY

static final String DEFAULT_ID_CLASS_NAME_PROPERTY

Property string associated with changes to the IdClassHolder's default id class name

See Also:

Constant Field Values

FULLY_QUALIFIED_ID_CLASS_PROPERTY

static final String FULLY_QUALIFIED_ID_CLASS_PROPERTY

See Also:

Constant Field Values

ID_CLASS_PROPERTY

static final String ID_CLASS_PROPERTY

Property string associated with changes to the IdClassHolder's id class. This will change (potentially) if the id class name changes, or if other changes result in changes in the id class' resolution.

See Also:

Constant Field Values

Method Detail

getIdClassName

String getIdClassName()

Return the name of the id class, taking into consideration the default value if applicable

getSpecifiedIdClassName

String getSpecifiedIdClassName()

Return the specified name of the id class, null if none is specified in the resource model

setSpecifiedIdClassName

void setSpecifiedIdClassName(String value)

Set the specified name of the id class. Use null to remove the id class specification from the resource model

getDefaultIdClassName

String getDefaultIdClassName()

Return the default name of the id class, null if there is none

isSpecified

boolean isSpecified()

Return whether the id class has been specified. Generally, this simply means that the id class name has been set, although if a default applies, this should also return true.

getFullyQualifiedIdClassName

String getFullyQualifiedIdClassName()

Return the fully qualified name of the id class, taking into consideration the default value if applicable

getIdClass

JavaPersistentType getIdClass()

Return the JavaPersistentType that is resolved from the id class name. This will be null if the id class name is null or if the class cannot be resolved from that name.

getIdClassEnclosingTypeSeparator

char getIdClassEnclosingTypeSeparator()

Return the char to be used for browsing or creating the id class IType.

See Also:

IType.getFullyQualifiedName(char)