admindivision

Documentation

Overview

Package admindivision 实现中国统计用行政区划查询工具

Index

• func DescribeDivisionChain(divisions []*Division, sep string) string
• func JoinDivisionCodes(divisions []*Division) string
• type AdministrativeLevel
  • func (l AdministrativeLevel) String() string
• type Division
  • func MatchDivisionByName(name ...string) []*Division
  • func ProvinceByCode(code string) *Division
  • func Provinces() []*Division
  • func SearchDivisionByCode(code string) []*Division
  • func SearchDivisionByName(name ...string) []*Division
  • func (d *Division) Code() string
  • func (d *Division) Deprecated() bool
  • func (d *Division) FullCode() string
  • func (d *Division) Level() AdministrativeLevel
  • func (d *Division) Name() string
  • func (d Division) String() string
  • func (d *Division) SubDivisionByCode(code string) *Division
  • func (d *Division) SubDivisions() []*Division
  • func (d *Division) Virtual() bool

Functions

func DescribeDivisionChain

func DescribeDivisionChain(divisions []*Division, sep string) string

DescribeDivisionChain 描述一个区划链

func JoinDivisionCodes

func JoinDivisionCodes(divisions []*Division) string

JoinDivisionCodes 将一个区划链的代码连接成一个字符串。注意, 仅按照层级 join, 不包含最后的补零

Types

type AdministrativeLevel

type AdministrativeLevel int

AdministrativeLevel 行政层级

const (
	Province AdministrativeLevel = iota + 1
	City
	County
)

func (AdministrativeLevel) String

func (l AdministrativeLevel) String() string

type Division

type Division struct {
	// contains filtered or unexported fields
}

Division 表示一级行政区划

func MatchDivisionByName

func MatchDivisionByName(name ...string) []*Division

MatchDivisionByName 按照一个行政区划名称搜索行政节点层级链, 必须以省级行政区开始查询, 而且必须与数据库中的名称完全一致

func ProvinceByCode

func ProvinceByCode(code string) *Division

ProvinceByCode 按代码查找省级行政区

func Provinces

func Provinces() []*Division

Provinces 返回省份列表

func SearchDivisionByCode

func SearchDivisionByCode(code string) []*Division

SearchDivisionByCode 按照一个行政区划搜索行政节点层级链

func SearchDivisionByName

func SearchDivisionByName(name ...string) []*Division

SearchDivisionByName 按照一个行政区划名称搜索行政节点层级链, 必须以省级行政区开始查询, 如果查找不到则按照前缀匹配

func (*Division) Code

func (d *Division) Code() string

单独区域代码, 不包含上级节点

func (*Division) Deprecated

func (d *Division) Deprecated() bool

是否已撤销

func (*Division) FullCode

func (d *Division) FullCode() string

FullCode 完整区域代码, 包含上级节点

func (*Division) Level

func (d *Division) Level() AdministrativeLevel

Level 返回行政层级

func (*Division) Name

func (d *Division) Name() string

官方名称, 不包含上级节点

func (Division) String

func (d Division) String() string

func (*Division) SubDivisionByCode

func (d *Division) SubDivisionByCode(code string) *Division

SubDivisionByCode 按下一层级的子代码查询行政区划, 如果查不到则返回 nil

func (*Division) SubDivisions

func (d *Division) SubDivisions() []*Division

SubDivisions 获取下一层级的区划列表

func (*Division) Virtual

func (d *Division) Virtual() bool

是否虚拟行政节点。直辖市、香港、澳门的 Virtual() 返回 true