EclipseLink 2.5.0, build 'v20130507-3faac2b' API Reference

org.eclipse.persistence.jpa.jpql.tools.spi
Interface IManagedType

All Superinterfaces:
java.lang.Comparable<IManagedType>
All Known Subinterfaces:
IEmbeddable, IEntity, IMappedSuperclass
All Known Implementing Classes:
CollectionValuedFieldResolver.MapManagedType, FromSubqueryResolver.VirtualManagedType, JavaEmbeddable, JavaEntity, JavaManagedType, JavaMappedSuperclass, StateFieldPathExpressionStateObject.MapManagedType

public interface IManagedType
extends java.lang.Comparable<IManagedType>

The external representation of a managed type, which is a JPA persistent object.

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:
2.5
See Also:
IEmbeddable, IEntity, IMappedSuperclass
Author:
Pascal Filion
Since:
2.3

Method Summary
 void accept(IManagedTypeVisitor visitor)
          Visits this managed type with the given visitor.
 IMapping getMappingNamed(java.lang.String name)
          Returns the IMapping with the given name.
 IManagedTypeProvider getProvider()
          Retrieves the owner of this managed type.
 IType getType()
          Returns the external representation of the class used by this managed type.
 java.lang.Iterable<IMapping> mappings()
          Returns the collection of mappings defined in this managed type.
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

accept

void accept(IManagedTypeVisitor visitor)
Visits this managed type with the given visitor.

Parameters:
visitor - The visitor to visit this managed type object

getMappingNamed

IMapping getMappingNamed(java.lang.String name)
Returns the IMapping with the given name.

Parameters:
name - The name of the mapping to retrieve
Returns:
Either the IMapping or null if it could not be found

getProvider

IManagedTypeProvider getProvider()
Retrieves the owner of this managed type.

Returns:
The external form holding onto the JPA managed types

getType

IType getType()
Returns the external representation of the class used by this managed type.

Returns:
The external representation of the class used by this managed type

mappings

java.lang.Iterable<IMapping> mappings()
Returns the collection of mappings defined in this managed type.

Returns:
The collection of persistent fields and properties of this managed type

EclipseLink 2.5.0, build 'v20130507-3faac2b' API Reference