diff options
Diffstat (limited to 'jpa/plugins/org.eclipse.jpt.core/src/org/eclipse/jpt/core/context/PersistentType.java')
| -rw-r--r-- | jpa/plugins/org.eclipse.jpt.core/src/org/eclipse/jpt/core/context/PersistentType.java | 212 |
1 files changed, 0 insertions, 212 deletions
diff --git a/jpa/plugins/org.eclipse.jpt.core/src/org/eclipse/jpt/core/context/PersistentType.java b/jpa/plugins/org.eclipse.jpt.core/src/org/eclipse/jpt/core/context/PersistentType.java deleted file mode 100644 index 756d05b4af..0000000000 --- a/jpa/plugins/org.eclipse.jpt.core/src/org/eclipse/jpt/core/context/PersistentType.java +++ /dev/null @@ -1,212 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2006, 2010 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; - -import java.util.Iterator; -import java.util.List; -import java.util.ListIterator; -import org.eclipse.jdt.core.IPackageFragment; -import org.eclipse.jpt.core.JpaStructureNode; -import org.eclipse.wst.validation.internal.provisional.core.IMessage; -import org.eclipse.wst.validation.internal.provisional.core.IReporter; - -/** - * Context persistent type. - * <p> - * 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. - * - * @version 3.0 - * @since 2.0 - */ -public interface PersistentType - extends JpaContextNode, JpaStructureNode, AccessHolder -{ - - // ********** name ********** - - /** - * Return the persistent type's [fully-qualified] name. - * The enclosing type separator is '.', as opposed to '$'. - * @see #getShortName() - */ - String getName(); - String NAME_PROPERTY = "name"; //$NON-NLS-1$ - - /** - * Return the persistent type's short name. - * @see #getName() - */ - String getShortName(); - - - // ********** mapping ********** - - /** - * Return the persistent type's mapping. - * Set the mapping via {@link #setMappingKey(String)}. - */ - TypeMapping getMapping(); - String MAPPING_PROPERTY = "mapping"; //$NON-NLS-1$ - - String getMappingKey(); - - void setMappingKey(String key); - - boolean isMapped(); - - - // ********** attributes ********** - - /** - * Return the persistent type's persistent attributes. - */ - <T extends PersistentAttribute> ListIterator<T> attributes(); - String ATTRIBUTES_LIST = "attributes"; //$NON-NLS-1$ - - /** - * Return the number of the persistent type's persistent attributes. - */ - int attributesSize(); - - /** - * Return the names of the persistent type's persistent attributes. - */ - Iterator<String> attributeNames(); - - /** - * Return all the persistent attributes in the persistent type's - * inheritance hierarchy. - */ - Iterator<PersistentAttribute> allAttributes(); - - /** - * Return the names of all the persistent attributes in the - * persistent type's hierarchy. - */ - Iterator<String> allAttributeNames(); - - /** - * Return the persistent attribute with the specified name, - * if it exists locally on the persistent type (as opposed to in its - * inheritance hierarchy). - */ - PersistentAttribute getAttributeNamed(String attributeName); - - /** - * Resolve and return the persistent attribute with the specified name, if it - * is distinct and exists within the context of the persistent type. - */ - PersistentAttribute resolveAttribute(String attributeName); - - - // ********** inheritance ********** - - /** - * Return the "super" {@link PersistentType} from the "persistence" - * inheritance hierarchy. - * If the Java inheritance parent is not a {@link PersistentType}, then continue - * up the hierarchy (the JPA spec allows non-persistent types to be part of the hierarchy.) - * Return <code>null</code> if the persistent type is the root persistent type. - * <p> - * Example: - * <pre> - * @Entity - * public abstract class Model {} - * - * public abstract class Animal extends Model {} - * - * @Entity - * public class Cat extends Animal {} - * </pre> - * The "super" persistent type of the <code>Cat</code> persistent type is - * the <code>Model</code> persistent type. The "super" persistent type can - * be either a Java annotated class or declared in the XML files. - */ - PersistentType getSuperPersistentType(); - String SUPER_PERSISTENT_TYPE_PROPERTY = "superPersistentType"; //$NON-NLS-1$ - - /** - * Return the persistent type's "persistence" inheritance hierarchy, - * <em>including</em> the persistent type itself. - * The returned iterator will return elements infinitely if the hierarchy - * has a loop. - */ - Iterator<PersistentType> inheritanceHierarchy(); - - /** - * Return the persistent type's "persistence" inheritance hierarchy, - * <em>excluding</em> the persistent type itself. - * The returned iterator will return elements infinitely if the hierarchy - * has a loop. - */ - Iterator<PersistentType> ancestors(); - - - // ********** validation ********** - - /** - * Add to the list of current validation messages - */ - void validate(List<IMessage> messages, IReporter reporter); - - - // ********** misc ********** - - /** - * Return whether the persistent type applies to the - * specified type name qualified with '.'. - */ - boolean isFor(String typeName); - - /** - * Return true if persistent type resolves to a java class in the given package fragment - */ - boolean isIn(IPackageFragment packageFragment); - - - // ********** owner ********** - - /** - * Return the access type that overrides the client persistent type's - * access type; <code>null</code> if there is no such access override. - */ - AccessType getOwnerOverrideAccess(); - - /** - * Return the client persistent type's default access type; - * <code>null</code> if there is no such access default. - */ - AccessType getOwnerDefaultAccess(); - - - // ********** owner interface ********** - - interface Owner - extends JpaContextNode - { - /** - * Return the access type that overrides the client persistent type's - * access type; <code>null</code> if there is no such access override - */ - AccessType getOverridePersistentTypeAccess(); - - /** - * Return the client persistent type's default access type; - * <code>null</code> if there is no such access default. - */ - AccessType getDefaultPersistentTypeAccess(); - - } - -} |