<?php
/**
 * A ??? query connector class
 *
 * @author		Roland Haeder <webmaster@ship-simu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 Hub Developer Team
 * @license		GNU GPL 3.0 or any newer version
 * @link		http://www.ship-simu.org
 * @todo		Find an interface for: handleAllQueries()
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
class ???QueryConnector extends BaseQueryConnector implements Connectable, Visitable {
	/**
	 * Protected constructor
	 *
	 * @return	void
	 */
	protected function __construct () {
		// Call parent constructor
		parent::__construct(__CLASS__);
	}

	/**
	 * Creates an instance of this query connector class
	 *
	 * @param	$nodeInstance		An instance of a node
	 * @return	$connectorInstance	An instance of this query connector class
	 */
	public final static function create???QueryConnector (NodeHelper $nodeInstance) {
		// Create the instance
		$connectorInstance = new ???QueryConnector();

		// Set the node instance
		$connectorInstance->setNodeInstance($nodeInstance);

		// Get a list instance
		$listInstance = ObjectFactory::createObjectByConfiguredName('!!!_query_list_class');

		// Set it in the connector
		$connectorInstance->setListInstance($listInstance);

		// Finally return the connector
		return $connectorInstance;
	}

	/**
	 * Accepts the visitor to rpocess the visit "request"
	 *
	 * @param	$visitorInstance	An instance of a Visitor class
	 * @return	void
	 */
	public function accept (Visitor $visitorInstance) {
		// Visit the query connector
		$visitorInstance->visitQuery($this);
	}

	/**
	 * Handles all unsent queries and should be called from a visitor
	 *
	 * @return	void
	 * @todo	0% done
	 */
	public function handleAllQueries () {
		$this->partialStub('Please implement this method.');
	}

	/**
	 * Processes all pending queries. This method should be called by the
	 * ActiveTaskVisitor class and should use an iterator on all pending
	 * queries.
	 *
	 * @return	void
	 * @todo	0% done
	 */
	public function processAllPendingQueries () {
		$this->partialStub('Please implement this method.');
	}
}

// [EOF]
?>