jp_prefecture

package module
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 29, 2019 License: MIT Imports: 1 Imported by: 0

README

jp_prefecture

CircleCI GoDoc

jp_prefectureJIS X 0401 の規格に基づいた都道府県情報の取得、及び検索機能を提供するライブラリです。

参考:全国地方公共団体コード

インストール

go get github.com/diverse-inc/jp_prefecture

使い方

package main

import (
	"log"

	pref "github.com/diverse-inc/jp_prefecture"
)

var (
	prefInfo pref.Prefecture
	ok       bool
)

// 都道府県はPrefectureインターフェースとして返されます。
// 取得に失敗するとokにはfalseが設定されます
prefInfo, ok = pref.FindByCode(1)
if !ok {
	log.Print("prefecture not found.")
} else {
	log.Print(prefInfo.Code())       // 都道府県コード
	log.Print(prefInfo.Kanji())      // 都道府県名(漢字:末尾の「都」、「府」、「県」を除外)
	log.Print(prefInfo.KanjiShort()) // 都道府県名(漢字)
	log.Print(prefInfo.Kana())       // 都道府県名(かな)
	log.Print(prefInfo.KanaShort())  // 都道府県名(かな:末尾の「と」、「ふ」、「けん」を除外)
	log.Print(prefInfo.Roma())       // 都道府県名(ローマ字)
	log.Print(prefInfo.RomaShort())  // 都道府県名(ローマ字:末尾の「-to」、「-fu」、「-ken」を除外)
}

// 漢字名検索では末尾の「都」、「府」、「県」は省略して検索できます。
// ※省略しない場合でも問題ありません。
prefInfo, ok = pref.FindByKanji("東京")

// かな検索では末尾の「と」、「ふ」、「けん」は省略して検索できます。
// ※省略しない場合でも問題ありません。
prefInfo, ok = pref.FindByKana("とうきょう")

// ローマ字検索では末尾の「-to」、「-fu」、「-ken」は省略して検索できます。
// ※省略しない場合でも問題ありません。
prefInfo, ok = pref.FindByRoma("tokyo")

// List関数は全ての都道府県リストを返します。
prefs := pref.List()

// RegionList関数は地域のリストを返します。
// 各地域はRegionインターフェースとして返されます。
regions := pref.RegionList()

for _, region := range regions {
	// RegionインターフェースはPrefectureインターフェースと同様に、漢字名、かな名、ローマ字名を取得することが出来ます。
	region.Kanji()
	region.Kana()
	region.Roma()

	// RegionインターフェースはListメソッドを呼ぶことで、その地域に所属する都道府県リストを取得することが出来ます。
	prefs := region.List()
}

Documentation

Index

Constants

View Source
const (
	JISCodeHokkaido  = 1
	JISCodeAomori    = 2
	JISCodeIwate     = 3
	JISCodeMiyagi    = 4
	JISCodeAkita     = 5
	JISCodeYamagata  = 6
	JISCodeFukushima = 7
	JISCodeIbaraki   = 8
	JISCodeTochigi   = 9
	JISCodeGunma     = 10
	JISCodeSaitama   = 11
	JISCodeChiba     = 12
	JISCodeTokyo     = 13
	JISCodeKanagawa  = 14
	JISCodeNiigata   = 15
	JISCodeToyama    = 16
	JISCodeIshikawa  = 17
	JISCodeFukui     = 18
	JISCodeYamanashi = 19
	JISCodeNagano    = 20
	JISCodeGifu      = 21
	JISCodeShizuoka  = 22
	JISCodeAichi     = 23
	JISCodeMie       = 24
	JISCodeShiga     = 25
	JISCodeKyoto     = 26
	JISCodeOsaka     = 27
	JISCodeHyogo     = 28
	JISCodeNara      = 29
	JISCodeWakayama  = 30
	JISCodeTottori   = 31
	JISCodeShimane   = 32
	JISCodeOkayama   = 33
	JISCodeHiroshima = 34
	JISCodeYamaguchi = 35
	JISCodeTokushima = 36
	JISCodeKagawa    = 37
	JISCodeEhime     = 38
	JISCodeKochi     = 39
	JISCodeFukuoka   = 40
	JISCodeSaga      = 41
	JISCodeNagasaki  = 42
	JISCodeKumamoto  = 43
	JISCodeOita      = 44
	JISCodeMiyazaki  = 45
	JISCodeKagoshima = 46
	JISCodeOkinawa   = 47
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Prefecture

type Prefecture interface {
	Code() int
	Kanji() string
	KanjiShort() string
	Kana() string
	KanaShort() string
	Roma() string
	RomaShort() string
}

Prefecture は外部に公開するための都道府県インターフェースです。

func FindByCode

func FindByCode(code int) (Prefecture, bool)

FindByCode は与えた都道府県コードに対応する都道府県情報を返します。 対応する都道府県情報が見つからない場合、`ok`に`false`が設定され、都道府県情報は`nil`で返されます。

func FindByKana

func FindByKana(kana string) (Prefecture, bool)

FindByKana は与えた都道府県のかな名に対応する都道府県情報を返します。 与える値の末尾にある「と」、「ふ」、「けん」は省略可能です。 対応する都道府県情報が見つからない場合、`ok`に`false`が設定され、都道府県情報は`nil`で返されます。

func FindByKanji

func FindByKanji(kanji string) (Prefecture, bool)

FindByKanji は与えた都道府県の漢字名に対応する都道府県情報を返します。 与える値の末尾にある「都」、「府」、「県」は省略可能です。 対応する都道府県情報が見つからない場合、`ok`に`false`が設定され、都道府県情報は`nil`で返されます。

func FindByRoma

func FindByRoma(roma string) (Prefecture, bool)

FindByRoma は与えた都道府県のローマ字名に対応する都道府県情報を返します。 与える値の末尾にある「-to」、「-fu」、「-ken」は省略可能です。 与える値はUpperCamelCase、LowerCamelCaseを問いません。 対応する都道府県情報が見つからない場合、`ok`に`false`が設定され、都道府県情報は`nil`で返されます。

func List

func List() []Prefecture

List は全ての都道府県情報を返します。

type Region added in v1.2.0

type Region interface {
	Kanji() string
	Kana() string
	Roma() string
	List() []Prefecture
}

Region は外部に公開するための地域インターフェースです。

func RegionList added in v1.2.0

func RegionList() []Region

RegionList は地域のリストを返します。

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL