Package org.eclipse.persistence.dynamic

Class DynamicTypeBuilder

  • Direct Known Subclasses:
    JPADynamicTypeBuilder
    public class DynamicTypeBuilder
extends Object
    The EntityTypeBuilder is a factory class for creating and extending dynamic entity types. After being constructed in either usage the application can then use the provided API to customize mapping information of the type.
    Author:
    dclarke, mnorman
    Since:
    EclipseLink 1.2

    • Field Detail

      • entityType

        protected org.eclipse.persistence.internal.dynamic.DynamicTypeImpl entityType
        The type being configured for dynamic use or being created/extended

    • Constructor Detail

      • DynamicTypeBuilder

        public DynamicTypeBuilder​(Class<?> dynamicClass,
                          DynamicType parentType,
                          String... tableNames)
        Create an EntityType for a new dynamic type. The contained EntityType and its wrapped descriptor are not automatically added to any session. This must be done by the application after the type's is fully configured.

        Creating new type Example: DynamicHelper helper = new DynamicHelper(session); DynamicClassLoader dcl = helper.getDynamicClassLoader();

        Class<?> javaType = dcl.creatDynamicClass("model.Simple");

        DynamicTypeBuilder typeBuilder = new JPADynamicTypeBuilder(javaType, null, "SIMPLE_TYPE");
        typeBuilder.setPrimaryKeyFields("SID");
        typeBuilder.addDirectMapping("id", int.class, "SID");
        typeBuilder.addDirectMapping("value1", String.class, "VAL_1");
        typeBuilder.addDirectMapping("value2", boolean.class, "VAL_2");
        typeBuilder.addDirectMapping("value3", Calendar.class, "VAL_3");
        typeBuilder.addDirectMapping("value4", Character.class, "VAL_4");

        helper.addTypes(true, true, typeBuilder.getType());

        Parameters:
        dynamicClass -
        parentType -
        tableNames -

      • DynamicTypeBuilder

        public DynamicTypeBuilder​(DynamicClassLoader dcl,
                          ClassDescriptor descriptor,
                          DynamicType parentType)
        Create an EntityTypeBuilder for an existing descriptor. This is used
        Parameters:
        dcl -
        descriptor -
        parentType - provided since the InheritancePolicy on the descriptor may not have its parent descriptor initialized.

    • Method Detail

      • configure

        protected void configure​(ClassDescriptor descriptor,
                         String... tableNames)
        Initialize a new or existing descriptor configuring the necessary policies as well as

      • setPrimaryKeyFields

        public void setPrimaryKeyFields​(String... pkFieldNames)
        Set the PK field names on the underlying descriptor ensuring no duplicate names are added.
        Parameters:
        pkFieldNames - qualified or unqualified field names

      • addDirectMapping

        public DirectToFieldMapping addDirectMapping​(String name,
                                             Class<?> javaType,
                                             String fieldName)
        Allows DirectToFieldMapping (@Basic) mapping to be added to a dynamic type through API. This method can be used on a new DynamicTypeImpl that has yet to be added to a session and have its descriptor initialized, or it can be called on an active (initialized) descriptor.

        There is no support currently for having the EclipseLink SchemaManager generate ALTER TABLE calls so any new columns expected must be added without the help of EclipseLink or use the SchemaManager.replaceObject(org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition) to DROP and CREATE the table. WARNING: This will cause data loss.

        Parameters:
        javaType - is the type of the attribute. If the type is a primitive it will be converted to the comparable non-primitive type.

      • addOneToManyMapping

        public OneToManyMapping addOneToManyMapping​(String name,
                                            DynamicType refType,
                                            String... fkFieldNames)
        Add a OneToManyMapping to the entityType being built or extended. This mapping is created using standard foreign keys from the source table(s) to the target table(s) and transparent indirection ( IndirectList).
        Parameters:
        name - attribute name to use in the dynamic entity. Also the property name used to access the state of the entity
        refType -
        fkFieldNames - the FK field names specified in the same order to match the PK field names of the target class
        Returns:
        the newly created, configured mappin. It will be initialized if the descriptor is already initialized.

      • addDirectCollectionMapping

        public DirectCollectionMapping addDirectCollectionMapping​(String name,
                                                          String targetTable,
                                                          String valueColumn,
                                                          Class<?> valueType,
                                                          String... fkFieldNames)
                                                   throws IllegalArgumentException
        Add a DirectCollectionMapping to the entityType being built or extended. This mapping is created using standard foreign keys from the target table(s) to the source table(s) and transparent indirection ( IndirectList).
        Parameters:
        name - attribute name to use in the dynamic entity. Also the property name used to access the state of the entity
        targetTable - name of table holding the direct values
        valueColumn - name of column in target table holding the direct value for the collection
        valueType - the type of the attribute assumed to be a known basic type
        fkFieldNames - the FK field names on the source table specified in order to match the PK field names on the source.
        Returns:
        the new mapping configured and initialized (if the descriptor is already initialized.
        Throws:
        IllegalArgumentException

      • addAggregateObjectMapping

        public AggregateObjectMapping addAggregateObjectMapping​(String name,
                                                        DynamicType refType,
                                                        boolean allowsNull)
        Add a AggregateObjectMapping (Embeddable in JPA) to the entityType being built or extended.
        Parameters:
        name - attribute name to use in the dynamic entity. Also the property name used to access the state of the entity
        refType - dynamic type re[presenting the Embeddable/AggregateObject
        allowsNull - true indicates that the attribute can be null if all values are null.
        Returns:
        the new mapping configured and initialized (if the descriptor has been initialized).

      • addManyToManyMapping

        public void addManyToManyMapping​(String name,
                                 DynamicType refType,
                                 String relationshipTableName)
        Add a ManyToManyMapping to the entityType being built or extended. This method assumes that the columns names on the relationship table match the PK columns names they relate to. In the case of the target keys from the relationship table a '_' will be appended to the column names if they collide with the names from the source table.
        Parameters:
        name - attribute name to use in the dynamic entity. Also the property name used to access the state of the entity
        refType - target dynamic entity
        relationshipTableName -

      • addMapping

        public DatabaseMapping addMapping​(DatabaseMapping mapping)
        Add the mapping to the entityType's descriptor being built or extended. This is where the ValuesAccessor is created and the position of the mapping in the descriptor is captured to use as its index.

      • configureSequencing

        public void configureSequencing​(String numberName,
                                String numberFieldName)
        Configure default sequencing.

      • configureSequencing

        public void configureSequencing​(Sequence sequence,
                                String numberName,
                                String numberFieldName)
        Configure sequencing specifying the sequence type to use.

      • loadDynamicProject

        public static Project loadDynamicProject​(String resourcePath,
                                         DatabaseLogin login,
                                         DynamicClassLoader dynamicClassLoader)
                                  throws IOException
        Load a dynamic project from deployment XML creating dynamic types for all descriptors where the provided class name does not exist.
        Parameters:
        resourcePath -
        login -
        dynamicClassLoader -
        Returns:
        a Project with DynamicClassLoader and associated DynamicClassWriter configured. Ensure if a new Login/Platform is being configured that the ConversionManager.getLoader() is maintained.

        null is returned if the resourcePath cannot locate a deployment XML

        Throws:
        IOException

      • loadDynamicProject

        public static Project loadDynamicProject​(InputStream resourceStream,
                                         DatabaseLogin login,
                                         DynamicClassLoader dynamicClassLoader)
                                  throws IOException
        Load a dynamic project from deployment XML creating dynamic types for all descriptors where the provided class name does not exist.
        Parameters:
        resourceStream -
        login -
        dynamicClassLoader -
        Returns:
        a Project with DynamicClassLoader and associated DynamicClassWriter configured. Ensure if a new Login/Platform is being configured that the ConversionManager.getLoader() is maintained.

        null is returned if the resourcePath cannot locate a deployment XML

        Throws:
        IOException