Location (klokwrk-project unspecified)

org.klokwrk.cargotracking.domain.model.value.Location

All Implemented Interfaces and Traits:

PostMapConstructorCheckable
```
@KwrkImmutable
@CompileStatic
class Location
extends Object
implements PostMapConstructorCheckable
```
Represents a location data as specified by UN/LOCODE standard.
Useful references:
- https://www.unece.org/cefact/codesfortrade/codes_index.html
- https://service.unece.org/trade/locode/Service/LocodeColumn.htm
- https://www.unece.org/cefact/locode/service/location
- https://service.unece.org/trade/locode/hr.htm
- http://tfig.unece.org/contents/recommendation-16.htm

Properties Summary

Properties
Type	Name and description
`static Location`	`UNKNOWN_LOCATION`
`InternationalizedName`	`countryName` The name of the country to which this location belongs.
`InternationalizedName`	`name` Location name expressed in their natural language if possible.
`PortCapabilities`	`portCapabilities` Capabilities of a port.
`UnLoCode`	`unLoCode`
`UnLoCodeCoordinates`	`unLoCodeCoordinates` 12-character coordinates string for the UN/LOCODE location.
`UnLoCodeFunction`	`unLoCodeFunction` 8-character function classifier code for the UN/LOCODE location.

Constructor Summary

Constructors
Constructor and description
`Location()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static Location`	`make(String unLoCode, String name, String countryName, String unLoCodeFunction, String unLoCodeCoordinates, PortCapabilities portCapabilities)`
	`void`	`postMapConstructorCheck(Map<String, ?> constructorArguments)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, toString, hashCode, getClass, notify, notifyAll, wait, wait, wait`

- Property Detail
  - static final Location UNKNOWN_LOCATION
  - InternationalizedName countryName
    
    The name of the country to which this location belongs.
  - InternationalizedName name
    
    Location name expressed in their natural language if possible.
    Original UnLoCode spec defines character set as: "Roman alphabet using the 26 characters of the character set adopted for international trade data interchange, with diacritic signs, when practicable". However, we are using UTF-8 so all location names can be fully specified in their natural language.
  - PortCapabilities portCapabilities
    
    Capabilities of a port.
    It supplements information from unLoCodeFunction with a list of port features.
  - UnLoCode unLoCode
  - UnLoCodeCoordinates unLoCodeCoordinates
    
    12-character coordinates string for the UN/LOCODE location.
  - UnLoCodeFunction unLoCodeFunction
    
    8-character function classifier code for the UN/LOCODE location.
- Constructor Detail
  - Location()
- Method Detail
  - @SuppressWarnings(value: CodeNarc.ParameterCount)
    static Location make(String unLoCode, String name, String countryName, String unLoCodeFunction, String unLoCodeCoordinates, PortCapabilities portCapabilities)
  - @Override
    void postMapConstructorCheck(Map<String, ?> constructorArguments)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Location

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static final Location UNKNOWN_LOCATION

InternationalizedName countryName

InternationalizedName name

PortCapabilities portCapabilities

UnLoCode unLoCode

UnLoCodeCoordinates unLoCodeCoordinates

UnLoCodeFunction unLoCodeFunction

Constructor Detail

Location()

Method Detail

@SuppressWarnings(value: CodeNarc.ParameterCount)
static Location make(String unLoCode, String name, String countryName, String unLoCodeFunction, String unLoCodeCoordinates, PortCapabilities portCapabilities)

@Override
void postMapConstructorCheck(Map<String, ?> constructorArguments)

[Groovy] Class Location

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static final Location UNKNOWN_LOCATION

InternationalizedName countryName

InternationalizedName name

PortCapabilities portCapabilities

UnLoCode unLoCode

UnLoCodeCoordinates unLoCodeCoordinates

UnLoCodeFunction unLoCodeFunction

Constructor Detail

Location()

Method Detail

@SuppressWarnings(value: CodeNarc.ParameterCount)static Location make(String unLoCode, String name, String countryName, String unLoCodeFunction, String unLoCodeCoordinates, PortCapabilities portCapabilities)

@Overridevoid postMapConstructorCheck(Map<String, ?> constructorArguments)

@SuppressWarnings(value: CodeNarc.ParameterCount)
static Location make(String unLoCode, String name, String countryName, String unLoCodeFunction, String unLoCodeCoordinates, PortCapabilities portCapabilities)

@Override
void postMapConstructorCheck(Map<String, ?> constructorArguments)