/*
 *  Copyright (C) 2006  Takashi Kasuya <kasuya@sfc.keio.ac.jp>
 *
 * 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 2.1 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 library; if not, write to the Free Software
 *　Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

package jp.ac.naka.ec.entity;

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

import javax.sip.SipException;




/**
 * Entityを保持するコンテナ。保持しているEntityの参照の取得やイベント情報の配信を行う。
 * @author Takashi Kasuya
 *
 */

public interface EntityContainer extends Entity{
	
	/**
	 * 保持するEntityの追加
	 * @param e
	 */
	public void addEntity(Entity e);
	

	
	/**
	 * 保持しているEntityの取得
	 * @return
	 */
	public Set<Entity> getEntities();
	
	/**
	 * 保持しているEntityを名前を特定して取得
	 * @return
	 */
	public Entity getEntity(String name);
	
	/**
	 * 任意の場所に存在するEntityへの参照のSetを返す
	 * @param location
	 * @return
	 */
	public Set<Entity> getEntitiesByLocation(String location);
	
	/**
	 * URIでコンテナを指定して参照を取得する
	 * @param uri
	 * @return
	 * @throws SipException
	 */
	public EntityContainer getContainer(String uri);

	
	/**
	 * イベント配信のための参照テーブルの取得
	 */
	public Map getEntryTable();
	
	
}
