org.btrplace.scheduler.runner.disjoint.model.SubModel Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2016 University Nice Sophia Antipolis
 *
 * This file is part of btrplace.
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 */

package org.btrplace.scheduler.runner.disjoint.model;

import org.btrplace.model.*;
import org.btrplace.model.view.ModelView;

import java.util.Collection;
import java.util.Collections;
import java.util.Objects;
import java.util.Set;

/**
 * Define a model that is a sub-model of a bigger one.
 * The operation on a sub-model are limited to the elements that belong
 * to the given scope.
 * 
 * 

 * Elements created in a sub-model are integrated automatically into the
 * parent component
 * It is not allowed to attach/detach/clear decorators
 * It is not possible to set the attributes
 * 
 *
 * @author Fabien Hermenier
 */
public class SubModel implements Model {

    private Model parent;

    private Collection scope;

    private SubMapping sm;

    private ElementBuilder eb;

    /**
     * Make a new sub-model with an empty scope for ready VMs.
     *
     * @param p  the parent model
     * @param b  the element builder to rely on
     * @param ns the node to restrict the model on.
     */
    public SubModel(Model p, ElementBuilder b, Collection ns) {
        this(p, b, ns, Collections.emptySet());
    }

    /**
     * Make a new sub-model.
     *
     * @param p         the parent model
     * @param b         the element builder to rely on
     * @param nodeScope the node to restrict the model on.
     * @param vmReady   the scope of VMs that are ready in the parent model.
     */
    public SubModel(Model p, ElementBuilder b, Collection nodeScope, Set vmReady) {
        this.scope = nodeScope;
        this.parent = p;
        this.eb = b;
        sm = new SubMapping(p.getMapping(), scope, vmReady);
    }

    /**
     * Get the scope of the model.
     *
     * @return a set of nodes
     */
    public Collection getScope() {
        return scope;
    }

    @Override
    public ModelView getView(String id) {
        return parent.getView(id);
    }

    @Override
    public Collection getViews() {
        return parent.getViews();
    }

    /**
     * Unsupported.
     */
    @Override
    public boolean attach(ModelView v) {
        throw new UnsupportedOperationException();
    }

    /**
     * Unsupported.
     */
    @Override
    public boolean detach(ModelView v) {
        throw new UnsupportedOperationException();
    }

    /**
     * Unsupported.
     */
    @Override
    public void clearViews() {
        throw new UnsupportedOperationException();
    }

    /**
     * Get a mapping that is limited to the given scope.
     *
     * @return a mapping
     */
    @Override
    public SubMapping getMapping() {
        return sm;
    }

    @Override
    public Attributes getAttributes() {
        return parent.getAttributes();
    }

    /**
     * Unsupported.
     */
    @Override
    public void setAttributes(Attributes attrs) {
        throw new UnsupportedOperationException();
    }

    /**
     * Clone this model using a {@link DefaultModel}.
     *
     * @return a mutable clone
     */
    @Override
    public Model copy() {
        DefaultModel m = new DefaultModel(eb.copy());
        MappingUtils.fill(sm, m.getMapping());
        for (ModelView rc : parent.getViews()) {
            m.attach(rc.copy());
        }
        m.setAttributes(this.getAttributes().copy());
        return m;
    }

    @Override
    public VM newVM() {
        VM v = eb.newVM();
        if (v != null) {
            parent.newVM(v.id());
        }
        return v;
    }

    @Override
    public VM newVM(int id) {
        VM v = eb.newVM(id);
        if (v != null) {
            parent.newVM(id);
        }
        return v;

    }

    @Override
    public Node newNode() {
        Node n = eb.newNode();
        if (n != null) {
            parent.newNode(n.id());
        }
        return n;
    }

    @Override
    public Node newNode(int id) {
        Node n = eb.newNode(id);
        if (n != null) {
            parent.newNode(id);
        }
        return n;
    }

    @Override
    public boolean contains(VM v) {
        return parent.contains(v);
    }

    @Override
    public boolean contains(Node n) {
        return parent.contains(n);
    }

    @Override
    public String toString() {
        StringBuilder b = new StringBuilder();
        b.append("Mapping:\n");
        b.append(getMapping());
        b.append("\nAttributes:\n");
        b.append(getAttributes());
        b.append("\nViews:\n");
        for (ModelView entry : parent.getViews()) {
            b.append(entry.getIdentifier()).append(": ");
            b.append(entry.toString()).append("\n");
        }
        return b.toString();
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        Model that = (Model) o;

        if (!sm.equals(that.getMapping())) {
            return false;
        }

        //TODO: excessive, we should only focus on my attributes
        if (!parent.getAttributes().equals(that.getAttributes())) {
            return false;
        }

        Collection thatViews = that.getViews();
        return getViews().equals(thatViews);
    }

    @Override
    public int hashCode() {
        return Objects.hash(sm, parent.getViews(), parent.getAttributes());
    }
}