org.wattdepot.common.domainmodel

Class CollectorProcessDefinition

java.lang.Object

org.wattdepot.common.domainmodel.CollectorProcessDefinition

All Implemented Interfaces:

IDomainModel

public class CollectorProcessDefinition
extends Object
implements IDomainModel

CollectorProcessDefinition - Represents a process that queries a Sensor and produces measurements.

Author:

Cam Moore

Field Summary

Fields

Modifier and Type	Field and Description
protected String	depositoryId The id of the depository where the measurements are stored.
protected Long	pollingInterval The number of seconds between polls.
protected Set<Property>	properties Additional properties for the Collector.
protected String	sensorId The id of the sensor making the measurements.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CollectorProcessDefinition() Hide the default constructor.
	CollectorProcessDefinition(String name, String sensorId, Long poll, String depositoryId, String ownerId)
	CollectorProcessDefinition(String id, String name, String sensorId, Long poll, String depositoryId, Set<Property> properties, String ownerId)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addProperty(Property e)
boolean	equals(Object obj)
String	getDepositoryId()
String	getId() The slug is the name of the instance lower-cased, spaces replaced with '-', and special characters removed.
String	getName()
String	getOrganizationId()
Long	getPollingInterval()
Set<Property>	getProperties()
Property	getProperty(String key)
String	getSensorId()
int	hashCode()
boolean	removeProperty(Object o)
void	setDepositoryId(String depositoryId)
void	setId(String slug) Sets the instance's slug.
void	setName(String name) Sets the name of the instance.
void	setOrganizationId(String ownerId) Sets the id of the owner of this instance.
void	setPollingInterval(Long pollingInterval)
void	setProperties(Set<Property> properties)
void	setSensorId(String sensorId)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

sensorId

protected String sensorId

The id of the sensor making the measurements.

pollingInterval

protected Long pollingInterval

The number of seconds between polls.

depositoryId

protected String depositoryId

The id of the depository where the measurements are stored.

properties

protected Set<Property> properties

Additional properties for the Collector.

Constructor Detail

CollectorProcessDefinition

protected CollectorProcessDefinition()

Hide the default constructor.

CollectorProcessDefinition

public CollectorProcessDefinition(String name,
                          String sensorId,
                          Long poll,
                          String depositoryId,
                          String ownerId)

Parameters:

name - The name of the CollectorProcessDefinition.

sensorId - The id of the sensor that measures the environment.

poll - The number of seconds between polls.

depositoryId - The depository_id where measurements are stored.

ownerId - the id of the owner of the collector.

CollectorProcessDefinition

public CollectorProcessDefinition(String id,
                          String name,
                          String sensorId,
                          Long poll,
                          String depositoryId,
                          Set<Property> properties,
                          String ownerId)

Parameters:

id - The unique id for the CollectorProcessDefinition.

name - The name of the CollectorProcessDefinition.

sensorId - The id of the sensor that measures the environment.

poll - The number of seconds between polls.

depositoryId - The depository_id where measurements are stored.

properties - The properties associated with this CollectorProcessDefinition.

ownerId - the id of the owner of the collector.

Method Detail

addProperty

public boolean addProperty(Property e)

Parameters:

e - The Property to add.

Returns:

true if added.

See Also:

List.add(java.lang.Object)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getDepositoryId

public String getDepositoryId()

Returns:

the depositoryId

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 slug

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

getPollingInterval

public Long getPollingInterval()

Returns:

the pollingInterval.

getProperties

public Set<Property> getProperties()

Returns:

the properties.

getProperty

public Property getProperty(String key)

Parameters:

key - The key.

Returns:

The value of associated with the key.

getSensorId

public String getSensorId()

Returns:

the sensor

hashCode

public int hashCode()

Overrides:

hashCode in class Object

removeProperty

public boolean removeProperty(Object o)

Parameters:

o - The Property to remove.

Returns:

true if removed.

See Also:

List.remove(java.lang.Object)

setDepositoryId

public void setDepositoryId(String depositoryId)

Parameters:

depositoryId - the depositoryId to set

setId

public void setId(String slug)
           throws BadSlugException

Description copied from interface: IDomainModel

Sets the instance's slug.

Specified by:

setId in interface IDomainModel

Parameters:

slug - the id to set

Throws:

BadSlugException - if the slug is not a valid slug.

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 ownerId)

Description copied from interface: IDomainModel

Sets the id of the owner of this instance.

Specified by:

setOrganizationId in interface IDomainModel

Parameters:

ownerId - the id of the owner to set

setPollingInterval

public void setPollingInterval(Long pollingInterval)

Parameters:

pollingInterval - the pollingInterval to set

setProperties

public void setProperties(Set<Property> properties)

Parameters:

properties - the properties to set

setSensorId

public void setSensorId(String sensorId)

Parameters:

sensorId - the id of the sensor to set

toString

public String toString()

Overrides:

toString in class Object