RelToResolve.java

package fr.imag.adele.apam;

import java.util.List;
import java.util.Map;
import java.util.Set;

import fr.imag.adele.apam.declarations.ComponentKind;
import fr.imag.adele.apam.declarations.CreationPolicy;
import fr.imag.adele.apam.declarations.MissingPolicy;
import fr.imag.adele.apam.declarations.ResolvePolicy;
import fr.imag.adele.apam.declarations.references.ResolvableReference;
import fr.imag.adele.apam.util.ApamFilter;

public interface RelToResolve {

	public Set<ApamFilter> getAllImplementationConstraintFilters();

	public Set<ApamFilter> getAllInstanceConstraintFilters();

	public CreationPolicy getCreation();
	
	//To be called when a property is modified in the source component
	public void reComputeSubstFilters () ;

	// Get the constraints that need to be satisfied by the implementation that
	// resolves the reference
	public Set<String> getImplementationConstraints();

	// return the (modifiable !!) list of preferences, first intrinic, then mng.
	public List<ApamFilter> getImplementationPreferenceFilters();

	// Get the resource provider preferences
	public List<String> getImplementationPreferences();

	// Get the constraints that need to be satisfied by the instance that
	// resolves the reference
	public Set<String> getInstanceConstraints();

	// return the (non modifiable) list of constraints, intrinic and mng.
	public List<ApamFilter> getInstancePreferenceFilters();

	// Get the instance provider preferences
	public List<String> getInstancePreferences();

	// Get the source (ancestor) for ctxt relation
	public Component getLinkSource();

	// Get the exception associated with the missing policy
	public String getMissingException();

	// Get the policy associated with this relation
	public MissingPolicy getMissingPolicy();

	// Modifiable
	public Set<String> getMngImplementationConstraints();

	// Get the resource provider preferences
	public List<String> getMngImplementationPreferences();

	// Get the constraints that need to be satisfied by the instance that
	// resolves the reference
	public Set<String> getMngInstanceConstraints();

	// Get the instance provider preferences
	public List<String> getMngInstancePreferences();

	// Get the id of the relation in the declaring component declaration
	public String getName();

	public <T extends Component> T getPrefered(Set<T> candidates);

	// the associated relation
	public RelationDefinition getRelationDefinition();

	public ResolvePolicy getResolve();

	public <T extends Component> Resolved<T> getResolved(Resolved<T> candidates, boolean isPromotion);

	// Ex in Util
	public <T extends Component> Resolved<T> getResolved(Set<T> candidates, boolean isPromotion);

	// Type of source
	public ComponentKind getSourceKind();

	// Get the reference to the required resource
	public ResolvableReference getTarget();

	// Type of target
	public ComponentKind getTargetKind();

	// True if the relation has constraints (preferences ignored)
	public boolean hasConstraints();

	public boolean hasPreferences();

	// true if this is a dynamic wire, or a dynamic message ...
	// TODO to remove
	public boolean isDynamic();

	// Whether an error resolving a relation matching this policy should trigger
	// a backtrack
	public boolean isHide();

	// true if this is there is an associated field
	public boolean isInjected();

	// True if relation cardinality is multiple
	public boolean isMultiple();

	public boolean isRelation();

	// true if this is a Wire or a Link
	public boolean isWire();

	/**
	 * return true if the component matches the constraints of that relation.
	 * Preferences are not taken into account Same as matchDep (Component comp)
	 * since component extends Map<String, Object>
	 */
	public boolean matchRelation(Component target);

	public boolean matchRelationConstraints(Component target);

	public boolean matchRelationConstraints(ComponentKind candidateKind, Map<String, Object> properties);

	public int ranking(ComponentKind candidateKind, Map<String, Object> properties);

	public boolean matchRelationTarget(Component target);

	// public boolean matchRelation(Instance compoInst, RelToResolve compoDep) ;

}