| /******************************************************************************* |
| * Copyright (c) 2006, 2008 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; |
| |
| import java.util.Iterator; |
| import org.eclipse.core.resources.IFile; |
| import org.eclipse.jdt.core.ElementChangedEvent; |
| |
| /** |
| * A JpaProject contains Jpa files for all IFiles in the project that |
| * are relevant to the JpaPlatform. |
| * @see JpaFactory#hasRelevantContent(IFile), this method should be moved to JpaPlatform |
| * |
| * 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 JpaFile extends JpaNode |
| { |
| /** |
| * Return the type of resource represented by this JPA file |
| * @see ResourceModel#getResourceType() |
| */ |
| String getResourceType(); |
| |
| /** |
| * Return the IFile associated with this JPA file |
| */ |
| IFile getFile(); |
| |
| /** |
| * Return the resource model represented by this JPA file |
| */ |
| ResourceModel getResourceModel(); |
| |
| /** |
| * Forward the Java element changed event to the JPA file's content. |
| */ |
| void javaElementChanged(ElementChangedEvent event); |
| |
| /** |
| * Update the JPA resource model from the underlying resource. |
| */ |
| void updateFromResource(); |
| |
| /** |
| * The JPA file has been removed from the JPA project. Clean up any |
| * hooks to external resources etc. |
| */ |
| void dispose(); |
| |
| |
| // **************** root structure nodes ************************************* |
| |
| /** |
| * String constant associated with changes to the root structure nodes collection |
| */ |
| String ROOT_STRUCTURE_NODES_COLLECTION = "rootStructureNodes"; |
| |
| /** |
| * Return the root context model objects represented by this JPA file. |
| */ |
| Iterator<JpaStructureNode> rootStructureNodes(); |
| |
| /** |
| * Return the number of root context model objects represented by this JPA file. |
| */ |
| int rootStructureNodesSize(); |
| |
| /** |
| * Add a root context model object represented by this JPA file. |
| * There is the potential for multiple root structure nodes |
| * for a particular key. For example a java file that is listed |
| * both as a <class> in the persistence.xml and as an <entity> in |
| * an orm.xml file. In this case the orm.xml file needs to set |
| * the root structure node after the java class reference. |
| * Last one in during project update wins. |
| * |
| * Call removeRootStructureNode(Object) to clean up when a file is |
| * deleted. |
| */ |
| void addRootStructureNode(Object key, JpaStructureNode rootStructureNode); |
| |
| void removeRootStructureNode(Object key); |
| |
| /** |
| * Return the structure node best represented by the location in the file. |
| */ |
| JpaStructureNode getStructureNode(int textOffset); |
| |
| } |