Sector.java

package jamel.util;

import org.w3c.dom.Element;

import jamel.data.Expression;

/**
 * Represents a sector.
 */
public interface Sector {

	/**
	 * Executes the specified event.
	 * 
	 * @param event
	 *            the event to be executed.
	 */
	void doEvent(Element event);

	/**
	 * Returns an expression that provides an access to the specified data.
	 * 
	 * @param args
	 *            the arguments specifying the data to be accessed through the
	 *            expression.
	 * @return an expression.
	 */
	Expression getDataAccess(String[] args);

	/**
	 * Returns the name of this sector.
	 * 
	 * @return the name of this sector.
	 */
	String getName();

	/**
	 * Returns the specified phase.
	 * 
	 * @param name
	 *            the name of the phase to be returned.
	 * @param shuffle
	 *            if the agents need to be shuffled at the beginning of the
	 *            phase.
	 * 
	 * @return the specified phase.
	 */
	Phase getPhase(String name, boolean shuffle);

	/**
	 * Returns the parent simulation.
	 * 
	 * @return the parent simulation.
	 */
	Simulation getSimulation();

	/**
	 * Returns a random selection of <code>n</code> agents.
	 * 
	 * @param n
	 *            the number of agents to be selected.
	 * @return a random selection of <code>n</code> agents.
	 */
	Agent[] select(int n);

}