jpa/org.eclipse.persistence.jpa.jpql/src/test/java/org/eclipse/persistence/jpa/tests/jpql/tools/spi/java/JavaManagedTypeProvider.java

/*
 * Copyright (c) 2006, 2021 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0,
 * or the Eclipse Distribution License v. 1.0 which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
 */

// Contributors:
//     Oracle - initial API and implementation
//
package org.eclipse.persistence.jpa.tests.jpql.tools.spi.java;

import java.lang.reflect.Member;
import java.util.HashMap;
import java.util.Map;
import org.eclipse.persistence.jpa.jpql.Assert;
import org.eclipse.persistence.jpa.jpql.tools.spi.IEmbeddable;
import org.eclipse.persistence.jpa.jpql.tools.spi.IEntity;
import org.eclipse.persistence.jpa.jpql.tools.spi.IManagedType;
import org.eclipse.persistence.jpa.jpql.tools.spi.IManagedTypeProvider;
import org.eclipse.persistence.jpa.jpql.tools.spi.IMappedSuperclass;
import org.eclipse.persistence.jpa.jpql.tools.spi.IMappingBuilder;
import org.eclipse.persistence.jpa.jpql.tools.spi.IType;
import org.eclipse.persistence.jpa.jpql.tools.utility.iterable.SnapshotCloneIterable;

/**
 * The concrete implementation of {@link IManagedTypeProvider} that is wrapping the runtime
 * representation of a provider of a managed type.
 *
 * @version 2.5
 * @since 2.3
 * @author Pascal Filion
 */
@SuppressWarnings("nls")
public class JavaManagedTypeProvider implements IManagedTypeProvider {

    /**
     * The filtered collection of managed types that are {@link IEmbeddable}.
     */
    private Map<String, IEmbeddable> embeddables;

    /**
     * The filtered collection of managed types that are {@link IEntity}.
     */
    private Map<String, IEntity> entities;

    /**
     * The cached {@link IManagedType managed types}.
     */
    private Map<String, IManagedType> managedTypes;

    /**
     * The filtered collection of managed types that are {@link IMappedSuperclass}.
     */
    private Map<String, IMappedSuperclass> mappedSuperclasses;

    /**
     * The builder that is responsible to create the {@link org.eclipse.persistence.jpa.jpql.tools.spi.
     * IMapping IMapping} wrapping a persistent attribute or property.
     */
    private IMappingBuilder<Member> mappingBuilder;

    /**
     * The external form of a type repository.
     */
    private JavaTypeRepository typeRepository;

    /**
     * Creates a new <code>JavaManagedTypeProvider</code>.
     *
     * @param mappingBuilder The builder that is responsible to create the {@link org.eclipse.
     * persistence.jpa.jpql.spi.IMapping IMapping} wrapping a persistent attribute or property
     * @exception NullPointerException The {@link IMappingBuilder} cannot be <code>null</code>
     */
    public JavaManagedTypeProvider(IMappingBuilder<Member> mappingBuilder) {
        super();
        initialize(mappingBuilder);
    }

    /**
     * Adds the given Java class that is a JPA embeddable.
     *
     * @param type The embeddable class
     * @return The external form wrapping the given Java type
     */
    public IEmbeddable addEmbeddable(Class<?> type) {
        IEmbeddable embeddable = buildEmbeddable(type);
        embeddables .put(type.getName(), embeddable);
        managedTypes.put(type.getName(), embeddable);
        return embeddable;
    }

    /**
     * Adds the given Java class that is a JPA entity.
     *
     * @param type The entity class
     * @return The external form wrapping the given Java type
     */
    public IEntity addEntity(Class<?> type) {
        IEntity entity = buildEntity(type);
        entities.put(type.getName(), entity);
        managedTypes.put(type.getName(), entity);
        return entity;
    }

    /**
     * Adds the given Java class that is a JPA mapped superclass.
     *
     * @param type The mapped superclass class
     * @return The external form wrapping the given Java type
     */
    public IMappedSuperclass addMappedSuperclass(Class<?> type) {
        IMappedSuperclass mappedSuperclass = buildMappedSuperclass(type);
        mappedSuperclasses.put(type.getName(), mappedSuperclass);
        managedTypes.put(type.getName(), mappedSuperclass);
        return mappedSuperclass;
    }

    protected IEmbeddable buildEmbeddable(Class<?> type) {
        return new JavaEmbeddable(this, getTypeRepository().getType(type), mappingBuilder);
    }

    protected IEntity buildEntity(Class<?> type) {
        return new JavaEntity(this, getTypeRepository().getType(type), mappingBuilder);
    }

    protected IMappedSuperclass buildMappedSuperclass(Class<?> type) {
        return new JavaMappedSuperclass(this, getTypeRepository().getType(type), mappingBuilder);
    }

    @Override
    public Iterable<IEntity> entities() {
        return new SnapshotCloneIterable<IEntity>(entities.values());
    }

    @Override
    public IEmbeddable getEmbeddable(IType type) {
        return getEmbeddable(type.getName());
    }

    @Override
    public IEmbeddable getEmbeddable(String typeName) {
        return embeddables.get(typeName);
    }

    @Override
    public IEntity getEntity(IType type) {
        return getEntity(type.getName());
    }

    @Override
    public IEntity getEntity(String typeName) {
        return entities.get(typeName);
    }

    @Override
    public IEntity getEntityNamed(String entityName) {

        for (IEntity entity : entities.values()) {
            if (entity.getName().equals(entityName)) {
                return entity;
            }
        }

        return null;
    }

    @Override
    public IManagedType getManagedType(IType type) {
        return getManagedType(type.getName());
    }

    @Override
    public IManagedType getManagedType(String typeName) {
        return managedTypes.get(typeName);
    }

    @Override
    public IMappedSuperclass getMappedSuperclass(IType type) {
        return getMappedSuperclass(type.getName());
    }

    @Override
    public IMappedSuperclass getMappedSuperclass(String typeName) {
        return mappedSuperclasses.get(typeName);
    }

    protected IMappingBuilder<Member> getMappingBuilder() {
        return mappingBuilder;
    }

    @Override
    public JavaTypeRepository getTypeRepository() {
        if (typeRepository == null) {
            typeRepository = new JavaTypeRepository(getClass().getClassLoader());
        }
        return typeRepository;
    }

    /**
     * Initializes this provider.
     */
    protected void initialize() {
    }

    private void initialize(IMappingBuilder<Member> mappingBuilder) {

        Assert.isNotNull(mappingBuilder, "The IMappingBuilder cannot be null");

        this.mappingBuilder     = mappingBuilder;
        this.entities           = new HashMap<String, IEntity>();
        this.embeddables        = new HashMap<String, IEmbeddable>();
        this.managedTypes       = new HashMap<String, IManagedType>();
        this.mappedSuperclasses = new HashMap<String, IMappedSuperclass>();

        initialize();
    }

    @Override
    public Iterable<IManagedType> managedTypes() {
        return new SnapshotCloneIterable<IManagedType>(managedTypes.values());
    }
}