uk.org.ogsadai.examples.dataResourceAccessor
Class TemperatureDataResourceAccessor

java.lang.Object
  |
  +--uk.org.ogsadai.examples.dataResourceAccessor.TemperatureDataResourceAccessor

All Implemented Interfaces:

DataResourceAccessor, PersistInFiles, TemperatureProvider

public class TemperatureDataResourceAccessor

extends java.lang.Object

implements DataResourceAccessor, PersistInFiles, TemperatureProvider

Example temperature sensor data resource accessor.

The range of valid temperatures is read from a file range.txt provided within the data service resource directory to which this accessor belongs. The file consists of a minimum value and a maximum value each on separate lines.

Data service resources using this accessor expose the minimum and maximum values through resource properties with names:

• {http://ogsadai.org.uk/demoNamespace}minValue
• {http://ogsadai.org.uk/demoNamespace}maxValue

Author:

The OGSA-DAI Project Team

Field Summary

private static java.lang.String	COPYRIGHT_NOTICE Copyright statement
private float	maxValue Maximum temperature value
private StaticProperty	maxValueProp Maximum temperature value resource property
private float	minValue Minimum temperature value
private StaticProperty	minValueProp Minimum temperature value resource property
private java.lang.String	mResourceName Name of data service resource
private java.util.Random	rand Random number generator

Constructor Summary

TemperatureDataResourceAccessor()
Constructor.

Method Summary

Property[]	getProperties() Gets the resource properties associated with the data resource accessor.
float	getTemperature() Get the current temperature of the sensor.
void	restoreFromConfig(java.io.File directory) Configures the data resource accessor by reading any relevant configuration files in the given directory.
void	setResourceName(java.lang.String resourceName) Sets the name of the resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COPYRIGHT_NOTICE

private static final java.lang.String COPYRIGHT_NOTICE

Copyright statement

See Also:

Constant Field Values

mResourceName

private java.lang.String mResourceName

Name of data service resource

minValue

private float minValue

Minimum temperature value

maxValue

private float maxValue

Maximum temperature value

minValueProp

private StaticProperty minValueProp

Minimum temperature value resource property

maxValueProp

private StaticProperty maxValueProp

Maximum temperature value resource property

rand

private java.util.Random rand

Random number generator

Constructor Detail

TemperatureDataResourceAccessor

public TemperatureDataResourceAccessor()

Constructor.

Method Detail

setResourceName

public void setResourceName(java.lang.String resourceName)

Description copied from interface: DataResourceAccessor

Sets the name of the resource. This method will be called one before any other methods in this interface are called. Data resource accessors are not required to do anything with this name although it is sometimes useful to include it in any error messages.

Specified by:

setResourceName in interface DataResourceAccessor

Parameters:

resourceName - Name of the data service resource which will use this data resource accessor to mediate access to a data resource.

restoreFromConfig

public void restoreFromConfig(java.io.File directory)
                       throws DataResourceAccessorConfigException,
                              DataResourceAccessorMetaDataException,
                              DataResourceAccessorSetupException,
                              java.lang.IllegalArgumentException

Description copied from interface: PersistInFiles

Configures the data resource accessor by reading any relevant configuration files in the given directory.

If a data service resource is being constructed by reading from a configuration file this method will be called once immediately after the setName method is called. The data resource accessor should read its configuration from the files in the given directory of the data service resource which uses it.

Data resource accessors are free to add, amend or delete files in the given directory at any time throughout their lifetime. The exception to this rule is the dataResourceClassConfig.xml file which must be left unaltered since this specifies the data resource accessor class name.

Specified by:

restoreFromConfig in interface PersistInFiles

Parameters:

directory - Directory containing the data service resource configuration files. This includes the data resource accessor configuration files.

Throws:

java.lang.IllegalArgumentException - if the directory argument is null or is not a directory.

DataResourceAccessorSetupException - if an error occurs when setting up the data resource accessor after having read the configuration files.

DataResourceAccessorConfigException - if an error occurs reading the configuration files.

DataResourceAccessorMetaDataException - if an error occurs when constructing data resource accessor meta data properties.

getProperties

public Property[] getProperties()

Description copied from interface: DataResourceAccessor

Gets the resource properties associated with the data resource accessor. These are made available as properties of the data service resource to which the data resource accessor belongs.

This method should be called once after the readConfig method has been called but before any other methods are called.

Specified by:

getProperties in interface DataResourceAccessor

Returns:

The resource proporties. If there are no resource properties then a zero-sized array will be returned.

getTemperature

public float getTemperature()

Get the current temperature of the sensor.

Specified by:

getTemperature in interface TemperatureProvider

Returns:

current temperature in degrees Celsius.