gov.usda.gdpc
Class Locality

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

All Implemented Interfaces:

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

public class Locality

extends AbstractDBElement

This is a database element representing a locality.

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 locality based on the LocalityProperty.ID and LocalityProperty.DATA_SOURCE.
static java.lang.String	buildKey(java.lang.String dataSource, Identifier id) This builds the unique key for this locality based on the LocalityProperty.ID and LocalityProperty.DATA_SOURCE.
static Locality	getCachedInstance(java.util.Map properties) This returns the locality instance given specified id and source.
java.lang.String	getDataSource() Returns the data source of this locality.
Identifier	getID() Returns identifier of this locality.
static Locality	getInstance(java.util.Map properties) This returns the locality instance given the specified list of properties.
java.lang.String	getName() Returns the name of this locality.
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 Locality getInstance(java.util.Map properties)

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

Parameters:

properties - properties of this locality. The keys are the properties (type: LocalityProperty) 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 LocalityProperty.ID, LocalityProperty.DATA_SOURCE, and LocalityProperty.NAME properties must be defined.

Returns:

locality

getCachedInstance

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

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

Parameters:

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

Returns:

cached locality or null if not in cache.

buildKey

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

This builds the unique key for this locality based on the LocalityProperty.ID and LocalityProperty.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 locality based on the LocalityProperty.ID and LocalityProperty.DATA_SOURCE.

Parameters:

dataSource - data source

id - identifier

Returns:

key

getName

public java.lang.String getName()

Returns the name of this locality.

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 locality.

Specified by:

getDataSource in interface DBElement

Overrides:

getDataSource in class AbstractDBElement

Returns:

data source

getID

public Identifier getID()

Returns identifier of this locality.

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