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

All Superinterfaces:

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

public interface ClassRef
extends XmlContextNode, JpaStructureNode

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	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.
boolean	isFor(java.lang.String fullyQualifiedTypeName) Return true if the IClassRef matches the fullyQualfiedTypeName
boolean	isVirtual() Return whether this mapping file ref is represented by an entry in the persistence.xml (false) or if it is instead virtual
void	setClassName(java.lang.String className) Set the class name of the class ref.
void	update(java.lang.String className) Update the ClassRef context model object to match the className.
void	update(XmlJavaClassRef classRef) Update the ClassRef context model object to match the XmlJavaClassRef resource model object.

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

getEResource, getValidationTextRange, validate

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

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit

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

getJpaProject, getParent

Methods inherited from interface org.eclipse.jpt.utility.model.Model

addCollectionChangeListener, addCollectionChangeListener, addListChangeListener, addListChangeListener, addPropertyChangeListener, addPropertyChangeListener, addStateChangeListener, addTreeChangeListener, addTreeChangeListener, removeCollectionChangeListener, removeCollectionChangeListener, removeListChangeListener, removeListChangeListener, removePropertyChangeListener, removePropertyChangeListener, removeStateChangeListener, removeTreeChangeListener, removeTreeChangeListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

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

getResource

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

dispose, getId, getSelectionTextRange, getStructureNode

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 fullyQualifiedTypeName)

Return true if the IClassRef matches the fullyQualfiedTypeName

isVirtual

boolean isVirtual()

Return whether this mapping file ref is represented by an entry in the persistence.xml (false) or if it is instead virtual

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(XmlJavaClassRef classRef)

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