/*
    * sbxb library, part of ULMgen product
    * Copyright (C) 2003,2005 Thierry Beigbeder
    *
    * 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 2 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, write to the Free Software
   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   */
  /*
   * $Header: $
   * $Revision: $
   * $Date: $
   *
   * History :
   * Who       yyyy/mm/dd   Action
   * --------  ----------   ------
   */
  
  
  package org.otvl.sbxbsamp.simple;
  
  
  // Insert here additional imports
  
  /***
   * A room in the house.
   * @author
   * @version
   */
  
  
  public class Room
  {
  	/*-------------------------------------------------------------------------
  	 * Attributes declaration
  	 *-------------------------------------------------------------------------*/
  	/***
  	 * 
  	 */
  	private int id;
  	/***
  	 * 
  	 */
  	private String name;
  	/***
  	 * 
  	 */
  	private String location;
  
  
  	/*-------------------------------------------------------------------------
  	 * Associations declaration
  	 *-------------------------------------------------------------------------*/
  	/***
  	 * The windows of the room.
  	 */
  	private java.util.List windoz = new java.util.ArrayList() ;
  	/***
  	 * The doors of the room.
  	 */
  	private java.util.List theDoors = new java.util.ArrayList() ;
  
  
  	/*-------------------------------------------------------------------------
  	 * Operations
  	 *-------------------------------------------------------------------------*/
  
  
  	/*-------------------------------------------------------------------------
  	 * Attribute accessors
  	 *-------------------------------------------------------------------------*/
  	//------------------------
  	// Accessors for attribute id
  	//------------------------
  	/***
  	 * Returns the id.<br/>
  	 * 
  	 * @return int
  	 */
  	public int getId() {
  		int vId = id;
  		return vId;
  	}
  
  	/***
  	 * Sets the id.<br/>
  	 * 
  	 * @param id The id to set
  	 */
 	public void setId(int id) {
 		this.id = id;
 	}
 
 	//------------------------
 	// Accessors for attribute name
 	//------------------------
 	/***
 	 * Returns the name.<br/>
 	 * 
 	 * @return String
 	 */
 	public String getName() {
 		String vName = name;
 		return vName;
 	}
 
 	/***
 	 * Sets the name.<br/>
 	 * 
 	 * @param name The name to set
 	 */
 	public void setName(String name) {
 		this.name = name;
 	}
 
 	//------------------------
 	// Accessors for attribute location
 	//------------------------
 	/***
 	 * Returns the location.<br/>
 	 * 
 	 * @return String
 	 */
 	public String getLocation() {
 		String vLocation = location;
 		return vLocation;
 	}
 
 	/***
 	 * Sets the location.<br/>
 	 * 
 	 * @param location The location to set
 	 */
 	public void setLocation(String location) {
 		this.location = location;
 	}
 
 
 
 	/*-------------------------------------------------------------------------
 	 * Association accessors
 	 *-------------------------------------------------------------------------*/
 	//--------------------------
 	// Accessors for association windoz
 	//--------------------------
 	/***
 	 * Returns a target in link windoz.<br/>
 	 * The windows of the room.
 	 * @param index offset in the array
 	 * @return Window
 	 */
 	public Window getWindoz(int index) {
 		Window vWindoz = (Window)windoz.get(index);
 		return vWindoz;
 	}
 	/***
 	 * Returns an iterator for targets in links windoz
 	 * @return java.util.Iterator
 	 */
 	public  java.util.Iterator iteratorWindoz() {
 		java.util.Iterator vIterator = windoz.iterator();
 		return vIterator;
 	}
 	/***
 	 * Returns the size of the collection windoz
 	 * @return int
 	 */
 	public  int sizeWindoz() {
 		int vSize = windoz.size();
 		return vSize;
 	}
 
 	/***
 	 * Inserts a target in link windoz.<br/>
 	 * The windows of the room.
 	 * @param index offset in the list
 	 * @param aWindow The Window to insert
 	 */
 	public void addWindoz(int index, Window aWindow) {
 		this.windoz.add(index, aWindow);
 	}
 	/***
 	 * Adds a target at end of link windoz.<br/>
 	 * The windows of the room.
 	 * @param aWindow The Window to insert
 	 */
 	public void addWindoz(Window aWindow) {
 		this.windoz.add(this.windoz.size(), aWindow);
 	}
 	
 	/***
 	 * Removes a target in link windoz
 	 * @param index offset in the list
 	 */
 	public void removeWindoz(int index) {
 		this.windoz.remove(index);
 	}
 	
 	/***
 	 * Clears all targets in link windoz
 	 */
 	public void clearWindoz() {
 		this.windoz.clear();
 	}
 
 
 
 	//--------------------------
 	// Accessors for association theDoors
 	//--------------------------
 	/***
 	 * Returns a target in link theDoors.<br/>
 	 * The doors of the room.
 	 * @param index offset in the array
 	 * @return Door
 	 */
 	public Door getTheDoors(int index) {
 		Door vTheDoors = (Door)theDoors.get(index);
 		return vTheDoors;
 	}
 	/***
 	 * Returns an iterator for targets in links theDoors
 	 * @return java.util.Iterator
 	 */
 	public  java.util.Iterator iteratorTheDoors() {
 		java.util.Iterator vIterator = theDoors.iterator();
 		return vIterator;
 	}
 	/***
 	 * Returns the size of the collection theDoors
 	 * @return int
 	 */
 	public  int sizeTheDoors() {
 		int vSize = theDoors.size();
 		return vSize;
 	}
 
 	/***
 	 * Inserts a target in link theDoors.<br/>
 	 * The doors of the room.
 	 * @param index offset in the list
 	 * @param aDoor The Door to insert
 	 */
 	public void addTheDoors(int index, Door aDoor) {
 		this.theDoors.add(index, aDoor);
 	}
 	/***
 	 * Adds a target at end of link theDoors.<br/>
 	 * The doors of the room.
 	 * @param aDoor The Door to insert
 	 */
 	public void addTheDoors(Door aDoor) {
 		this.theDoors.add(this.theDoors.size(), aDoor);
 	}
 	
 	/***
 	 * Removes a target in link theDoors
 	 * @param index offset in the list
 	 */
 	public void removeTheDoors(int index) {
 		this.theDoors.remove(index);
 	}
 	
 	/***
 	 * Clears all targets in link theDoors
 	 */
 	public void clearTheDoors() {
 		this.theDoors.clear();
 	}
 
 
 
 
 }