The highest tagged major version is
Documentation
¶
Index ¶
- Constants
- func NewCacheResolver(ctx context.Context, uri string) (findingaid.Resolver, error)
- func NewHTTPResolver(ctx context.Context, uri string) (findingaid.Resolver, error)
- func NewIndexer(ctx context.Context, uri string) (findingaid.Indexer, error)
- type CacheResolver
- type FindingAidResponse
- type HTTPResolver
- type Indexer
Constants ¶
const FINDINGAID_URI_TEMPLATE string = "https://data.whosonfirst.org/findingaid/{id}"
const WOF_ID_PROPERTY string = "wof:id"
const WOF_REPO_PROPERTY string = "wof:repo"
Variables ¶
This section is empty.
Functions ¶
func NewCacheResolver ¶ added in v0.0.7
NewCacheResolver returns a findingaid.Resolver instance for exposing information about Who's On First repositories
func NewHTTPResolver ¶ added in v0.0.3
NewRepoResolver returns a findingaid.Resolver instance for exposing information about Who's On First repositories by retrieving information from an HTTP endpoint that returns JSON-encoded FindingAidResponse responses.
Types ¶
type CacheResolver ¶ added in v0.0.7
type CacheResolver struct {
findingaid.Resolver
// contains filtered or unexported fields
}
CacheResolver is a struct that implements the findingaid.Resolver interface for information about Who's On First repositories.
func (*CacheResolver) ResolveURI ¶ added in v0.0.7
func (fa *CacheResolver) ResolveURI(ctx context.Context, str_uri string) (interface{}, error)
ResolveURI will return 'repo.FindingAidResponse' for 'str_response' if it present in the finding aid.
type FindingAidResponse ¶
type FindingAidResponse struct {
// The unique Who's On First ID.
ID int64 `json:"id"`
// The name of the Who's On First repository.
Repo string `json:"repo"`
// The relative path for a Who's On First ID.
URI string `json:"uri"`
}
FindingAidResonse is a struct that contains Who's On First repository information for Who's On First records.
func FindingAidResponseFromBytes ¶ added in v0.0.8
func FindingAidResponseFromBytes(ctx context.Context, body []byte) (*FindingAidResponse, error)
type HTTPResolver ¶ added in v0.0.3
type HTTPResolver struct {
findingaid.Resolver
// contains filtered or unexported fields
}
RepoResolver is a struct that implements the findingaid.Resolver interface for information about Who's On First repositories by retrieving information from an HTTP endpoint that returns JSON-encoded FindingAidResponse responses. For example, a remote server running the `application/lookupd` tool.
func (*HTTPResolver) ResolveURI ¶ added in v0.0.3
func (fa *HTTPResolver) ResolveURI(ctx context.Context, str_uri string) (interface{}, error)
ResolveURI will return 'repo.FindingAidResponse' for 'str_response' if it present in the finding aid.
type Indexer ¶
type Indexer struct {
findingaid.Indexer
// contains filtered or unexported fields
}
Indexer is a struct that implements the findingaid.Indexer interface for information about Who's On First repositories.
func (*Indexer) IndexReader ¶
IndexReader will index an individual Who's On First record in the finding aid.
Source Files