forked from TrueCloudLab/frostfs-node
db703a5117
Define a structure for dealing with the geographic location of nodes. Implement VerifyAndUpdate (with the same purpose as NodeValidator interface) that checks LOCODE attribute and fills other attributes of the location. Technically the entity is a wrapper over the NeoFS location database: it maps the node LOCODE to the database record from which the new attributes are generated. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
67 lines
1.8 KiB
Go
67 lines
1.8 KiB
Go
package locode
|
|
|
|
// Prm groups the required parameters of the Validator's constructor.
|
|
//
|
|
// All values must comply with the requirements imposed on them.
|
|
// Passing incorrect parameter values will result in constructor
|
|
// failure (error or panic depending on the implementation).
|
|
type Prm struct {
|
|
// NeoFS LOCODE database interface.
|
|
//
|
|
// Must not be nil.
|
|
DB DB
|
|
}
|
|
|
|
// Validator is an utility that verifies and updates
|
|
// node attributes associated with its geographical location
|
|
// (LOCODE).
|
|
//
|
|
// For correct operation, Validator must be created
|
|
// using the constructor (New) based on the required parameters
|
|
// and optional components. After successful creation,
|
|
// the Validator is immediately ready to work through API.
|
|
type Validator struct {
|
|
db DB
|
|
|
|
mAttr map[string]attrDescriptor
|
|
}
|
|
|
|
// TODO: define constants in API lib.
|
|
const (
|
|
attrKeyLocode = "Locode"
|
|
|
|
attrKeyCountryCode = "CountryCode"
|
|
attrKeyCountry = "Country"
|
|
|
|
attrKeyLocationCode = "CityCode"
|
|
attrKeyLocation = "City"
|
|
|
|
attrKeySubDivCode = "SubDivCode"
|
|
attrKeySubDiv = "SubDiv"
|
|
|
|
attrKeyContinent = "Continent"
|
|
)
|
|
|
|
// New creates a new instance of the Validator.
|
|
//
|
|
// Panics if at least one value of the parameters is invalid.
|
|
//
|
|
// The created Validator does not require additional
|
|
// initialization and is completely ready for work.
|
|
func New(prm Prm) *Validator {
|
|
return &Validator{
|
|
db: prm.DB,
|
|
mAttr: map[string]attrDescriptor{
|
|
attrKeyCountryCode: {converter: countryCodeValue},
|
|
attrKeyCountry: {converter: countryValue},
|
|
|
|
attrKeyLocationCode: {converter: locationCodeValue},
|
|
attrKeyLocation: {converter: locationValue},
|
|
|
|
attrKeySubDivCode: {converter: subDivCodeValue, optional: true},
|
|
attrKeySubDiv: {converter: subDivValue, optional: true},
|
|
|
|
attrKeyContinent: {converter: continentValue},
|
|
},
|
|
}
|
|
}
|