| /******************************************************************************* |
| * Copyright (c) 2007, 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.context.persistence; |
| |
| import java.util.ListIterator; |
| import org.eclipse.jpt.core.JpaStructureNode; |
| import org.eclipse.jpt.core.resource.persistence.XmlPersistence; |
| |
| /** |
| * |
| * |
| * 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 Persistence extends PersistenceJpaContextNode, JpaStructureNode |
| { |
| // **************** persistence units ************************************** |
| |
| /** |
| * String constant associated with changes to the persistence units list |
| */ |
| public final static String PERSISTENCE_UNITS_LIST = "persistenceUnits"; |
| |
| /** |
| * Return an iterator on the list of persistence units. |
| * This will not be null. |
| */ |
| ListIterator<PersistenceUnit> persistenceUnits(); |
| |
| /** |
| * Return the size of the persistence unit list. |
| * @return |
| */ |
| int persistenceUnitsSize(); |
| |
| /** |
| * Add a persistence unit to the persistence node and return the object |
| * representing it. |
| */ |
| PersistenceUnit addPersistenceUnit(); |
| |
| /** |
| * Add a persistence unit to the persistence node at the specified index and |
| * return the object representing it. |
| */ |
| PersistenceUnit addPersistenceUnit(int index); |
| |
| /** |
| * Remove the persistence unit from the persistence node. |
| */ |
| void removePersistenceUnit(PersistenceUnit persistenceUnit); |
| |
| /** |
| * Remove the persistence unit at the specified index from the persistence node. |
| */ |
| void removePersistenceUnit(int index); |
| |
| |
| // **************** updating *********************************************** |
| |
| void update(XmlPersistence persistence); |
| |
| |
| // **************** text range ********************************************* |
| |
| /** |
| * Return whether the text representation of this persistence contains |
| * the given text offset |
| */ |
| boolean containsOffset(int textOffset); |
| |
| } |