gov.usda.gdpc
Interface LocalityGroup

All Superinterfaces:
java.util.Collection, DBElementGroup, Group, java.util.List
All Known Implementing Classes:
AbstractLocalityGroup

public interface LocalityGroup
extends DBElementGroup

Collection of locality.

Author:
terryc

Method Summary
 Locality getLocality(java.lang.String dataSource, Identifier id)
          This returns the locality instance from this group that matches the specified id and source.
 LocalityGroup getLocalityGroup(LocalityFilter filter)
          Get the locality group matching the given filter from this locality group.
 
Methods inherited from interface gov.usda.gdpc.DBElementGroup
getDBElements, getDefinedProperties, getDistinctProperties, getType, index
 
Methods inherited from interface java.util.List
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray
 

Method Detail

getLocalityGroup

public LocalityGroup getLocalityGroup(LocalityFilter filter)
Get the locality group matching the given filter from this locality group.

Parameters:
filter - filter
Returns:
locality group

getLocality

public Locality getLocality(java.lang.String dataSource,
                            Identifier id)
This returns the locality instance from this group that matches the specified id and source. Null will be returned if its not in this group.

Parameters:
dataSource - data source
id - identifier
Returns:
locality or null if not in this group.