Location (lib-openssrf-3.1.0 1.0.0 API)

java.lang.Object
- us.gov.dod.standard.ssrf._3_1.Common<Location>
- - us.gov.dod.standard.ssrf._3_1.Location

All Implemented Interfaces:: Comparable<Location>

public class Location
extends Common<Location>

Location is used to describe a geographical location, polygonal or ellipse area, or a set of those.

Sub-Elements are Ellipse, POCInformation, Point, Polygon

Example: A simple fixed location:

 <Location cls="U">
   <Serial cls="U">BEL::LO:111</Serial>
   <EntryDateTime cls="U">2011-12-25T00:00:00Z</EntryDateTime>
   <Name cls="U">Brussels National Airpt</Name>
   <Country cls="U">BEL</Country>
   <Point idx="1">
     <Lon cls="U">0050000E</Lon>
     <Lat cls="U">503600N</Lat>
     <TerrainElevation cls="U">50</TerrainElevation>
   </Point>
 </Location>
 A triangle* <Location cls="U">
   <Serial cls="U">BEL::LO:222</Serial>
   <EntryDateTime cls="U">2011-12-25T00:00:00Z</EntryDateTime>
   <Name cls="U">Melsbroek Approach</Name>
   <Country cls="U">BEL</Country>
   <Polygon idx="1">
     <PolygonPoint sequence="1">
       <Lon cls="U">0050000E</Lon>
       <Lat cls="U">503600N</Lat>
     </PolygonPoint>
     <PolygonPoint sequence="2">
       <Lon cls="U">0053000E</Lon>
       <Lat cls="U">503600N</Lat>
     </PolygonPoint>
     <PolygonPoint sequence="3">
       <Lon cls="U">0053000E</Lon>
       <Lat cls="U">504000N</Lat>
     </PolygonPoint>
   </Polygon>
 </Location>
 A composite area with a hole (doughnut):* <Location cls="U">
   <Serial cls="U">BEL::LO:333</Serial>
   <EntryDateTime cls="U">2011-12-25T00:00:00Z</EntryDateTime>
   <Name cls="U">BEL AF Training North</Name>
   <Country cls="U">BEL</Country>
   <Ellipse idx="1">
     <Excluded cls="U">Yes</Excluded>
     <Lon cls="U">0050000E</Lon>
     <Lat cls="U">503600N</Lat>
     <SemiMajorAxis cls="U">10</SemiMajorAxis>
     <SemiMinorAxis cls="U">10</SemiMinorAxis>
     <Azimuth cls="U">0</Azimuth>
   </Ellipse>
   <LocationRef cls="U">BEL::LO:222</LocationRef>
 </Location>

Version:: 3.1.0, 03/30/2015
Author:: Key Bridge LLC

Field Summary
- Fields inherited from class us.gov.dod.standard.ssrf._3_1.Common
  approvedBy, approvedDateTime, caseNum, cls, description, entryBy, entryByRole, entryDateTime, extReferenceRef, extReferences, idref, lastChangeBy, lastChangeByRole, lastChangeDateTime, lastObservedBy, lastReviewBy, lastReviewByRole, lastReviewDate, legacyReleasability, modAllowedBy, modAllowedByRole, observedFirstDateTime, observedLastDateTime, owner, ownerRole, quality, recommendedValue, redacted, releasability, remarkRef, remarks, securityClass, serial, state

Constructor Summary

Constructors
Constructor and Description

Location()
No arg constructor.

Constructors
Constructor and Description
`Location()` No arg constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`S50`	`getCityArea()` Get the city of the address or an operational area name..
`TString`	`getCountry()` Get the country or area code.
`D`	`getEffectiveDate()` Get the date by which the dataset is to be operational or effective..
`Set<Ellipse>`	`getEllipse()` Get the Ellipse
`D`	`getExpirationDate()` Get the date at which the dataset will expire.
`Set<Location>`	`getLocation()` Get the serial of the referenced Location..
`Set<Serial>`	`getLocationRef()` Deprecated. SSRF references are managed automatically. Use `getLocation()` instead.
`S100`	`getName()` Get the name of the location..
`Set<POCInformation>`	`getPOCInformation()` Get the POCInformation
`Set<Point>`	`getPoint()` Get the antenna feed point height above the terrain, in metres.
`Set<Polygon>`	`getPolygon()` Get the Polygon
`S15`	`getPostCode()` Get the zip code or postal code portion of the address..
`D`	`getReviewDate()` Get the date by which the dataset is to be reviewed.
`S50`	`getStateCounty()` Get the state or other sub-national political area..
`S255`	`getStreet()` Get the street address..
`boolean`	`isSet()` Determine if the required fields in this SSRF data type instance are set.
`boolean`	`isSetCityArea()` Determine if the CityArea is configured.
`boolean`	`isSetCountry()` Determine if the Country is configured.
`boolean`	`isSetEffectiveDate()` Determine if the EffectiveDate is configured.
`boolean`	`isSetEllipse()` Determine if the Ellipse is configured.
`boolean`	`isSetExpirationDate()` Determine if the ExpirationDate is configured.
`boolean`	`isSetLocation()` Determine if the location field is configured.
`boolean`	`isSetLocationRef()` Determine if the LocationRef is configured.
`boolean`	`isSetName()` Determine if the Name is configured.
`boolean`	`isSetPOCInformation()` Determine if the POCInformation is configured.
`boolean`	`isSetPoint()` Determine if the Point is configured.
`boolean`	`isSetPolygon()` Determine if the Polygon is configured.
`boolean`	`isSetPostCode()` Determine if the PostCode is configured.
`boolean`	`isSetReviewDate()` Determine if the ReviewDate is configured.
`boolean`	`isSetStateCounty()` Determine if the StateCounty is configured.
`boolean`	`isSetStreet()` Determine if the Street is configured.
`void`	`postLoad(SSRF root)` Update the SSRF data type references in this Location record after loading from XML.
`void`	`prepare()` Update the SSRF data type references in this Location record.
`void`	`setCityArea(S50 value)` Set the city of the address or an operational area name..
`void`	`setCountry(TString value)` Set the country or area code.
`void`	`setEffectiveDate(D value)` Set the date by which the dataset is to be operational or effective..
`void`	`setExpirationDate(D value)` Set the date at which the dataset will expire.
`void`	`setName(S100 value)` Set the name of the location..
`void`	`setPostCode(S15 value)` Set the zip code or postal code portion of the address..
`void`	`setReviewDate(D value)` Set the date by which the dataset is to be reviewed.
`void`	`setStateCounty(S50 value)` Set the state or other sub-national political area..
`void`	`setStreet(S255 value)` Set the street address..
`String`	`toString()` Get a string representation of this Location instance configuration.
`void`	`unsetEllipse()` Clear the Ellipse field.
`void`	`unsetLocationRef()` Clear the LocationRef field.
`void`	`unsetPOCInformation()` Clear the POCInformation field.
`void`	`unsetPoint()` Clear the Point field.
`void`	`unsetPolygon()` Clear the Polygon field.
`Location`	`withCityArea(String value)` Set the city of the address or an operational area name.
`Location`	`withCountry(ListCAO value)` Set the country or area code.
`Location`	`withEffectiveDate(Calendar value)` Set the date by which the dataset is to be operational or effective.
`Location`	`withEffectiveDate(Date value)` Set the date by which the dataset is to be operational or effective.
`Location`	`withEllipse(Collection<Ellipse> values)` Set the Ellipse
`Location`	`withEllipse(Ellipse... values)` Set the Ellipse
`Location`	`withExpirationDate(Calendar value)` Set the date at which the dataset will expire.
`Location`	`withExpirationDate(Date value)` Set the date at which the dataset will expire.
`Location`	`withLocation(Collection<Location> values)` Set the serial of the referenced Location.
`Location`	`withLocation(Location... values)` Set the serial of the referenced Location.
`Location`	`withLocationRef(Collection<Serial> values)` Deprecated. SSRF references are managed automatically. Use `withLocation(Location...)` instead.
`Location`	`withLocationRef(Serial... values)` Deprecated. SSRF references are managed automatically. Use `withLocation(Location...)` instead.
`Location`	`withName(String value)` Set the name of the location.
`Location`	`withPOCInformation(Collection<POCInformation> values)` Set the POCInformation
`Location`	`withPOCInformation(POCInformation... values)` Set the POCInformation
`Location`	`withPoint(Collection<Point> values)` Set the antenna feed point height above the terrain, in metres.
`Location`	`withPoint(Point... values)` Set the antenna feed point height above the terrain, in metres.
`Location`	`withPolygon(Collection<Polygon> values)` Set the Polygon
`Location`	`withPolygon(Polygon... values)` Set the Polygon
`Location`	`withPostCode(String value)` Set the zip code or postal code portion of the address.
`Location`	`withReviewDate(Calendar value)` Set the date by which the dataset is to be reviewed.
`Location`	`withReviewDate(Date value)` Set the date by which the dataset is to be reviewed.
`Location`	`withStateCounty(String value)` Set the state or other sub-national political area.
`Location`	`withStreet(String value)` Set the street address.

Methods inherited from class us.gov.dod.standard.ssrf._3_1.Common
compareTo, equals, getApprovedBy, getApprovedDateTime, getCaseNum, getCls, getDescription, getEntryBy, getEntryByRole, getEntryDateTime, getExtReferenceRef, getExtReferences, getIdref, getLastChangeBy, getLastChangeByRole, getLastChangeDateTime, getLastObservedBy, getLastReviewBy, getLastReviewByRole, getLastReviewDate, getLegacyReleasability, getModAllowedBy, getModAllowedByRole, getObservedFirstDateTime, getObservedLastDateTime, getOwner, getOwnerRole, getQuality, getRecommendedValue, getRedacted, getReleasability, getRemarkRef, getRemarks, getSecurityClass, getSerial, getState, hashCode, isSetApprovedBy, isSetApprovedDateTime, isSetCaseNum, isSetCls, isSetDescription, isSetEntryBy, isSetEntryByRole, isSetEntryDateTime, isSetExtReferenceRef, isSetExtReferences, isSetIdref, isSetLastChangeBy, isSetLastChangeByRole, isSetLastChangeDateTime, isSetLastObservedBy, isSetLastReviewBy, isSetLastReviewByRole, isSetLastReviewDate, isSetLegacyReleasability, isSetModAllowedBy, isSetModAllowedByRole, isSetObservedFirstDateTime, isSetObservedLastDateTime, isSetOwner, isSetOwnerRole, isSetQuality, isSetRecommendedValue, isSetRedacted, isSetReleasability, isSetRemarkRef, isSetRemarks, isSetSecurityClass, isSetSerial, isSetState, setApprovedBy, setApprovedDateTime, setCls, setDescription, setEntryBy, setEntryDateTime, setIdref, setLastChangeBy, setLastChangeDateTime, setLastObservedBy, setLastReviewBy, setLastReviewDate, setLegacyReleasability, setModAllowedBy, setObservedFirstDateTime, setObservedLastDateTime, setOwner, setQuality, setRecommendedValue, setRedacted, setSecurityClass, setSerial, setState, unsetCaseNum, unsetExtReferenceRef, unsetExtReferences, unsetReleasability, unsetRemarkRef, unsetRemarks, withApprovedBy, withApprovedDateTime, withApprovedDateTime, withCaseNum, withCaseNum, withCls, withDescription, withEntryBy, withEntryByRole, withEntryDateTime, withExtReferenceRef, withExtReferenceRef, withExtReferences, withExtReferences, withExtReferences, withIdref, withLastChangeBy, withLastChangeByRole, withLastChangeDateTime, withLastChangeDateTime, withLastObservedBy, withLastReviewBy, withLastReviewByRole, withLastReviewDate, withLastReviewDate, withLegacyReleasability, withModAllowedBy, withModAllowedByRole, withObservedFirstDateTime, withObservedFirstDateTime, withObservedLastDateTime, withObservedLastDateTime, withOwner, withOwnerRole, withQuality, withRecommendedValue, withRedacted, withReleasability, withReleasability, withRemarkRef, withRemarkRef, withRemarkRef, withRemarks, withRemarks, withSecurityClass, withSerial, withState

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Location
```
public Location()
```
    No arg constructor. Initializes the Common required fields.
- Method Detail
  - getEffectiveDate
```
public D getEffectiveDate()
```
    Get the date by which the dataset is to be operational or effective..
    
    Returns:
    
    a D instance
    
    Since:
    
    3.1.0
  - setEffectiveDate
```
public void setEffectiveDate(D value)
```
    Set the date by which the dataset is to be operational or effective..
    
    Parameters:
    
    value - a D instance
    
    Since:
    
    3.1.0
  - isSetEffectiveDate
```
public boolean isSetEffectiveDate()
```
    Determine if the EffectiveDate is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getExpirationDate
```
public D getExpirationDate()
```
    Get the date at which the dataset will expire. The Expiration date should be less than five years from current date..
    
    Returns:
    
    a D instance
    
    Since:
    
    3.1.0
  - setExpirationDate
```
public void setExpirationDate(D value)
```
    Set the date at which the dataset will expire. The Expiration date should be less than five years from current date..
    
    Parameters:
    
    value - a D instance
    
    Since:
    
    3.1.0
  - isSetExpirationDate
```
public boolean isSetExpirationDate()
```
    Determine if the ExpirationDate is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getReviewDate
```
public D getReviewDate()
```
    Get the date by which the dataset is to be reviewed. The Review date should be less than five years from the effective date. In Data Item Spectrum Supportability datasets, this date indicate when the organisation responsible for re-initiating host coordination plans to resubmit a Spectrum Supportability request to the host nation for continued use of the equipment..
    
    Returns:
    
    a D instance
    
    Since:
    
    3.1.0
  - setReviewDate
```
public void setReviewDate(D value)
```
    Set the date by which the dataset is to be reviewed. The Review date should be less than five years from the effective date. In Data Item Spectrum Supportability datasets, this date indicate when the organisation responsible for re-initiating host coordination plans to resubmit a Spectrum Supportability request to the host nation for continued use of the equipment..
    
    Parameters:
    
    value - a D instance
    
    Since:
    
    3.1.0
  - isSetReviewDate
```
public boolean isSetReviewDate()
```
    Determine if the ReviewDate is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getName
```
public S100 getName()
```
    Get the name of the location..
    
    Returns:
    
    a S100 instance
    
    Since:
    
    3.1.0
  - setName
```
public void setName(S100 value)
```
    Set the name of the location..
    
    Parameters:
    
    value - a S100 instance
    
    Since:
    
    3.1.0
  - isSetName
```
public boolean isSetName()
```
    Determine if the Name is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getStreet
```
public S255 getStreet()
```
    Get the street address..
    
    Returns:
    
    a S255 instance
    
    Since:
    
    3.1.0
  - setStreet
```
public void setStreet(S255 value)
```
    Set the street address..
    
    Parameters:
    
    value - a S255 instance
    
    Since:
    
    3.1.0
  - isSetStreet
```
public boolean isSetStreet()
```
    Determine if the Street is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getCityArea
```
public S50 getCityArea()
```
    Get the city of the address or an operational area name..
    
    Returns:
    
    a S50 instance
    
    Since:
    
    3.1.0
  - setCityArea
```
public void setCityArea(S50 value)
```
    Set the city of the address or an operational area name..
    
    Parameters:
    
    value - a S50 instance
    
    Since:
    
    3.1.0
  - isSetCityArea
```
public boolean isSetCityArea()
```
    Determine if the CityArea is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getStateCounty
```
public S50 getStateCounty()
```
    Get the state or other sub-national political area..
    
    Returns:
    
    a S50 instance
    
    Since:
    
    3.1.0
  - setStateCounty
```
public void setStateCounty(S50 value)
```
    Set the state or other sub-national political area..
    
    Parameters:
    
    value - a S50 instance
    
    Since:
    
    3.1.0
  - isSetStateCounty
```
public boolean isSetStateCounty()
```
    Determine if the StateCounty is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getPostCode
```
public S15 getPostCode()
```
    Get the zip code or postal code portion of the address..
    
    Returns:
    
    a S15 instance
    
    Since:
    
    3.1.0
  - setPostCode
```
public void setPostCode(S15 value)
```
    Set the zip code or postal code portion of the address..
    
    Parameters:
    
    value - a S15 instance
    
    Since:
    
    3.1.0
  - isSetPostCode
```
public boolean isSetPostCode()
```
    Determine if the PostCode is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getCountry
```
public TString getCountry()
```
    Get the country or area code. Use a one to six alphabetic characters representing either an official country code, a regional body, a group of countries or a NATO Command..
    
    Returns:
    
    the Country value in a TString data type
    
    Since:
    
    3.1.0
  - setCountry
```
public void setCountry(TString value)
```
    Set the country or area code. Use a one to six alphabetic characters representing either an official country code, a regional body, a group of countries or a NATO Command..
    
    Parameters:
    
    value - the Country value in a TString data type
    
    Since:
    
    3.1.0
  - isSetCountry
```
public boolean isSetCountry()
```
    Determine if the Country is configured.
    If configured this method also inspects the TString wrapped value.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getPOCInformation
```
public Set<POCInformation> getPOCInformation()
```
    Get the POCInformation
    Complex element POCInformation contains a reference to a Contact, Organisation or Role dataset..
    
    Returns:
    
    a POCInformation instance
    
    Since:
    
    3.1.0
  - isSetPOCInformation
```
public boolean isSetPOCInformation()
```
    Determine if the POCInformation is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - unsetPOCInformation
```
public void unsetPOCInformation()
```
    Clear the POCInformation field. This sets the field to null.
  - getPoint
```
public Set<Point> getPoint()
```
    Get the antenna feed point height above the terrain, in metres. In the case where the antenna is mounted pointing vertically to a reflector on the same structure, enter the height of the reflector above ground. If the Station is a flying object, this data represents the maximum altitude of the object above ground..
    
    Returns:
    
    a Point instance
    
    Since:
    
    3.1.0
  - isSetPoint
```
public boolean isSetPoint()
```
    Determine if the Point is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - unsetPoint
```
public void unsetPoint()
```
    Clear the Point field. This sets the field to null.
  - getPolygon
```
public Set<Polygon> getPolygon()
```
    Get the Polygon
    Complex element Polygon is a closed geometric shape on the surface of the Earth, defined by at least three points, used to describe an operational area or an excluded area..
    
    Returns:
    
    a Polygon instance
    
    Since:
    
    3.1.0
  - isSetPolygon
```
public boolean isSetPolygon()
```
    Determine if the Polygon is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - unsetPolygon
```
public void unsetPolygon()
```
    Clear the Polygon field. This sets the field to null.
  - getEllipse
```
public Set<Ellipse> getEllipse()
```
    Get the Ellipse
    Complex element Ellipse on the horizontal plane, defined by its semi-major and semi-minor axis, and by the orientation (azimuth) of the semi-major axis. This element SHALL NOT be used to describe a satellite orbit..
    
    Returns:
    
    a Ellipse instance
    
    Since:
    
    3.1.0
  - isSetEllipse
```
public boolean isSetEllipse()
```
    Determine if the Ellipse is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - unsetEllipse
```
public void unsetEllipse()
```
    Clear the Ellipse field. This sets the field to null.
  - getLocationRef
```
@Deprecated
public Set<Serial> getLocationRef()
```
    Deprecated. SSRF references are managed automatically. Use getLocation() instead.
    
    Get the serial of the referenced Location..
    
    Returns:
    
    a Serial instance
    
    Since:
    
    3.1.0
  - isSetLocationRef
```
public boolean isSetLocationRef()
```
    Determine if the LocationRef is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - unsetLocationRef
```
public void unsetLocationRef()
```
    Clear the LocationRef field. This sets the field to null.
  - withEffectiveDate
```
public Location withEffectiveDate(Calendar value)
```
    Set the date by which the dataset is to be operational or effective.
    
    Parameters:
    
    value - An instances of type Calendar.
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - withEffectiveDate
```
public Location withEffectiveDate(Date value)
```
    Set the date by which the dataset is to be operational or effective.
    
    Parameters:
    
    value - An instances of type Date.
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - withExpirationDate
```
public Location withExpirationDate(Calendar value)
```
    Set the date at which the dataset will expire. The Expiration date should be less than five years from current date.
    
    Parameters:
    
    value - An instances of type Calendar.
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - withExpirationDate
```
public Location withExpirationDate(Date value)
```
    Set the date at which the dataset will expire. The Expiration date should be less than five years from current date.
    
    Parameters:
    
    value - An instances of type Date.
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - withReviewDate
```
public Location withReviewDate(Calendar value)
```
    Set the date by which the dataset is to be reviewed. The Review date should be less than five years from the effective date. In Data Item Spectrum Supportability datasets, this date indicate when the organisation responsible for re-initiating host coordination plans to resubmit a Spectrum Supportability request to the host nation for continued use of the equipment.
    
    Parameters:
    
    value - An instances of type Calendar.
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - withReviewDate
```
public Location withReviewDate(Date value)
```
    Set the date by which the dataset is to be reviewed. The Review date should be less than five years from the effective date. In Data Item Spectrum Supportability datasets, this date indicate when the organisation responsible for re-initiating host coordination plans to resubmit a Spectrum Supportability request to the host nation for continued use of the equipment.
    
    Parameters:
    
    value - An instances of type Date.
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - withName
```
public Location withName(String value)
```
    Set the name of the location.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - withStreet
```
public Location withStreet(String value)
```
    Set the street address.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - withCityArea
```
public Location withCityArea(String value)
```
    Set the city of the address or an operational area name.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - withStateCounty
```
public Location withStateCounty(String value)
```
    Set the state or other sub-national political area.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - withPostCode
```
public Location withPostCode(String value)
```
    Set the zip code or postal code portion of the address.
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - withCountry
```
public Location withCountry(ListCAO value)
```
    Set the country or area code. Use a one to six alphabetic characters representing either an official country code, a regional body, a group of countries or a NATO Command.
    
    Parameters:
    
    value - An instances of type ListCAO.
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - withPOCInformation
```
public Location withPOCInformation(POCInformation... values)
```
    Set the POCInformation
    Complex element POCInformation contains a reference to a Contact, Organisation or Role dataset.
    
    Parameters:
    
    values - One or more instances of type POCInformation....
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - withPOCInformation
```
public Location withPOCInformation(Collection<POCInformation> values)
```
    Set the POCInformation
    Complex element POCInformation contains a reference to a Contact, Organisation or Role dataset.
    
    Parameters:
    
    values - A collection of POCInformation instances
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - withPoint
```
public Location withPoint(Point... values)
```
    Set the antenna feed point height above the terrain, in metres. In the case where the antenna is mounted pointing vertically to a reflector on the same structure, enter the height of the reflector above ground. If the Station is a flying object, this data represents the maximum altitude of the object above ground.
    
    Parameters:
    
    values - One or more instances of type Point....
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - withPoint
```
public Location withPoint(Collection<Point> values)
```
    Set the antenna feed point height above the terrain, in metres. In the case where the antenna is mounted pointing vertically to a reflector on the same structure, enter the height of the reflector above ground. If the Station is a flying object, this data represents the maximum altitude of the object above ground.
    
    Parameters:
    
    values - A collection of Point instances
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - withPolygon
```
public Location withPolygon(Polygon... values)
```
    Set the Polygon
    Complex element Polygon is a closed geometric shape on the surface of the Earth, defined by at least three points, used to describe an operational area or an excluded area.
    
    Parameters:
    
    values - One or more instances of type Polygon....
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - withPolygon
```
public Location withPolygon(Collection<Polygon> values)
```
    Set the Polygon
    Complex element Polygon is a closed geometric shape on the surface of the Earth, defined by at least three points, used to describe an operational area or an excluded area.
    
    Parameters:
    
    values - A collection of Polygon instances
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - withEllipse
```
public Location withEllipse(Ellipse... values)
```
    Set the Ellipse
    Complex element Ellipse on the horizontal plane, defined by its semi-major and semi-minor axis, and by the orientation (azimuth) of the semi-major axis. This element SHALL NOT be used to describe a satellite orbit.
    
    Parameters:
    
    values - One or more instances of type Ellipse....
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - withEllipse
```
public Location withEllipse(Collection<Ellipse> values)
```
    Set the Ellipse
    Complex element Ellipse on the horizontal plane, defined by its semi-major and semi-minor axis, and by the orientation (azimuth) of the semi-major axis. This element SHALL NOT be used to describe a satellite orbit.
    
    Parameters:
    
    values - A collection of Ellipse instances
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - withLocationRef
```
@Deprecated
public Location withLocationRef(Serial... values)
```
    Deprecated. SSRF references are managed automatically. Use withLocation(Location...) instead.
    
    Set the serial of the referenced Location.
    
    Parameters:
    
    values - One or more instances of type LocationRef....
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - withLocationRef
```
@Deprecated
public Location withLocationRef(Collection<Serial> values)
```
    Deprecated. SSRF references are managed automatically. Use withLocation(Location...) instead.
    
    Set the serial of the referenced Location.
    
    Parameters:
    
    values - A collection of Serial instances
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - toString
```
public String toString()
```
    Get a string representation of this Location instance configuration.
    
    Overrides:
    
    toString in class Common<Location>
    
    Returns:
    
    The current object instance configuration as a non-null String
  - isSet
```
public boolean isSet()
```
    Determine if the required fields in this SSRF data type instance are set.
    Location requires cls, Serial, EntryDateTime and Name.
    Note that this method only checks for the presence of required information; this method does not validate the information format.
    
    Overrides:
    
    isSet in class Common<Location>
    
    Returns:
    
    TRUE if required fields are set, otherwise FALSE
  - getLocation
```
public Set<Location> getLocation()
```
    Get the serial of the referenced Location..
    
    Returns:
    
    a Location instance
    
    Since:
    
    3.1.0
  - isSetLocation
```
public boolean isSetLocation()
```
    Determine if the location field is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - withLocation
```
public Location withLocation(Location... values)
```
    Set the serial of the referenced Location.
    
    Parameters:
    
    values - An instances of type Location.
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - withLocation
```
public Location withLocation(Collection<Location> values)
```
    Set the serial of the referenced Location.
    
    Parameters:
    
    values - An instances of type Location.
    
    Returns:
    
    The current Location object instance.
    
    Since:
    
    3.1.0
  - prepare
```
public void prepare()
```
    Update the SSRF data type references in this Location record.
    This method builds the exported locationRef field with values from the transient location field. This method should typically be called after the Location is configured and (optionally) before exporting an SSRF message.
    
    Overrides:
    
    prepare in class Common<Location>
    
    Since:
    
    3.1.0
  - postLoad
```
public void postLoad(SSRF root)
```
    Update the SSRF data type references in this Location record after loading from XML.
    This method builds the transient location with values from the imported locationRef field. This method should typically be called after the Location is imported from XML.
    
    Overrides:
    
    postLoad in class Common<Location>
    
    Parameters:
    
    root - the SSRF root instance.
    
    Since:
    
    3.1.0

Class Location

Field Summary

Fields inherited from class us.gov.dod.standard.ssrf._3_1.Common

Constructor Summary

Method Summary

Methods inherited from class us.gov.dod.standard.ssrf._3_1.Common

Methods inherited from class java.lang.Object

Constructor Detail

Location

Method Detail

getEffectiveDate

setEffectiveDate

isSetEffectiveDate

getExpirationDate

setExpirationDate

isSetExpirationDate

getReviewDate

setReviewDate

isSetReviewDate

getName

setName

isSetName

getStreet

setStreet

isSetStreet

getCityArea

setCityArea

isSetCityArea

getStateCounty

setStateCounty

isSetStateCounty

getPostCode

setPostCode

isSetPostCode

getCountry

setCountry

isSetCountry

getPOCInformation

isSetPOCInformation

unsetPOCInformation

getPoint

isSetPoint

unsetPoint

getPolygon

isSetPolygon

unsetPolygon

getEllipse

isSetEllipse

unsetEllipse

getLocationRef

isSetLocationRef

unsetLocationRef

withEffectiveDate

withEffectiveDate

withExpirationDate

withExpirationDate

withReviewDate

withReviewDate

withName

withStreet

withCityArea

withStateCounty

withPostCode

withCountry

withPOCInformation

withPOCInformation

withPoint

withPoint

withPolygon

withPolygon

withEllipse

withEllipse

withLocationRef

withLocationRef

toString

isSet

getLocation

isSetLocation

withLocation

withLocation