crossref

package
v0.1.55 Latest Latest
Warning

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

 Go to latest Published: Nov 13, 2015 License: GPL-3.0 Imports: 17 Imported by: 0

Documentation

Overview 

Copyright 2015 by Leipzig University Library, http://ub.uni-leipzig.de
               by The Finc Authors, http://finc.info
               by Martin Czygan, <martin.czygan@uni-leipzig.de>

This file is part of some open source application.

Some open source application is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Some open source application is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Foobar. If not, see <http://www.gnu.org/licenses/>.

@license GPL-3.0+ <http://spdx.org/licenses/GPL-3.0+> 

Copyright 2015 by Leipzig University Library, http://ub.uni-leipzig.de
               by The Finc Authors, http://finc.info
               by Martin Czygan, <martin.czygan@uni-leipzig.de>

This file is part of some open source application.

Some open source application is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Some open source application is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Foobar. If not, see <http://www.gnu.org/licenses/>.

@license GPL-3.0+ <http://spdx.org/licenses/GPL-3.0+>

Package crossref implements crossref related structs and transformations.

API endpoint/documentation: http://api.crossref.org

The two main functions are ToSchema and ToSolrSchema, that convert a crossref document into an intermediate schema or a SOLR schema (finc). 

Copyright 2015 by Leipzig University Library, http://ub.uni-leipzig.de
               by The Finc Authors, http://finc.info
               by Martin Czygan, <martin.czygan@uni-leipzig.de>

This file is part of some open source application.

Some open source application is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Some open source application is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Foobar. If not, see <http://www.gnu.org/licenses/>.

@license GPL-3.0+ <http://spdx.org/licenses/GPL-3.0+>

Index

Constants

View Source 
const (
	// Internal bookkeeping.
	SourceID = "49"
)

Variables

View Source 
var (
	DefaultFormat = "ElectronicArticle"

	// Load assets
	Formats  = assetutil.MustLoadStringMap("assets/crossref/formats.json")
	Genres   = assetutil.MustLoadStringMap("assets/crossref/genres.json")
	RefTypes = assetutil.MustLoadStringMap("assets/crossref/reftypes.json")

	// AuthorReplacer is a special cleaner for author names.
	AuthorReplacer = strings.NewReplacer("#", "", "--", "", "*", "", "|", "", "&NA;", "", "\u0026NA;", "", "\u0026", "")

	// ArticleTitleBlocker will trigger skips, if article title matches exactly.
	ArticleTitleBlocker = []string{"Titelei", "Front Matter", "Advertisement", "Advertisement:"}

	// Future, if a publication date lies beyond it, it gets skipped.
	Future = time.Now().Add(time.Hour * 24 * 365 * 5)
)

Functions

func LookupMemberName 

func LookupMemberName(id int) (name string, err error)

LookupMemberName returns the primary name for a member given by its ID. Example URL: http://api.crossref.org/members/56

func PopulateMemberNameCache 

func PopulateMemberNameCache(filename string) error

PopulateMemberNameCache takes an LDJ filename with one member document per line and populates the cache.

Types

type Author 

type Author struct {
	Family string `json:"family"`
	Given  string `json:"given"`
}

Author is given by family and given name.

func (*Author) FamilyCleaned 

func (author *Author) FamilyCleaned() string

FamilyCleaned returns a mostly clean family name.

func (*Author) GivenCleaned 

func (author *Author) GivenCleaned() string

GivenCleaned returns a mostly clean family name.

func (*Author) String 

func (author *Author) String() string

String pretty prints the author.

type Crossref 

type Crossref struct{}

Crossref source.

func (Crossref) Iterate 

func (c Crossref) Iterate(r io.Reader) (<-chan []span.Importer, error)

type DateField 

type DateField struct {
	DateParts []DatePart `json:"date-parts"`
	Timestamp int64      `json:"timestamp"`
}

DateField contains two representations of one value.

func (*DateField) Date 

func (d *DateField) Date() (t time.Time, err error)

Date returns a time.Date in a best effort manner. Date parts seem to be always present in the source document, while timestamp is only present if dateparts consist of all three: year, month and day. It is an error, if no valid date can be extracted.

type DatePart 

type DatePart []int

DatePart consists of up to three int, representing year, month, day.

type Document 

type Document struct {
	Authors        []Author  `json:"author"`
	ContainerTitle []string  `json:"container-title"`
	Deposited      DateField `json:"deposited"`
	DOI            string    `json:"DOI"`
	Indexed        DateField `json:"indexed"`
	ISSN           []string  `json:"ISSN"`
	Issue          string    `json:"issue"`
	Issued         DateField `json:"issued"`
	Member         string    `json:"member"`
	Page           string    `json:"page"`
	Prefix         string    `json:"prefix"`
	Publisher      string    `json:"publisher"`
	ReferenceCount int       `json:"reference-count"`
	Score          float64   `json:"score"`
	Source         string    `json:"source"`
	Subjects       []string  `json:"subject"`
	Subtitle       []string  `json:"subtitle"`
	Title          []string  `json:"title"`
	Type           string    `json:"type"`
	URL            string    `json:"URL"`
	Volume         string    `json:"volume"`
}

Document is a example 'works' API response.

func (*Document) CombinedTitle 

func (doc *Document) CombinedTitle() string

CombinedTitle returns a longish title.

func (*Document) FullTitle 

func (doc *Document) FullTitle() string

FullTitle returns everything title.

func (*Document) MemberName 

func (doc *Document) MemberName() (name string, err error)

MemberName resolves the primary name of the member.

func (*Document) PageInfo 

func (doc *Document) PageInfo() PageInfo

PageInfo parses a page specfication in a best effort manner into a PageInfo struct.

func (*Document) RecordID 

func (doc *Document) RecordID() string

RecordID is of the form <kind>-<source-id>-<id-base64-unpadded> We simple map any primary key of the source (preferably a URL) to a safer alphabet. Since the base64 part is not meant to be decoded we drop the padding. It is simple enough to recover the original value.

func (*Document) ShortTitle 

func (doc *Document) ShortTitle() (s string)

ShortTitle returns the first main title only.

func (*Document) ToIntermediateSchema 

func (doc *Document) ToIntermediateSchema() (*finc.IntermediateSchema, error)

ToIntermediateSchema converts a crossref document into IS.

type IntStringCache 

type IntStringCache struct {
	Entries map[int]string
	// contains filtered or unexported fields
}

IntStringCache for int keys and string values with a thread-safe setter. TODO(miku): move to something more generic

func NewIntStringCache 

func NewIntStringCache() IntStringCache

NewIntStringCache creates a new in memory members cache.

func (*IntStringCache) Set 

func (c *IntStringCache) Set(k int, v string)

Set sets the string value for an int key, threadsafe.

type Member 

type Member struct {
	ID          int      `json:"id"`
	PrimaryName string   `json:"primary-name"`
	Names       []string `json:"names"`
	Location    string   `json:"location"`
	Prefixes    []string `json:"prefixes"`
	Tokens      []string `json:"tokens"`
}

Member covers a member type message.

func FetchMember 

func FetchMember(id int) (Member, error)

FetchMember makes an API request for a member given by its ID.

type Message 

type Message struct {
	Status  string          `json:"status"`
	Version string          `json:"message-version"`
	Message json.RawMessage `json:"message"`
	Type    string          `json:"message-type"`
}

Message covers a generic API response.

type PageInfo 

type PageInfo struct {
	RawMessage string
	StartPage  int
	EndPage    int
}

PageInfo holds various page related data.

func (*PageInfo) PageCount 

func (pi *PageInfo) PageCount() int

PageCount returns the number of pages, or zero if this cannot be determined.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.