org.eclipse.persistence.jpa.jpql.spi.IMapping Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2006, 2013 Oracle and/or its affiliates. All rights reserved.
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
* which accompanies this distribution.
* The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
* and the Eclipse Distribution License is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* Contributors:
* Oracle - initial API and implementation
*
******************************************************************************/
package org.eclipse.persistence.jpa.jpql.spi;
import java.lang.annotation.Annotation;
/**
* The external representation of a mapping, which represents a single persistence property
* of a managed type.
*
* @see IManagedType
*
* @version 2.4
* @since 2.3
* @author Pascal Filion
*/
public interface IMapping extends IExternalForm,
Comparable {
/**
* Returns the type of this mapping.
*
* @return One of the supported mapping type, which is one of the constants defined in {@link
* org.eclipse.persistence.jpa.jpql.spi.IMappingType IMappingType} when the provider only
* supports generic JPA
*/
int getMappingType();
/**
* Returns the name of the persistence property represented by this mapping.
*
* @return The name of this mapping
*/
String getName();
/**
* Returns the parent managed type owning this mapping.
*
* @return The parent of this mapping
*/
IManagedType getParent();
/**
* Returns the type of this mapping. If this mapping is a relationship mapping, the parameter
* type of the collection is returned.
*
* @OneToMany
private Collection<Employee> employees;
*
* "Employee" is the type. To retrieve {@link java.util.Collection}, {@link #getTypeDeclaration()}
* needs to be used, its type will be {@link java.util.Collection} and it's generic type will be
* Employee.
*
* @return The external form representing the type of this mapping
*/
IType getType();
/**
* Returns the declaration of the Java class, which gives the information about type parameters,
* dimensionality, etc.
*
* @OneToMany
private Collection<Employee> employees;
*
* "Collection<Employee>" is the type declaration.
*
* @return The external form of the class' type declaration
*/
ITypeDeclaration getTypeDeclaration();
/**
* Determines whether the given annotation is present on this type.
*
* @param annotationType The class of the annotation
* @return true if the annotation is defined on this type; false
* otherwise
*/
boolean hasAnnotation(Class annotationType);
/**
* Determines whether this {@link IMapping} is a collection type mapping.
*
* @return true if this {@link IMapping} is a collection mapping;
* false otherwise
* @since 2.4
*/
boolean isCollection();
/**
* Determines whether this {@link IMapping} is a property type mapping.
*
* @return true if this {@link IMapping} is a property mapping; false
* otherwise
* @since 2.4
*/
boolean isProperty();
/**
* Determines whether this {@link IMapping} is a relationship type mapping.
*
* @return true if this {@link IMapping} is a relationship mapping;
* false otherwise
* @since 2.4
*/
boolean isRelationship();
/**
* Determines whether this {@link IMapping} is a transient mapping.
*
* @return true if this {@link IMapping} is a transient mapping;
* false otherwise
* @since 2.4
*/
boolean isTransient();
}