/*******************************************************************************
 * Copyright (c) 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.jpa2.context;

import org.eclipse.jpt.core.context.PersistentAttribute;

/**
 * JPA 2.0 persistent attribute (field or property)
 * <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.
 */
public interface PersistentAttribute2_0
	extends PersistentAttribute
{
	/**
	 * Return the name of the container type to be used in the metamodel field
	 * declaration corresponding to the attribute's mapping.
	 */
	String getMetamodelContainerFieldTypeName();

	/**
	 * Return the name of the container map key type to be used in the
	 * metamodel field declaration corresponding to the attribute's mapping.
	 * Return null if the attribute's type is not {@link java.util.Map}.
	 */
	String getMetamodelContainerFieldMapKeyTypeName();

	/**
	 * Return the attribute's type name for the metamodel.
	 */
	String getMetamodelTypeName();
}