com.speedment.runtime.core.manager.AbstractManager Maven / Gradle / Ivy

Go to download
/**
 *
 * Copyright (c) 2006-2017, Speedment, Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); You may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.speedment.runtime.core.manager;

import com.speedment.common.injector.State;
import com.speedment.common.injector.annotation.ExecuteBefore;
import com.speedment.common.injector.annotation.Inject;
import com.speedment.common.injector.annotation.WithState;
import com.speedment.runtime.config.identifier.TableIdentifier;
import com.speedment.runtime.core.component.ManagerComponent;
import com.speedment.runtime.core.component.PersistenceComponent;
import com.speedment.runtime.core.component.ProjectComponent;
import com.speedment.runtime.core.component.StreamSupplierComponent;
import com.speedment.runtime.core.exception.SpeedmentException;
import com.speedment.runtime.core.stream.parallel.ParallelStrategy;

import java.util.stream.Stream;

import static com.speedment.common.injector.State.INITIALIZED;
import static java.util.Objects.requireNonNull;

/**
 * An abstract base implementation of all {@link Manager Managers}. 
 * 
 * This default implementation uses the plugged in 
 * {@link StreamSupplierComponent} and {@link PersistenceComponent} to stream 
 * over entities and make changes to them in the data store. It also installs
 * itself in the plugged in {@link ManagerComponent}.
 * 
 * @param  entity type
 *
 * @author Emil Forslund
 * @since 2.0.0
 * 
 * @see StreamSupplierComponent
 * @see PersistenceComponent
 * @see ManagerComponent
 */
public abstract class AbstractManager implements Manager {

    private @Inject StreamSupplierComponent streamSupplierComponent;

    private Persister persister;
    private Updater updater;
    private Remover remover;

    protected AbstractManager() {}

    /**
     * In the {@link State#INITIALIZED}-phase, create an instance of each of the
     * three interfaces {@link Persister}, {@link Updater} and {@link Remover} 
     * to use when making changes to the data store.
     * 

     * THIS METHOD IS INTENDED TO BE INVOCED AUTOMATICALLY BY THE DEPENDENCY
     * INJECTOR. IT SHOULD THEREFORE NEVER BE CALLED DIRECTLY!
     * 
     * @param persistenceComponent  auto-injected persistenceComponent
     */
    @ExecuteBefore(INITIALIZED)
    final void createSupport(
            @WithState(INITIALIZED) PersistenceComponent persistenceComponent) {
        
        final TableIdentifier tableId = getTableIdentifier();

        this.persister = persistenceComponent.persister(tableId);
        this.updater   = persistenceComponent.updater(tableId);
        this.remover   = persistenceComponent.remover(tableId);
    }

    /**
     * In the {@link State#INITIALIZED}-phase, install this {@link Manager} in 
     * the {@link ManagerComponent} so that it can be found by other parts of
     * the system.
     * 
     * THIS METHOD IS INTENDED TO BE INVOCED AUTOMATICALLY BY THE DEPENDENCY
     * INJECTOR. IT SHOULD THEREFORE NEVER BE CALLED DIRECTLY!
     * 
     * @param persistenceComponent  auto-injected managerComponent
     * @param projectComponent      auto-injected projectComponent
     */
    @ExecuteBefore(INITIALIZED)
    final void install(
            @WithState(INITIALIZED) ManagerComponent managerComponent,
            @WithState(INITIALIZED) ProjectComponent projectComponent) {

        requireNonNull(projectComponent); // Must be initialized first.
        managerComponent.put(this);
    }

    @Override
    public Stream stream() {
        return streamSupplierComponent.stream(
            getTableIdentifier(), 
            ParallelStrategy.computeIntensityDefault()
        );
    }

    @Override
    public final ENTITY persist(ENTITY entity) throws SpeedmentException {
        return persister().apply(entity);
    }

    @Override
    public Persister persister() {
        return persister;
    }

    @Override
    public final ENTITY update(ENTITY entity) throws SpeedmentException {
        return updater().apply(entity);
    }

    @Override
    public Updater updater() {
        return updater;
    }

    @Override
    public final ENTITY remove(ENTITY entity) throws SpeedmentException {
        return remover().apply(entity);
    }

    @Override
    public Remover remover() {
        return remover;
    }
}