Package hec.data.location

Class LocationTemplate

java.lang.Object

mil.army.usace.hec.metadata.location.LocationTemplate

hec.data.location.LocationTemplate

All Implemented Interfaces:

Serializable, Comparable<mil.army.usace.hec.metadata.location.LocationTemplate>

Direct Known Subclasses:

Location

public class LocationTemplate
extends mil.army.usace.hec.metadata.location.LocationTemplate

Since:

May 8, 2001

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_LOCATION_ID
static final String	ID
static final String	LOCATION_ID
static final Comparator<LocationTemplate>	LocationComparator
static final String	SUB_LOCATION_ID

Fields inherited from class mil.army.usace.hec.metadata.location.LocationTemplate

LOCATION_TEMPLATE_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
LocationTemplate()
LocationTemplate(LocationTemplate template)	Constructor for the LocationTemplate object
LocationTemplate(String locdescString)	Constructs a new LocationDescription from the argument Strings.
LocationTemplate(String officeId, String locationId)	Constructs a new LocationTemplate from the argument Strings.
LocationTemplate(String officeId, String baseLocationId, String subLocationId)
LocationTemplate(mil.army.usace.hec.metadata.location.LocationTemplate template)	Constructor for the LocationTemplate object

Method Summary

Modifier and Type	Method	Description
final LocationTemplate	getBaseLocationTemplate()
final DbOfficeId	getDbOfficeId()
String	getDisplayName()	Deprecated.
String	getName()	Deprecated. this method was added in because the NamedType hierarchy was elimated
static LocationTemplate	parse(org.jdom.Element locationElement)

Methods inherited from class mil.army.usace.hec.metadata.location.LocationTemplate

buildElement, compareTo, equals, getBaseLocationId, getLocationId, getOfficeId, getOfficeName, getSubLocationId, hashCode, hasSubLocation, setBaseLocationId, setLocationId, setLocationId, setOfficeId, setOfficeName, setSubLocationId, toString

Methods inherited from class java.lang.Object

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

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

BASE_LOCATION_ID

public static final String BASE_LOCATION_ID

See Also:

• Constant Field Values

SUB_LOCATION_ID

public static final String SUB_LOCATION_ID

See Also:

• Constant Field Values

LOCATION_ID

public static final String LOCATION_ID

See Also:

• Constant Field Values

LocationComparator

public static final Comparator<LocationTemplate> LocationComparator

Constructor Details

LocationTemplate

public LocationTemplate()

LocationTemplate

public LocationTemplate(String locdescString)

Constructs a new LocationDescription from the argument Strings.

Parameters:

locdescString - Description of Parameter

LocationTemplate

public LocationTemplate(LocationTemplate template)

Constructor for the LocationTemplate object

Parameters:

template - Description of Parameter

LocationTemplate

public LocationTemplate(mil.army.usace.hec.metadata.location.LocationTemplate template)

Constructor for the LocationTemplate object

Parameters:

template - Description of Parameter

LocationTemplate

public LocationTemplate(String officeId,
 String locationId)

Constructs a new LocationTemplate from the argument Strings.

Parameters:

officeId - Description of Parameter

locationId - Description of Parameter

LocationTemplate

public LocationTemplate(String officeId,
 String baseLocationId,
 String subLocationId)

Method Details

getName

@Deprecated
public String getName()

Deprecated.

this method was added in because the NamedType hierarchy was elimated

Returns:

locationId

getDisplayName

@Deprecated
public String getDisplayName()

Deprecated.

getBaseLocationTemplate

public final LocationTemplate getBaseLocationTemplate()

Overrides:

getBaseLocationTemplate in class mil.army.usace.hec.metadata.location.LocationTemplate

getDbOfficeId

public final DbOfficeId getDbOfficeId()

Overrides:

getDbOfficeId in class mil.army.usace.hec.metadata.location.LocationTemplate

parse

public static LocationTemplate parse(org.jdom.Element locationElement)