jpa/plugins/org.eclipse.jpt.jpa.core/src/org/eclipse/jpt/jpa/core/context/orm/EntityMappings.java - dali/webtools.dali - Git at Google

 /*******************************************************************************
  * Copyright (c) 2007, 2012 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.jpa.core.context.orm;

 import org.eclipse.jdt.core.IPackageFragment;
 import org.eclipse.jdt.core.IType;
 import org.eclipse.jpt.common.core.resource.java.JavaResourceAbstractType;
 import org.eclipse.jpt.common.utility.internal.iterables.ListIterable;
 import org.eclipse.jpt.jpa.core.context.AccessHolder;
 import org.eclipse.jpt.jpa.core.context.Generator;
 import org.eclipse.jpt.jpa.core.context.MappingFileRoot;
 import org.eclipse.jpt.jpa.core.context.PersistentType;
 import org.eclipse.jpt.jpa.core.context.Query;
 import org.eclipse.jpt.jpa.core.resource.orm.XmlEntityMappings;
 import org.eclipse.jpt.jpa.db.Catalog;
 import org.eclipse.jpt.jpa.db.Schema;
 import org.eclipse.jpt.jpa.db.SchemaContainer;
 import org.eclipse.text.edits.DeleteEdit;
 import org.eclipse.text.edits.ReplaceEdit;

 /**
  * Context model corresponding to the
  * XML resource model {@link XmlEntityMappings},
  * which corresponds to the <code>entity-mappings</code> element
  * in the <code>orm.xml</code> file.
  * <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 EntityMappings
 	extends MappingFileRoot, PersistentType.Owner, AccessHolder
 {
 	/**
 	 * Covariant override.
 	 */
 	OrmXml getParent();

 	XmlEntityMappings getXmlEntityMappings();

 	// TODO bjv add version constants
 	String getVersion();

 	String getDescription();
 	void setDescription(String description);
 		String DESCRIPTION_PROPERTY = "description"; //$NON-NLS-1$

 	/**
 	 * "The <code>package</code> subelement specifies the package of the
 	 * classes listed within the subelements and attributes of the same mapping
 	 * file only. The <code>package</code> subelement is overridden if the fully
 	 * qualified class name is specified for a class and the two disagree."
 	 * <p>
 	 * Partial packages are not supported. The package element should only be used
 	 * if a class is not qualified (does not have a '.')
 	 *
 	 * <strong>NB:</strong> No mention of how to resolve duplicates in the
 	 * "default" package:<ul>
 	 * <li><code>Bar</code> (in "default" package) vs. <code>foo.Bar</code>
 	 * </ul>
 	 * when package is specified as <code>foo</code>.
 	 */
 	String getPackage();
 	void setPackage(String package_);
 		String PACKAGE_PROPERTY = "package"; //$NON-NLS-1$

 	/**
 	 * Return the database schema container, which can be either a catalog or,
 	 * if the database does not support catalogs, the database itself.
 	 */
 	SchemaContainer getDbSchemaContainer();

 	String getSpecifiedCatalog();
 	void setSpecifiedCatalog(String catalog);
 		String SPECIFIED_CATALOG_PROPERTY = "specifiedCatalog"; //$NON-NLS-1$
 	String getDefaultCatalog();
 		String DEFAULT_CATALOG_PROPERTY = "defaultCatalog"; //$NON-NLS-1$
 	Catalog getDbCatalog();

 	String getSpecifiedSchema();
 	void setSpecifiedSchema(String schema);
 		String SPECIFIED_SCHEMA_PROPERTY = "specifiedSchema"; //$NON-NLS-1$
 	String getDefaultSchema();
 		String DEFAULT_SCHEMA_PROPERTY = "defaultSchema"; //$NON-NLS-1$
 	Schema getDbSchema();

 	/**
 	 * Covariant override.
 	 */
 	OrmPersistenceUnitMetadata getPersistenceUnitMetadata();

 	/**
 	 * Covariant override.
 	 */
 	ListIterable<OrmPersistentType> getPersistentTypes();
 	OrmPersistentType getPersistentType(String className);
 	int getPersistentTypesSize();
 	OrmPersistentType addPersistentType(String mappingKey, String className);
 	void removePersistentType(int index);
 	void removePersistentType(OrmPersistentType persistentType);
 	//void movePersistentType(int targetIndex, int sourceIndex);
 	boolean containsPersistentType(String className);
 		String PERSISTENT_TYPES_LIST = "persistentTypes"; //$NON-NLS-1$

 	ListIterable<OrmSequenceGenerator> getSequenceGenerators();
 	int getSequenceGeneratorsSize();
 	OrmSequenceGenerator addSequenceGenerator();
 	OrmSequenceGenerator addSequenceGenerator(int index);
 	void removeSequenceGenerator(int index);
 	void removeSequenceGenerator(OrmSequenceGenerator sequenceGenerator);
 	void moveSequenceGenerator(int targetIndex, int sourceIndex);
 		String SEQUENCE_GENERATORS_LIST = "sequenceGenerators"; //$NON-NLS-1$

 	ListIterable<OrmTableGenerator> getTableGenerators();
 	int getTableGeneratorsSize();
 	OrmTableGenerator addTableGenerator();
 	OrmTableGenerator addTableGenerator(int index);
 	void removeTableGenerator(int index);
 	void removeTableGenerator(OrmTableGenerator tableGenerator);
 	void moveTableGenerator(int targetIndex, int sourceIndex);
 		String TABLE_GENERATORS_LIST = "tableGenerators"; //$NON-NLS-1$

 	OrmQueryContainer getQueryContainer();

 	/**
 	 * Return all the queries defined in both the entity mappings and its
 	 * entities (but <em>not</em> in any associated Java annotations).
 	 */
 	Iterable<Query> getMappingFileQueries();

 	/**
 	 * Return all the generators defined in both the entity mappings and its
 	 * type mappings (but <em>not</em> in any associated Java annotations).
 	 */
 	Iterable<Generator> getMappingFileGenerators();

 	/**
 	 * Return the default package to be used for persistent types in this
 	 * context.
 	 */
 	String getDefaultPersistentTypePackage();

 	void changeMapping(OrmPersistentType ormPersistentType, OrmTypeMapping oldMapping, OrmTypeMapping newMapping);

 	boolean containsOffset(int textOffset);

 	/**
 	 * Return the Java resource type for the specified class name
 	 * found in the JPA project. Prepend the default package name
 	 * if the class name is not fully qualified (does not contain a '.').
 	 *
 	 * @see #getPackage()
 	 */
 	JavaResourceAbstractType resolveJavaResourceType(String className);

 	/**
 	 * Return the Java resource type for the specified class name and kind
 	 * found in the JPA project. Prepend the default package name
 	 * if the class name is not fully qualified (does not contain a '.').
 	 *
 	 * Return null if invalid or absent or if the kind does not match.
 	 *
 	 * @see #getPackage()
 	 */
 	JavaResourceAbstractType resolveJavaResourceType(String className, JavaResourceAbstractType.Kind kind);

 	/**
 	 * Return the persistent type for the specified class name
 	 * found in the persistence unit. Prepend the default package name
 	 * if the class name is not fully qualified (does not contain a '.').
 	 *
 	 * @see #getPackage()
 	 */
 	PersistentType resolvePersistentType(String className);

 	/**
 	 * Return the JDT IType resource type for the specified class name
 	 * found in the Java project. Prepend the default package name
 	 * if the class name is not fully qualified (does not contain a '.').
 	 *
 	 * @see #getPackage()
 	 */
 	IType resolveJdtType(String className);

 	/**
 	 * If the specified class name is not qualified (does not contain a '.')
 	 * then prepend the default package name. Inner classes must
 	 * be specified with a '$' for this to work.
 	 *
 	 * @see #getPackage()
 	 */
 	String getFullyQualifiedName(String className);


 	// ********** refactoring **********

 	/**
 	 * Create DeleteEdits for deleting references (if any) to the type about to be deleted.
 	 * Return an EmptyIterable if there are not any references to the given type.
 	 */
 	Iterable<DeleteEdit> createDeleteTypeEdits(IType type);

 	/**
 	 * Create ReplaceEdits for renaming any references to the originalType to the newName.
 	 * The originalType has not yet been renamed, the newName is the new short name.
 	 */
 	Iterable<ReplaceEdit> createRenameTypeEdits(IType originalType, String newName);

 	/**
 	 * Create ReplaceEdits for moving any references to the originalType to the newPackage.
 	 * The originalType has not yet been moved.
 	 */
 	Iterable<ReplaceEdit> createMoveTypeEdits(IType originalType, IPackageFragment newPackage);

 	/**
 	 * Create ReplaceEdits for renaming any references to the originalPackage to the newName.
 	 * The originalPackage has not yet been renamed.
 	 */
 	Iterable<ReplaceEdit> createRenamePackageEdits(IPackageFragment originalPackage, String newName);
 }
	/*******************************************************************************
	* Copyright (c) 2007, 2012 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.jpa.core.context.orm;

	import org.eclipse.jdt.core.IPackageFragment;
	import org.eclipse.jdt.core.IType;
	import org.eclipse.jpt.common.core.resource.java.JavaResourceAbstractType;
	import org.eclipse.jpt.common.utility.internal.iterables.ListIterable;
	import org.eclipse.jpt.jpa.core.context.AccessHolder;
	import org.eclipse.jpt.jpa.core.context.Generator;
	import org.eclipse.jpt.jpa.core.context.MappingFileRoot;
	import org.eclipse.jpt.jpa.core.context.PersistentType;
	import org.eclipse.jpt.jpa.core.context.Query;
	import org.eclipse.jpt.jpa.core.resource.orm.XmlEntityMappings;
	import org.eclipse.jpt.jpa.db.Catalog;
	import org.eclipse.jpt.jpa.db.Schema;
	import org.eclipse.jpt.jpa.db.SchemaContainer;
	import org.eclipse.text.edits.DeleteEdit;
	import org.eclipse.text.edits.ReplaceEdit;

	/**
	* Context model corresponding to the
	* XML resource model {@link XmlEntityMappings},
	* which corresponds to the <code>entity-mappings</code> element
	* in the <code>orm.xml</code> file.
	* <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 EntityMappings
	extends MappingFileRoot, PersistentType.Owner, AccessHolder
	{
	/**
	* Covariant override.
	*/
	OrmXml getParent();

	XmlEntityMappings getXmlEntityMappings();

	// TODO bjv add version constants
	String getVersion();

	String getDescription();
	void setDescription(String description);
	String DESCRIPTION_PROPERTY = "description"; //$NON-NLS-1$

	/**
	* "The <code>package</code> subelement specifies the package of the
	* classes listed within the subelements and attributes of the same mapping
	* file only. The <code>package</code> subelement is overridden if the fully
	* qualified class name is specified for a class and the two disagree."
	* <p>
	* Partial packages are not supported. The package element should only be used
	* if a class is not qualified (does not have a '.')
	*
	* <strong>NB:</strong> No mention of how to resolve duplicates in the
	* "default" package:<ul>
	* <li><code>Bar</code> (in "default" package) vs. <code>foo.Bar</code>
	* </ul>
	* when package is specified as <code>foo</code>.
	*/
	String getPackage();
	void setPackage(String package_);
	String PACKAGE_PROPERTY = "package"; //$NON-NLS-1$

	/**
	* Return the database schema container, which can be either a catalog or,
	* if the database does not support catalogs, the database itself.
	*/
	SchemaContainer getDbSchemaContainer();

	String getSpecifiedCatalog();
	void setSpecifiedCatalog(String catalog);
	String SPECIFIED_CATALOG_PROPERTY = "specifiedCatalog"; //$NON-NLS-1$
	String getDefaultCatalog();
	String DEFAULT_CATALOG_PROPERTY = "defaultCatalog"; //$NON-NLS-1$
	Catalog getDbCatalog();

	String getSpecifiedSchema();
	void setSpecifiedSchema(String schema);
	String SPECIFIED_SCHEMA_PROPERTY = "specifiedSchema"; //$NON-NLS-1$
	String getDefaultSchema();
	String DEFAULT_SCHEMA_PROPERTY = "defaultSchema"; //$NON-NLS-1$
	Schema getDbSchema();

	/**
	* Covariant override.
	*/
	OrmPersistenceUnitMetadata getPersistenceUnitMetadata();

	/**
	* Covariant override.
	*/
	ListIterable<OrmPersistentType> getPersistentTypes();
	OrmPersistentType getPersistentType(String className);
	int getPersistentTypesSize();
	OrmPersistentType addPersistentType(String mappingKey, String className);
	void removePersistentType(int index);
	void removePersistentType(OrmPersistentType persistentType);
	//void movePersistentType(int targetIndex, int sourceIndex);
	boolean containsPersistentType(String className);
	String PERSISTENT_TYPES_LIST = "persistentTypes"; //$NON-NLS-1$

	ListIterable<OrmSequenceGenerator> getSequenceGenerators();
	int getSequenceGeneratorsSize();
	OrmSequenceGenerator addSequenceGenerator();
	OrmSequenceGenerator addSequenceGenerator(int index);
	void removeSequenceGenerator(int index);
	void removeSequenceGenerator(OrmSequenceGenerator sequenceGenerator);
	void moveSequenceGenerator(int targetIndex, int sourceIndex);
	String SEQUENCE_GENERATORS_LIST = "sequenceGenerators"; //$NON-NLS-1$

	ListIterable<OrmTableGenerator> getTableGenerators();
	int getTableGeneratorsSize();
	OrmTableGenerator addTableGenerator();
	OrmTableGenerator addTableGenerator(int index);
	void removeTableGenerator(int index);
	void removeTableGenerator(OrmTableGenerator tableGenerator);
	void moveTableGenerator(int targetIndex, int sourceIndex);
	String TABLE_GENERATORS_LIST = "tableGenerators"; //$NON-NLS-1$

	OrmQueryContainer getQueryContainer();

	/**
	* Return all the queries defined in both the entity mappings and its
	* entities (but <em>not</em> in any associated Java annotations).
	*/
	Iterable<Query> getMappingFileQueries();

	/**
	* Return all the generators defined in both the entity mappings and its
	* type mappings (but <em>not</em> in any associated Java annotations).
	*/
	Iterable<Generator> getMappingFileGenerators();

	/**
	* Return the default package to be used for persistent types in this
	* context.
	*/
	String getDefaultPersistentTypePackage();

	void changeMapping(OrmPersistentType ormPersistentType, OrmTypeMapping oldMapping, OrmTypeMapping newMapping);

	boolean containsOffset(int textOffset);

	/**
	* Return the Java resource type for the specified class name
	* found in the JPA project. Prepend the default package name
	* if the class name is not fully qualified (does not contain a '.').
	*
	* @see #getPackage()
	*/
	JavaResourceAbstractType resolveJavaResourceType(String className);

	/**
	* Return the Java resource type for the specified class name and kind
	* found in the JPA project. Prepend the default package name
	* if the class name is not fully qualified (does not contain a '.').
	*
	* Return null if invalid or absent or if the kind does not match.
	*
	* @see #getPackage()
	*/
	JavaResourceAbstractType resolveJavaResourceType(String className, JavaResourceAbstractType.Kind kind);

	/**
	* Return the persistent type for the specified class name
	* found in the persistence unit. Prepend the default package name
	* if the class name is not fully qualified (does not contain a '.').
	*
	* @see #getPackage()
	*/
	PersistentType resolvePersistentType(String className);

	/**
	* Return the JDT IType resource type for the specified class name
	* found in the Java project. Prepend the default package name
	* if the class name is not fully qualified (does not contain a '.').
	*
	* @see #getPackage()
	*/
	IType resolveJdtType(String className);

	/**
	* If the specified class name is not qualified (does not contain a '.')
	* then prepend the default package name. Inner classes must
	* be specified with a '$' for this to work.
	*
	* @see #getPackage()
	*/
	String getFullyQualifiedName(String className);


	// ******** refactoring ********

	/**
	* Create DeleteEdits for deleting references (if any) to the type about to be deleted.
	* Return an EmptyIterable if there are not any references to the given type.
	*/
	Iterable<DeleteEdit> createDeleteTypeEdits(IType type);

	/**
	* Create ReplaceEdits for renaming any references to the originalType to the newName.
	* The originalType has not yet been renamed, the newName is the new short name.
	*/
	Iterable<ReplaceEdit> createRenameTypeEdits(IType originalType, String newName);

	/**
	* Create ReplaceEdits for moving any references to the originalType to the newPackage.
	* The originalType has not yet been moved.
	*/
	Iterable<ReplaceEdit> createMoveTypeEdits(IType originalType, IPackageFragment newPackage);

	/**
	* Create ReplaceEdits for renaming any references to the originalPackage to the newName.
	* The originalPackage has not yet been renamed.
	*/
	Iterable<ReplaceEdit> createRenamePackageEdits(IPackageFragment originalPackage, String newName);
	}