| /******************************************************************************* |
| * Copyright (c) 2007, 2009 Oracle. All rights reserved. |
| * This program and the accompanying materials are made available under the |
| * terms of the Eclipse Public License v1.0, which accompanies this distribution |
| * and is available at http://www.eclipse.org/legal/epl-v10.html. |
| * |
| * Contributors: |
| * Oracle - initial API and implementation |
| ******************************************************************************/ |
| package org.eclipse.jpt.core.context.persistence; |
| |
| import org.eclipse.jpt.core.JpaStructureNode; |
| import org.eclipse.jpt.core.context.PersistentType; |
| import org.eclipse.jpt.core.context.XmlContextNode; |
| import org.eclipse.jpt.core.context.java.JavaPersistentType; |
| import org.eclipse.jpt.core.resource.persistence.XmlJavaClassRef; |
| |
| /** |
| * This is the context model corresponding to the persistence resource model |
| * XmlJavaClassRef, which corresponds to the 'class' tag in the persistence.xml. |
| * This is also used this for "implied" class refs; i.e. class refs that are not |
| * explicitly listed in the persistence.xml. |
| * |
| * 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. |
| */ |
| public interface ClassRef |
| extends XmlContextNode, JpaStructureNode, PersistentType.Owner |
| { |
| /** |
| * Return whether the class ref is a reference to the specified type. |
| */ |
| boolean isFor(String typeName); |
| |
| /** |
| * 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. |
| */ |
| boolean isVirtual(); |
| |
| |
| // **************** class name ********************************************* |
| |
| /** |
| * String constant associated with changes to the class name |
| */ |
| final static String CLASS_NAME_PROPERTY = "className"; //$NON-NLS-1$ |
| |
| /** |
| * Return the class name of the class ref. |
| */ |
| String getClassName(); |
| |
| /** |
| * Set the class name of the class ref. |
| */ |
| void setClassName(String className); |
| |
| |
| // **************** java persistent type *********************************** |
| |
| /** |
| * String constant associated with changes to the java persistent type |
| */ |
| final static String JAVA_PERSISTENT_TYPE_PROPERTY = "javaPersistentType"; //$NON-NLS-1$ |
| |
| /** |
| * Return the JavaPersistentType that corresponds to this IClassRef. |
| * This can be null. |
| * This is not settable by users of this API. |
| */ |
| JavaPersistentType getJavaPersistentType(); |
| |
| |
| // **************** update ************************************** |
| |
| /** |
| * Update the ClassRef context model object to match the XmlJavaClassRef |
| * resource model object. see {@link org.eclipse.jpt.core.JpaProject#update()} |
| */ |
| void update(XmlJavaClassRef classRef); |
| |
| /** |
| * Update the ClassRef context model object to match the className. This is used |
| * for impliedClassRefs in the PersistenceUnit. |
| * see {@link org.eclipse.jpt.core.JpaProject#update()} |
| */ |
| void update(String className); |
| |
| |
| // ************************************************************************* |
| |
| /** |
| * Return whether the text representation of this persistence unit contains |
| * the given text offset |
| */ |
| boolean containsOffset(int textOffset); |
| |
| } |