Top Description Methods
org.eclipse.persistence.jpa.jpql.tools.spi

public Interface IManagedTypeProvider

extends IExternalForm
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.

Author
Pascal Filion
Since
2.3
Version
2.5
See Also
IManagedType

Method Summary

Modifier and TypeMethod and Description
public Iterable<IEntity>

Returns:

The entities defined in the persistence context
entities()

Returns the collection of possible abstract schema types.

public IEmbeddable

Returns:

The IEmbeddable for the given IType if it's representing an embeddable; otherwise null
getEmbeddable(IType
The IType of the IEmbeddable to retrieve
type)

Retrieves the IEmbeddable with the given IType.

public IEmbeddable

Returns:

The IEmbeddable that has the given type name; otherwise null
getEmbeddable(String
The fully qualified type name of the IEmbeddable to retrieve
typeName)

Retrieves the IEmbeddable for the given fully qualified type name.

public IEntity

Returns:

The IEntity for the given IType if it's representing an entity; otherwise null
getEntity(IType
The IType of the IEntity to retrieve
type)

Retrieves the IEntity with the given IType.

public IEntity

Returns:

The IEntity with the given name; otherwise null
getEntity(String
The fully qualified type name of the IEntity to retrieve
typeName)

Retrieves the IEntity with the given name.

public IEntity

Returns:

The IEntity with the given abstract schema name; otherwise null
getEntityNamed(String
The abstract schema name of the IEntity to retrieve
entityName)

Retrieves the IEntity with the given entity name.

public IManagedType

Returns:

The IManagedType for the given type, if one exists, null otherwise
getManagedType(IType
The type that is used as a managed type
type)

Retrieves the IManagedType for the given IType.

public IManagedType

Returns:

The IManagedType for the given type, if one exists, null otherwise
getManagedType(String
The fully qualified type name of the IManagedType to retrieve
typeName)

Retrieves the IManagedType for the given fully qualified type name.

public IMappedSuperclass

Returns:

The IMappedSuperclass for the given IType if it's representing a mapped superclass; otherwise null
getMappedSuperclass(IType
The IType of the IMappedSuperclass to retrieve
type)

Retrieves the IEmbeddable with the given IType.

public IMappedSuperclass

Returns:

The IMappedSuperclass that has the given type name; otherwise null
getMappedSuperclass(String
The fully qualified type name of the IMappedSuperclass to retrieve
typeName)

Retrieves the IMappedSuperclass for the given fully qualified type name.

public ITypeRepository

Returns:

The repository of ITypes
getTypeRepository()

Returns the type repository for the application.

public Iterable<IManagedType>

Returns:

The managed types owned by this provider
managedTypes()

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

Method Detail

entitiesback to summary
public Iterable<IEntity> entities()

Returns the collection of possible abstract schema types.

Returns:Iterable<IEntity>

The entities defined in the persistence context

Since
2.4
getEmbeddableback to summary
public IEmbeddable getEmbeddable(IType type)

Retrieves the IEmbeddable with the given IType.

Parameters
type:IType

The IType of the IEmbeddable to retrieve

Returns:IEmbeddable

The IEmbeddable for the given IType if it's representing an embeddable; otherwise null

Since
2.4
getEmbeddableback to summary
public IEmbeddable getEmbeddable(String typeName)

Retrieves the IEmbeddable for the given fully qualified type name.

Parameters
typeName:String

The fully qualified type name of the IEmbeddable to retrieve

Returns:IEmbeddable

The IEmbeddable that has the given type name; otherwise null

Since
2.4
getEntityback to summary
public IEntity getEntity(IType type)

Retrieves the IEntity with the given IType.

Parameters
type:IType

The IType of the IEntity to retrieve

Returns:IEntity

The IEntity for the given IType if it's representing an entity; otherwise null

Since
2.4
getEntityback to summary
public IEntity getEntity(String typeName)

Retrieves the IEntity with the given name.

Parameters
typeName:String

The fully qualified type name of the IEntity to retrieve

Returns:IEntity

The IEntity with the given name; otherwise null

Since
2.4
See Also
getEntityNamed(String)
getEntityNamedback to summary
public IEntity getEntityNamed(String entityName)

Retrieves the IEntity with the given entity name.

Parameters
entityName:String

The abstract schema name of the IEntity to retrieve

Returns:IEntity

The IEntity with the given abstract schema name; otherwise null

Since
2.4
See Also
getEntity(String)
getManagedTypeback to summary
public IManagedType getManagedType(IType type)

Retrieves the IManagedType for the given IType.

Parameters
type:IType

The type that is used as a managed type

Returns:IManagedType

The IManagedType for the given type, if one exists, null otherwise

getManagedTypeback to summary
public IManagedType getManagedType(String typeName)

Retrieves the IManagedType for the given fully qualified type name.

Parameters
typeName:String

The fully qualified type name of the IManagedType to retrieve

Returns:IManagedType

The IManagedType for the given type, if one exists, null otherwise

Since
2.4
getMappedSuperclassback to summary
public IMappedSuperclass getMappedSuperclass(IType type)

Retrieves the IEmbeddable with the given IType.

Parameters
type:IType

The IType of the IMappedSuperclass to retrieve

Returns:IMappedSuperclass

The IMappedSuperclass for the given IType if it's representing a mapped superclass; otherwise null

Since
2.4
getMappedSuperclassback to summary
public IMappedSuperclass getMappedSuperclass(String typeName)

Retrieves the IMappedSuperclass for the given fully qualified type name.

Parameters
typeName:String

The fully qualified type name of the IMappedSuperclass to retrieve

Returns:IMappedSuperclass

The IMappedSuperclass that has the given type name; otherwise null

Since
2.4
getTypeRepositoryback to summary
public ITypeRepository getTypeRepository()

Returns the type repository for the application.

Returns:ITypeRepository

The repository of ITypes

managedTypesback to summary
public Iterable<IManagedType> managedTypes()

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

Returns:Iterable<IManagedType>

The managed types owned by this provider