org.wattdepot.common.domainmodel

Class SensorGroup

java.lang.Object

org.wattdepot.common.domainmodel.SensorGroup

All Implemented Interfaces:

IDomainModel

public class SensorGroup
extends Object
implements IDomainModel

SensorGroup represents a group of Sensors. Used for aggregating sensor measurements.

Author:

Cam Moore

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	sensors The List of sensors the compose this group.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SensorGroup() Hide the default constructor.
	SensorGroup(String name, Set<String> sensors, String ownerId) Create a new SensorGroup with the given unique id.
	SensorGroup(String id, String name, Set<String> sensors, String ownerId) Create a new SensorGroup with the given unique id.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(String sensorId)
boolean	contains(Object o)
boolean	equals(Object obj)
String	getId() The slug is the name of the instance lower-cased, spaces replaced with '-', and special characters removed.
String	getName()
String	getOrganizationId()
Set<String>	getSensors()
int	hashCode()
boolean	remove(Object o)
void	setId(String id) Sets the instance's slug.
void	setName(String name) Sets the name of the instance.
void	setOrganizationId(String owner) Sets the id of the owner of this instance.
void	setSensors(Set<String> sensors)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

sensors

protected Set<String> sensors

The List of sensors the compose this group.

Constructor Detail

SensorGroup

protected SensorGroup()

Hide the default constructor.

SensorGroup

public SensorGroup(String name,
           Set<String> sensors,
           String ownerId)

Create a new SensorGroup with the given unique id.

Parameters:

name - The name.

sensors - The set of sensors in the group.

ownerId - the id of the owner of the SensorGroup.

SensorGroup

public SensorGroup(String id,
           String name,
           Set<String> sensors,
           String ownerId)

Create a new SensorGroup with the given unique id.

Parameters:

id - The unique id.

name - The name.

sensors - The set of sensors in the group.

ownerId - the id of the owner of the SensorGroup.

Method Detail

add

public boolean add(String sensorId)

Parameters:

sensorId - The id of the sensor to add.

Returns:

true if successful.

See Also:

List.add(java.lang.Object)

contains

public boolean contains(Object o)

Parameters:

o - The Sensor to test.

Returns:

true if the Sensor is in this group.

See Also:

List.contains(java.lang.Object)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getId

public String getId()

Description copied from interface: IDomainModel

The slug is the name of the instance lower-cased, spaces replaced with '-', and special characters removed.

Specified by:

getId in interface IDomainModel

Returns:

the id

getName

public String getName()

Specified by:

getName in interface IDomainModel

Returns:

the name

getOrganizationId

public String getOrganizationId()

Specified by:

getOrganizationId in interface IDomainModel

Returns:

the owner

getSensors

public Set<String> getSensors()

Returns:

the sensors

hashCode

public int hashCode()

Overrides:

hashCode in class Object

remove

public boolean remove(Object o)

Parameters:

o - The Sensor to remove.

Returns:

true if successful.

See Also:

List.remove(java.lang.Object)

setId

public void setId(String id)
           throws BadSlugException

Description copied from interface: IDomainModel

Sets the instance's slug.

Specified by:

setId in interface IDomainModel

Parameters:

id - the id to set

Throws:

BadSlugException - if the id isn't valid.

setName

public void setName(String name)

Description copied from interface: IDomainModel

Sets the name of the instance. If the slug is not set it sets the slug as well.

Specified by:

setName in interface IDomainModel

Parameters:

name - the name to set

setOrganizationId

public void setOrganizationId(String owner)

Description copied from interface: IDomainModel

Sets the id of the owner of this instance.

Specified by:

setOrganizationId in interface IDomainModel

Parameters:

owner - the id of the owner to set

setSensors

public void setSensors(Set<String> sensors)

Parameters:

sensors - the sensors to set

toString

public String toString()

Overrides:

toString in class Object