Package hec.data.location
Class Location
java.lang.Object
mil.army.usace.hec.metadata.location.LocationTemplate
hec.data.location.LocationTemplate
hec.data.location.Location
- All Implemented Interfaces:
Serializable,Comparable<mil.army.usace.hec.metadata.location.LocationTemplate>
An Object describing a Location.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final String[]static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringFields inherited from class hec.data.location.LocationTemplate
BASE_LOCATION_ID, ID, LOCATION_ID, LocationComparator, SUB_LOCATION_IDFields inherited from class mil.army.usace.hec.metadata.location.LocationTemplate
LOCATION_TEMPLATE_COMPARATOR -
Constructor Summary
ConstructorsConstructorDescriptionLocation()Construct a default Location.Constructor for the Location objectLocation(LocationTemplate template) Constructor for the Location object -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds an Alternative to the Location's Hashtable of Alternatives.static org.jdom.ElementaddAttributeToElement(org.jdom.Element element, String name, String value) voidbuildElement(org.jdom.Element element) booleanbooleanGets the Alternatives attribute of the Location objectvoidstatic StringbooleaninthashCode()static LocationparseElement(org.jdom.Element locationElement) voidsetActive(boolean active) voidsetActiveString(String value) voidsetBoundingOffice(String newId, String newName) voidsetBoundingOfficeId(String newId) voidsetBoundingOfficeName(String newName) voidsetCountyName(String countyName) voidsetDescription(String description) voidvoidsetElevation(Double dbl) voidvoidsetExtendedType(String extendedType) voidsetHorizontalDatum(String horizontalDatum) voidsetLatitude(double dbl) Sets the Location's Latitude to the argument double.voidsetLatitude(Double latitude) voidsetLocationKind(String locationKind) voidsetLocationTemplate(LocationTemplate locTemp) voidsetLocationType(String locationType) voidsetLongitude(double dbl) Sets the Location's Longitude to the argument double.voidsetLongitude(Double longitude) voidsetLongName(String longName) voidsetMapLabel(String mapLabel) voidvoidsetNearestCity(String nearestCity) voidsetPublicName(String publicName) voidsetPublishedLatitude(Double publishedLatitude) voidsetPublishedLongitude(Double publishedLongitude) voidsetStateInitial(String stateInitial) voidsetStoreAlternatives(boolean val) voidsetTimezoneId(String timezoneId) voidsetVerticalDatum(String verticalDatum) Returns a multi-line formatted String displaying the contents of this Location Object.Methods inherited from class hec.data.location.LocationTemplate
getBaseLocationTemplate, getDbOfficeId, getDisplayName, getName, parseMethods inherited from class mil.army.usace.hec.metadata.location.LocationTemplate
compareTo, getBaseLocationId, getLocationId, getOfficeId, getOfficeName, getSubLocationId, hasSubLocation, setBaseLocationId, setLocationId, setLocationId, setOfficeId, setOfficeName, setSubLocationId, toString
-
Field Details
-
NATION_LIST
-
ACTIVE
- See Also:
-
LOCATION_TYPE
- See Also:
-
LOCATION_KIND_ID
- See Also:
-
PUBLIC_NAME
- See Also:
-
LONG_NAME
- See Also:
-
DESCRIPTION
- See Also:
-
NATION
- See Also:
-
STATE
- See Also:
-
INITIAL
- See Also:
-
COUNTY
- See Also:
-
NEAREST_CITY
- See Also:
-
HORIZONTAL_LOCATION
- See Also:
-
ACTUAL
- See Also:
-
LATITUDE
- See Also:
-
LONGITUDE
- See Also:
-
PUBLISHED
- See Also:
-
ELEVATION
- See Also:
-
UNIT
- See Also:
-
DATUM
- See Also:
-
TIMEZONE_NAME
- See Also:
-
MAP_LABEL
- See Also:
-
BOUNDING_OFFICE
- See Also:
-
STATE_INITIAL
- See Also:
-
COUNTY_NAME
- See Also:
-
HORIZONTAL_DATUM
- See Also:
-
ELEV_UNIT_ID
- See Also:
-
VERTICAL_DATUM
- See Also:
-
ACTIVE_FLAG
- See Also:
-
-
Constructor Details
-
Location
Constructor for the Location object- Parameters:
template- Description of Parameter
-
Location
Constructor for the Location object- Parameters:
fromLoc- Description of Parameter
-
Location
public Location()Construct a default Location.
-
-
Method Details
-
setStoreAlternatives
public void setStoreAlternatives(boolean val) -
getStoreAlternatives
public boolean getStoreAlternatives() -
getElevationUnits
-
parseElement
-
buildElement
public void buildElement(org.jdom.Element element) - Overrides:
buildElementin classmil.army.usace.hec.metadata.location.LocationTemplate
-
getAlternativeMap
Gets the Alternatives attribute of the Location object- Returns:
- The Alternatives value
-
addAlternative
Adds an Alternative to the Location's Hashtable of Alternatives.- Parameters:
alt- The feature to be added to the Alternative attribute
-
toStringBig
Returns a multi-line formatted String displaying the contents of this Location Object.- Returns:
- Description of the Returned Value
-
getCountyName
-
setCountyName
-
getDescription
-
setDescription
-
getElevation
-
setElevation
-
getElevation
-
setElevation
-
getElevationUnitId
-
setElevationUnitId
-
getLatitude
-
setLatitude
-
setLatitude
public void setLatitude(double dbl) Sets the Location's Latitude to the argument double.- Parameters:
dbl- The new Latitude value
-
getLocationType
-
setLocationType
-
getExtendedType
-
setExtendedType
-
getLongitude
-
setLongitude
-
setLongitude
public void setLongitude(double dbl) Sets the Location's Longitude to the argument double.- Parameters:
dbl- The new Longitude value
-
getLongName
-
setLongName
-
getPublicName
-
setPublicName
-
getStateInitial
-
setStateInitial
-
getTimezoneId
-
setTimezoneId
-
getVerticalDatum
-
setVerticalDatum
-
equals
- Overrides:
equalsin classmil.army.usace.hec.metadata.location.LocationTemplate
-
hashCode
public int hashCode()- Overrides:
hashCodein classmil.army.usace.hec.metadata.location.LocationTemplate
-
getVerticalDatumWithNullsReplacedByUndefined
-
getHorizontalDatum
-
setHorizontalDatum
-
getActive
public boolean getActive() -
setActive
public void setActive(boolean active) -
getActiveString
-
setActiveString
-
setNation
-
getNation
-
setNearestCity
-
getNearestCity
-
setPublishedLongitude
-
getPublishedLongitude
-
setPublishedLatitude
-
getPublishedLatitude
-
setMapLabel
-
getMapLabel
-
setBoundingOffice
-
getBoundingOfficeId
-
setBoundingOfficeId
-
getBoundingOfficeName
-
setBoundingOfficeName
-
setLocationKind
-
getLocationKind
-
getLocationTemplate
-
setLocationTemplate
-
addAttributeToElement
-