gov.usda.gdpc
Class EnvironmentExperiment

java.lang.Object
  gov.usda.gdpc.AbstractDBElement
      gov.usda.gdpc.EnvironmentExperiment

All Implemented Interfaces:

java.lang.Comparable, DBElement, java.util.Map

public class EnvironmentExperiment

extends AbstractDBElement

This is a database element representing an environment experiment.

Author:

terryc

Nested Class Summary

Nested classes inherited from class java.util.Map

java.util.Map.Entry

Field Summary

static java.lang.String

TYPE

Fields inherited from class gov.usda.gdpc.AbstractDBElement

myProperties

Method Summary

static java.lang.String	buildKey(java.util.Map properties) This builds the unique key for this environment experiment based on the EnvironmentExperimentProperty.ID and EnvironmentExperimentProperty.DATA_SOURCE.
static java.lang.String	buildKey(java.lang.String dataSource, Identifier id) This builds the unique key for this environment experiment based on the EnvironmentExperimentProperty.ID and EnvironmentExperimentProperty.DATA_SOURCE.
static EnvironmentExperiment	getCachedInstance(java.util.Map properties) This returns the environment experiment instance given specified id and source.
java.lang.String	getDataSource() Returns the data source of this environment experiment.
Identifier	getID() Returns identifier of this environment experiment.
static EnvironmentExperiment	getInstance(java.util.Map properties) This returns the environment experiment instance given the specified list of properties.
java.lang.String	getName() Returns the name of this environment experiment.
java.lang.String	getType() Get type of this element.

Methods inherited from class gov.usda.gdpc.AbstractDBElement

clear, compareTo, containsKey, containsValue, entrySet, equals, get, getKey, getProperty, isEmpty, keySet, numProperties, properties, propsEqual, put, putAll, remove, size, toString, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

hashCode

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Method Detail

getInstance

public static EnvironmentExperiment getInstance(java.util.Map properties)

This returns the environment experiment instance given the specified list of properties. A new environment experiment will be created if its not found in the cache.

Parameters:

properties - properties of this environment experiment. The keys are the properties (type: EnvironmentExperimentProperty) and the values are the corresponding value. Properties can not have a value equal to null. It is not allowed to have two keys that are the same. The EnvironmentExperimentProperty.ID, EnvironmentExperimentProperty.DATA_SOURCE, and EnvironmentExperimentProperty.NAME properties must be defined.

Returns:

environment experiment

getCachedInstance

public static EnvironmentExperiment getCachedInstance(java.util.Map properties)

This returns the environment experiment instance given specified id and source. Null will be returned if its not found in the cache.

Parameters:

properties - properties of this environment experiment. The keys are the properties (type: EnvironmentExperimentProperty) and the values are the corresponding value. Properties can not have a value equal to null. Only the EnvironmentExperimentProperty.ID and EnvironmentExperimentProperty.DATA_SOURCE are used to find a matching environment experiment in the cache.

Returns:

cached environment experiment or null if not in cache.

buildKey

public static java.lang.String buildKey(java.util.Map properties)

This builds the unique key for this environment experiment based on the EnvironmentExperimentProperty.ID and EnvironmentExperimentProperty.DATA_SOURCE.

Parameters:

properties - properties map

Returns:

key

buildKey

public static java.lang.String buildKey(java.lang.String dataSource,
                                        Identifier id)

This builds the unique key for this environment experiment based on the EnvironmentExperimentProperty.ID and EnvironmentExperimentProperty.DATA_SOURCE.

Parameters:

dataSource - data source

id - identifier

Returns:

key

getName

public java.lang.String getName()

Returns the name of this environment experiment.

Specified by:

getName in interface DBElement

Overrides:

getName in class AbstractDBElement

Returns:

the name

getDataSource

public java.lang.String getDataSource()

Returns the data source of this environment experiment.

Specified by:

getDataSource in interface DBElement

Overrides:

getDataSource in class AbstractDBElement

Returns:

data source

getID

public Identifier getID()

Returns identifier of this environment experiment.

Specified by:

getID in interface DBElement

Overrides:

getID in class AbstractDBElement

Returns:

identifier

getType

public java.lang.String getType()

Get type of this element.

Returns:

type