org.eclipse.jpt.core.context.persistence
Interface ClassRef

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, JpaStructureNode, Model, PersistentType.Owner, XmlContextNode

public interface ClassRef
extends XmlContextNode, JpaStructureNode, PersistentType.Owner

Context model corresponding to the XML resource model XmlJavaClassRef, which corresponds to the class element in the persistence.xml file. This is also used for "implied" class refs; i.e. class refs that are not explicitly listed in the persistence.xml file.

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	CLASS_NAME_PROPERTY String constant associated with changes to the class name
static java.lang.String	JAVA_PERSISTENT_TYPE_PROPERTY String constant associated with changes to the java persistent type

Method Summary

boolean	containsOffset(int textOffset) Return whether the text representation of this persistence unit contains the given text offset
java.lang.String	getClassName() Return the class name of the class ref.
JavaPersistentType	getJavaPersistentType() Return the JavaPersistentType that corresponds to this IClassRef.
XmlJavaClassRef	getResourceClassRef()
boolean	isFor(java.lang.String typeName) Return whether the class ref is a reference to the specified type.
boolean	isVirtual() Return true if the mapping file ref is "virtual"; return false if the mapping file ref is represented by an entry in the persistence.xml file.
void	setClassName(java.lang.String className) Set the class name of the class ref.
void	update() Update the ClassRef context model object to match the XmlJavaClassRef resource model object.
void	update(java.lang.String className) Update the ClassRef context model object to match the className.

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

getValidationTextRange, validate

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

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, getResourceType, postUpdate

Methods inherited from interface org.eclipse.jpt.core.JpaStructureNode

dispose, getId, getResourceType, getSelectionTextRange, getStructureNode

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

getDefaultPersistentTypeAccess, getOverridePersistentTypeAccess

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

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, getResourceType, postUpdate

Field Detail

CLASS_NAME_PROPERTY

static final java.lang.String CLASS_NAME_PROPERTY

String constant associated with changes to the class name

See Also:

Constant Field Values

JAVA_PERSISTENT_TYPE_PROPERTY

static final java.lang.String JAVA_PERSISTENT_TYPE_PROPERTY

String constant associated with changes to the java persistent type

See Also:

Constant Field Values

Method Detail

isFor

boolean isFor(java.lang.String typeName)

Return whether the class ref is a reference to the specified type.

isVirtual

boolean isVirtual()

Return true if the mapping file ref is "virtual"; return false if the mapping file ref is represented by an entry in the persistence.xml file.

getResourceClassRef

XmlJavaClassRef getResourceClassRef()

getClassName

java.lang.String getClassName()

Return the class name of the class ref.

setClassName

void setClassName(java.lang.String className)

Set the class name of the class ref.

getJavaPersistentType

JavaPersistentType getJavaPersistentType()

Return the JavaPersistentType that corresponds to this IClassRef. This can be null. This is not settable by users of this API.

update

void update()

Update the ClassRef context model object to match the XmlJavaClassRef resource model object. see JpaProject.update()

update

void update(java.lang.String className)

Update the ClassRef context model object to match the className. This is used for impliedClassRefs in the PersistenceUnit. see JpaProject.update()

containsOffset

boolean containsOffset(int textOffset)

Return whether the text representation of this persistence unit contains the given text offset