Interface IManagedTypeProvider
-
public interface IManagedTypeProviderThe 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.
- Version:
- 2.5
- See Also:
IManagedType- Author:
- Pascal Filion
- Since:
- 2.3
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Iterable<IEntity>entities()Returns the collection of possible abstract schema types.IEmbeddablegetEmbeddable(java.lang.String typeName)Retrieves theIEmbeddablefor the given fully qualified type name.IEmbeddablegetEmbeddable(IType type)Retrieves theIEmbeddablewith the givenIType.IEntitygetEntity(java.lang.String typeName)Retrieves theIEntitywith the given name.IEntitygetEntity(IType type)IEntitygetEntityNamed(java.lang.String entityName)Retrieves theIEntitywith the given entity name.IManagedTypegetManagedType(java.lang.String typeName)Retrieves theIManagedTypefor the given fully qualified type name.IManagedTypegetManagedType(IType type)Retrieves theIManagedTypefor the givenIType.IMappedSuperclassgetMappedSuperclass(java.lang.String typeName)Retrieves theIMappedSuperclassfor the given fully qualified type name.IMappedSuperclassgetMappedSuperclass(IType type)Retrieves theIEmbeddablewith the givenIType.ITypeRepositorygetTypeRepository()Returns the type repository for the application.java.lang.Iterable<IManagedType>managedTypes()Returns the managed types available within the context of this provider.
-
-
-
Method Detail
-
entities
java.lang.Iterable<IEntity> entities()
Returns the collection of possible abstract schema types.- Returns:
- The
entitiesdefined in the persistence context
-
getEmbeddable
IEmbeddable getEmbeddable(IType type)
Retrieves theIEmbeddablewith the givenIType.- Parameters:
type- TheITypeof theIEmbeddableto retrieve- Returns:
- The
IEmbeddablefor the givenITypeif it's representing an embeddable; otherwisenull - Since:
- 2.4
-
getEmbeddable
IEmbeddable getEmbeddable(java.lang.String typeName)
Retrieves theIEmbeddablefor the given fully qualified type name.- Parameters:
typeName- The fully qualified type name of theIEmbeddableto retrieve- Returns:
- The
IEmbeddablethat has the given type name; otherwisenull - Since:
- 2.4
-
getEntity
IEntity getEntity(java.lang.String typeName)
Retrieves theIEntitywith the given name.- Parameters:
typeName- The fully qualified type name of theIEntityto retrieve- Returns:
- The
IEntitywith the given name; otherwisenull - See Also:
getEntityNamed(String)- Since:
- 2.4
-
getEntityNamed
IEntity getEntityNamed(java.lang.String entityName)
Retrieves theIEntitywith the given entity name.- Parameters:
entityName- The abstract schema name of theIEntityto retrieve- Returns:
- The
IEntitywith the given abstract schema name; otherwisenull - See Also:
getEntity(String)- Since:
- 2.4
-
getManagedType
IManagedType getManagedType(IType type)
Retrieves theIManagedTypefor the givenIType.- Parameters:
type- The type that is used as a managed type- Returns:
- The
IManagedTypefor the given type, if one exists,nullotherwise
-
getManagedType
IManagedType getManagedType(java.lang.String typeName)
Retrieves theIManagedTypefor the given fully qualified type name.- Parameters:
typeName- The fully qualified type name of theIManagedTypeto retrieve- Returns:
- The
IManagedTypefor the given type, if one exists,nullotherwise
-
getMappedSuperclass
IMappedSuperclass getMappedSuperclass(IType type)
Retrieves theIEmbeddablewith the givenIType.- Parameters:
type- TheITypeof theIMappedSuperclassto retrieve- Returns:
- The
IMappedSuperclassfor the givenITypeif it's representing a mapped superclass; otherwisenull - Since:
- 2.4
-
getMappedSuperclass
IMappedSuperclass getMappedSuperclass(java.lang.String typeName)
Retrieves theIMappedSuperclassfor the given fully qualified type name.- Parameters:
typeName- The fully qualified type name of theIMappedSuperclassto retrieve- Returns:
- The
IMappedSuperclassthat has the given type name; otherwisenull - Since:
- 2.4
-
getTypeRepository
ITypeRepository getTypeRepository()
Returns the type repository for the application.- Returns:
- The repository of
ITypes
-
managedTypes
java.lang.Iterable<IManagedType> managedTypes()
Returns the managed types available within the context of this provider.- Returns:
- The managed types owned by this provider
-
-