Module org.eclipse.persistence.jpa.jpql
Package org.eclipse.persistence.jpa.jpql.tools.spi

Interface IManagedTypeProvider

public interface IManagedTypeProvider
The external representation of the provider of managed types, which provide access to the JPA domain model.

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.

Since:
2.3
Version:
2.5
See Also:

  • Method Details

    • entities

      Iterable<IEntity> entities()
      Returns the collection of possible abstract schema types.
      Returns:
      The entities defined in the persistence context
      Since:
      2.4

    • getEmbeddable

      IEmbeddable getEmbeddable(IType type)
      Retrieves the IEmbeddable with the given IType.
      Parameters:
      type - The IType of the IEmbeddable to retrieve
      Returns:
      The IEmbeddable for the given IType if it's representing an embeddable; otherwise null
      Since:
      2.4

    • getEmbeddable

      IEmbeddable getEmbeddable(String typeName)
      Retrieves the IEmbeddable for the given fully qualified type name.
      Parameters:
      typeName - The fully qualified type name of the IEmbeddable to retrieve
      Returns:
      The IEmbeddable that has the given type name; otherwise null
      Since:
      2.4

    • getEntity

      IEntity getEntity(IType type)
      Retrieves the IEntity with the given IType.
      Parameters:
      type - The IType of the IEntity to retrieve
      Returns:
      The IEntity for the given IType if it's representing an entity; otherwise null
      Since:
      2.4

    • getEntity

      IEntity getEntity(String typeName)
      Retrieves the IEntity with the given name.
      Parameters:
      typeName - The fully qualified type name of the IEntity to retrieve
      Returns:
      The IEntity with the given name; otherwise null
      Since:
      2.4
      See Also:

    • getEntityNamed

      IEntity getEntityNamed(String entityName)
      Retrieves the IEntity with the given entity name.
      Parameters:
      entityName - The abstract schema name of the IEntity to retrieve
      Returns:
      The IEntity with the given abstract schema name; otherwise null
      Since:
      2.4
      See Also:

    • getManagedType

      IManagedType getManagedType(IType type)
      Retrieves the IManagedType for the given IType.
      Parameters:
      type - The type that is used as a managed type
      Returns:
      The IManagedType for the given type, if one exists, null otherwise

    • getManagedType

      IManagedType getManagedType(String typeName)
      Retrieves the IManagedType for the given fully qualified type name.
      Parameters:
      typeName - The fully qualified type name of the IManagedType to retrieve
      Returns:
      The IManagedType for the given type, if one exists, null otherwise
      Since:
      2.4

    • getMappedSuperclass

      IMappedSuperclass getMappedSuperclass(IType type)
      Retrieves the IEmbeddable with the given IType.
      Parameters:
      type - The IType of the IMappedSuperclass to retrieve
      Returns:
      The IMappedSuperclass for the given IType if it's representing a mapped superclass; otherwise null
      Since:
      2.4

    • getMappedSuperclass

      IMappedSuperclass getMappedSuperclass(String typeName)
      Retrieves the IMappedSuperclass for the given fully qualified type name.
      Parameters:
      typeName - The fully qualified type name of the IMappedSuperclass to retrieve
      Returns:
      The IMappedSuperclass that has the given type name; otherwise null
      Since:
      2.4

    • getTypeRepository

      ITypeRepository getTypeRepository()
      Returns the type repository for the application.
      Returns:
      The repository of ITypes

    • managedTypes

      Iterable<IManagedType> managedTypes()
      Returns the managed types available within the context of this provider.
      Returns:
      The managed types owned by this provider