fr.liglab.adele.icasa.location

Interface Zone

All Superinterfaces:

LocatedObject

public interface Zone
extends LocatedObject

This interface represents a Zone (a rectangular surface) into the iCasa platform. Zones can be embeded, a zone can have several children zones. Each children zone must fit into its parent zone.

Author:

Gabriel Pedraza Ferreira

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_Z_BOTTOM
static int	DEFAULT_Z_LENGTH

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(ZoneListener listener) Adds a listener to this zone.
void	addVariable(String name) Adds a variable to this zone.
boolean	addZone(Zone child) Adds a child zone to this zone.
boolean	contains(LocatedObject object) Returns true if a object is geographically contained into the zone.
boolean	contains(Position position) Returns true if a point is geographically contained into the zone.
boolean	fits(Zone aZone) Determines if a Zone fits (don't exceed limits) of this zone/
List<Zone>	getChildren() Gets the list of children zones
String	getId() Returns the zone id.
int	getLayer() Determines the deepth of this zone
Position	getLeftTopAbsolutePosition() Gets the absolute (x,y) point in the left-top corner of the zone.
Position	getLeftTopRelativePosition() Gets the (x,y) point in the left-top corner of the zone.
Zone	getParent() Gets the parent Zone
Position	getRelativePosition(LocatedObject object) Returns relative position of specified object from top left corner of this zone.
Position	getRightBottomAbsolutePosition() Gets the absolute (x,y) point in the right-bottom corner of the zone.
Position	getRightBottomRelativePosition() Gets the (x,y) point in the right-bottom corner of the zone.
boolean	getUseParentVariables() Determines if this zone use the variable of its parent zone.
Set<String>	getVariableNames() Gets the list of variable names
Set<Variable>	getVariables() Gets the list of variable
Object	getVariableValue(String name) Gets the value from a zone variable.
int	getXLength() Gets the zone X length (width)
int	getYLength() Gets the zone Y length.
int	getZLength() Gets the zone Z length.
void	removeListener(ZoneListener listener) Removes a listener from the zone.
void	removeVariable(String name) Removes a variable from this zone.
void	resize(int newWidth, int newHeight, int newDepth) Resizes the zone
void	setLeftTopRelativePosition(Position leftTopPosition) Sets the relative (x,y) point in the left-top corner of the zone.
void	setParent(Zone parent) Sets the parent Zone
void	setUseParentVariables(boolean useParentVariables) Modifies if this zone will use the variable of its parent zone.
void	setVariableValue(String name, Object newValue) Sets specified variable value.
void	setXLength(int length) Sets the zone X length .
void	setYLength(int length) Sets the zone Y length.
void	setZLength(int length) Sets the zone Y length.

Methods inherited from interface fr.liglab.adele.icasa.location.LocatedObject

attachObject, detachObject, getCenterAbsolutePosition, setCenterAbsolutePosition

Field Detail

DEFAULT_Z_LENGTH

static final int DEFAULT_Z_LENGTH

See Also:

Constant Field Values

DEFAULT_Z_BOTTOM

static final int DEFAULT_Z_BOTTOM

See Also:

Constant Field Values

Method Detail

getId

String getId()

Returns the zone id.

Returns:

zone id.

getLeftTopRelativePosition

Position getLeftTopRelativePosition()

Gets the (x,y) point in the left-top corner of the zone. This point is relative to its parent zone. If there is no parent, this method returns the same point of getLeftTopAbsolutePosition method.

Returns:

the relative (x,y) point in the left-top corner of the zone

getLeftTopAbsolutePosition

Position getLeftTopAbsolutePosition()

Gets the absolute (x,y) point in the left-top corner of the zone.

Returns:

the absolute (x,y) point in the left-top corner of the zone.

getRightBottomRelativePosition

Position getRightBottomRelativePosition()

Gets the (x,y) point in the right-bottom corner of the zone. This point is relative to its parent zone. If there is no parent, this method returns the same point of getRightBottomAbsolutePosition method.

Returns:

Gets the relative (x,y) point in the right-bottom corner of the zone.

getRightBottomAbsolutePosition

Position getRightBottomAbsolutePosition()

Gets the absolute (x,y) point in the right-bottom corner of the zone.

Returns:

the absolute (x,y) point in the right-bottom corner of the zone.

setLeftTopRelativePosition

void setLeftTopRelativePosition(Position leftTopPosition)
                                throws Exception

Sets the relative (x,y) point in the left-top corner of the zone.

Parameters:

leftTopPosition - The new left-top corner of the zone.

Throws:

Exception - When the zone does not fit its parent zone.

getXLength

int getXLength()

Gets the zone X length (width)

Returns:

the zone width

setXLength

void setXLength(int length)
                throws Exception

Sets the zone X length .

Parameters:

length - the new zone X length.

Throws:

Exception - When the zone does not fit its parent zone.

getYLength

int getYLength()

Gets the zone Y length.

Returns:

the zone Y length.

setYLength

void setYLength(int length)
                throws Exception

Sets the zone Y length.

Parameters:

length - the new zone Y length.

Throws:

Exception - When the zone does not fit its parent zone.

getZLength

int getZLength()

Gets the zone Z length.

Returns:

the zone Y length.

setZLength

void setZLength(int length)
                throws Exception

Sets the zone Y length.

Parameters:

length - the new zone Z length.

Throws:

Exception - When the zone does not fit its parent zone.

contains

boolean contains(LocatedObject object)

Returns true if a object is geographically contained into the zone.

Parameters:

object - a located object

Returns:

true if a object is geographically contained into the zone, false if it is not.

contains

boolean contains(Position position)

Returns true if a point is geographically contained into the zone.

Parameters:

position - a point

Returns:

true if a point is geographically contained into the zone, false if it is not.

getRelativePosition

Position getRelativePosition(LocatedObject object)

Returns relative position of specified object from top left corner of this zone.

Parameters:

object - a located object

Returns:

relative position of specified object from top left corner of this zone.

addZone

boolean addZone(Zone child)

Adds a child zone to this zone. The child zone must fit this zone.

Parameters:

child -

Returns:

fits

boolean fits(Zone aZone)

Determines if a Zone fits (don't exceed limits) of this zone/

Parameters:

aZone - a zone

Returns:

true if aZone fits into this zone, false otherwise.

getLayer

int getLayer()

Determines the deepth of this zone

Returns:

getChildren

List<Zone> getChildren()

Gets the list of children zones

Returns:

setParent

void setParent(Zone parent)

Sets the parent Zone

Parameters:

parent -

getParent

Zone getParent()

Gets the parent Zone

Returns:

addListener

void addListener(ZoneListener listener)

Adds a listener to this zone.

Parameters:

listener - the listener to be added.

removeListener

void removeListener(ZoneListener listener)

Removes a listener from the zone.

Parameters:

listener - the listener to be removed.

setUseParentVariables

void setUseParentVariables(boolean useParentVariables)

Modifies if this zone will use the variable of its parent zone.

Parameters:

useParentVariables - true if the zone must use its parent variables.

getUseParentVariables

boolean getUseParentVariables()

Determines if this zone use the variable of its parent zone.

Returns:

getVariableValue

Object getVariableValue(String name)

Gets the value from a zone variable.

Parameters:

name - The name of variable.

Returns:

the value of variable.

setVariableValue

void setVariableValue(String name,
                    Object newValue)

Sets specified variable value. If the property does not exist, adds it.

Parameters:

name - variable name to set

newValue - property value to set

addVariable

void addVariable(String name)

Adds a variable to this zone.

Parameters:

name - The variable name.

removeVariable

void removeVariable(String name)

Removes a variable from this zone.

Parameters:

name - The variable name.

getVariableNames

Set<String> getVariableNames()

Gets the list of variable names

Returns:

the list of variable names

getVariables

Set<Variable> getVariables()

Gets the list of variable

Returns:

the list of variable

resize

void resize(int newWidth,
          int newHeight,
          int newDepth)
            throws Exception

Resizes the zone

Parameters:

newWidth - The new width (X length value)

newHeight - The new Height (Y length value)

newDepth - The new Depth (Z length value)

Throws:

Exception - When the zone does not fit its parent zone.