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

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, JpaContextNode, JpaNode, JpaStructureNode, Model, PersistenceJpaContextNode

public interface MappingFileRef
extends PersistenceJpaContextNode, 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 FILE_NAME_PROPERTY
          String constant associated with changes to the file name
static java.lang.String ORM_XML_PROPERTY
           
 
Method Summary
 boolean containsOffset(int textOffset)
          Return whether the text representation of this persistence unit contains the given text offset
 java.lang.String getFileName()
          Return the file name of the mapping file ref.
 OrmXml getOrmXml()
           
 PersistenceUnitDefaults getPersistenceUnitDefaults()
           
 OrmPersistentType getPersistentType(java.lang.String fullyQualifiedTypeName)
          Return the OrmPersistentType listed in this mapping file with the given fullyQualifiedTypeName.
 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 setFileName(java.lang.String fileName)
          Set the file name of the mapping file ref.
 void update(XmlMappingFileRef mappingFileRef)
           
 
Methods inherited from interface org.eclipse.jpt.core.context.persistence.PersistenceJpaContextNode
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.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.JpaStructureNode
dispose, getId, getSelectionTextRange, getStructureNode
 

Field Detail

FILE_NAME_PROPERTY

static final java.lang.String FILE_NAME_PROPERTY
String constant associated with changes to the file name

See Also:
Constant Field Values

ORM_XML_PROPERTY

static final java.lang.String ORM_XML_PROPERTY
See Also:
Constant Field Values
Method Detail

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


getFileName

java.lang.String getFileName()
Return the file name of the mapping file ref.


setFileName

void setFileName(java.lang.String fileName)
Set the file name of the mapping file ref.


getOrmXml

OrmXml getOrmXml()

update

void update(XmlMappingFileRef mappingFileRef)

getPersistenceUnitDefaults

PersistenceUnitDefaults getPersistenceUnitDefaults()

getPersistentType

OrmPersistentType getPersistentType(java.lang.String fullyQualifiedTypeName)
Return the OrmPersistentType listed in this mapping file with the given fullyQualifiedTypeName. Return null if none exists.


containsOffset

boolean containsOffset(int textOffset)
Return whether the text representation of this persistence unit contains the given text offset