org.eclipse.persistence.jpa.jpql.spi

Interface IManagedTypeProvider

All Known Implementing Classes:

JavaManagedTypeProvider

public interface IManagedTypeProvider

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

Since:

2.3

Version:

2.4

Author:

Pascal Filion

See Also:

IManagedType

Method Summary

Modifier and Type	Method and Description
IterableIterator<IEntity>	entities() Returns the collection of possible abstract schema types.
IEmbeddable	getEmbeddable(IType type) Retrieves the IEmbeddable with the given IType.
IEmbeddable	getEmbeddable(java.lang.String typeName) Retrieves the IEmbeddable for the given fully qualified type name.
IEntity	getEntity(IType type) Retrieves the IEntity with the given IType.
IEntity	getEntity(java.lang.String typeName) Retrieves the IEntity with the given name.
IEntity	getEntityNamed(java.lang.String entityName) Retrieves the IEntity with the given entity name.
IManagedType	getManagedType(IType type) Retrieves the IManagedType for the given IType.
IManagedType	getManagedType(java.lang.String typeName) Retrieves the IManagedType for the given fully qualified type name.
IMappedSuperclass	getMappedSuperclass(IType type) Retrieves the IEmbeddable with the given IType.
IMappedSuperclass	getMappedSuperclass(java.lang.String typeName) Retrieves the IMappedSuperclass for the given fully qualified type name.
ITypeRepository	getTypeRepository() Returns the type repository for the application.
IterableIterator<IManagedType>	managedTypes() Returns the managed types available within the context of this provider.

Method Detail

entities

IterableIterator<IEntity> entities()

Returns the collection of possible abstract schema types.

Returns:

The entities defined in the persistence context

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(java.lang.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(java.lang.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(String)

getEntityNamed

IEntity getEntityNamed(java.lang.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:

getEntity(String)

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(java.lang.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

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(java.lang.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

IterableIterator<IManagedType> managedTypes()

Returns the managed types available within the context of this provider.

Returns:

The managed types owned by this provider