InstanceDeclaration.java

/**
 * Copyright 2011-2012 Universite Joseph Fourier, LIG, ADELE team
 *   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 fr.imag.adele.apam.declarations;

import java.util.HashSet;
import java.util.Set;

import fr.imag.adele.apam.declarations.references.components.ComponentReference;
import fr.imag.adele.apam.declarations.references.components.ImplementationReference;
import fr.imag.adele.apam.declarations.references.components.InstanceReference;
import fr.imag.adele.apam.declarations.references.components.VersionedReference;

/**
 * The declaration of an instance.
 * 
 * It can include dependency and provide declarations that override the ones in
 * the implementation
 * 
 * @author vega
 * 
 */
public class InstanceDeclaration extends ComponentDeclaration {


	/**
	 * A reference to the implementation
	 */
	private final VersionedReference<? extends ImplementationDeclaration> implementation;

	/**
	 * The list of triggers that must be met to start this instance
	 */
	private final Set<ConstrainedReference> triggers;

    public InstanceDeclaration(VersionedReference<? extends ImplementationDeclaration> implementation, String name) {
    	this(implementation, name, new HashSet<ConstrainedReference>());
    }
    
    public InstanceDeclaration(VersionedReference<? extends ImplementationDeclaration> implementation, String name, Set<ConstrainedReference> triggers) {
    	
		super(name);


		assert implementation != null;
		assert triggers != null;
		
		this.implementation = implementation;
		this.triggers 		= triggers;
	}

	/**
	 * Clone this declaration
	 */
   protected InstanceDeclaration(InstanceDeclaration original) {
    	super(original);

		this.implementation = original.implementation;
		
		this.triggers 		= new HashSet<ConstrainedReference>();
		for (ConstrainedReference trigger : triggers) {
			this.triggers.add(new ConstrainedReference(trigger));
		}
	}

	@Override
	protected InstanceReference generateReference() {
		return new InstanceReference(getName());
	}

	@Override
	public InstanceReference getReference() {
		return (InstanceReference) super.getReference();
	}

	@Override
	public ComponentReference<? extends ImplementationDeclaration> getGroup() {
		return getImplementation();
	}
	
	@Override
	public VersionedReference<? extends ImplementationDeclaration> getGroupVersioned() {
		return implementation;
	}

	/**
	 * The implementation of this instance
	 */
	public final ComponentReference<? extends ImplementationDeclaration> getImplementation() {
		return (ImplementationReference<?>) implementation.getComponent();
	}

 	/**
	 * The triggering specification
	 */
	public Set<ConstrainedReference> getTriggers() {
		return triggers;
	}

	@Override
	public String toString() {
		String ret = "Instance declaration " + super.toString();
		ret += "\n    Implementation: " + getImplementation().getName();
		return ret;
	}
}