Warning: This page has not been updated in over over a year and may be outdated or deprecated.
legacy:vufind_1.x_developer_manual:supporting_a_new_metadata_format
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
other_than_marc [2015/12/11 17:36] – [Introduction] demiankatz | legacy:vufind_1.x_developer_manual:supporting_a_new_metadata_format [2018/12/19 14:02] (current) – demiankatz | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Support for New Record Formats ====== | ====== Support for New Record Formats ====== | ||
- | //This page refers | + | // This outdated |
- | + | ||
- | //Note: This feature was introduced in VuFind 1.0. If you are using VuFind 1.0RC2 or earlier, please upgrade to gain access to this functionality.// | + | |
- | + | ||
- | ===== Introduction ===== | + | |
- | + | ||
- | VuFind is currently bundled with a standard indexer ([[: | + | |
- | * write an indexer to get the data into VuFind' | + | |
- | * write a " | + | |
- | + | ||
- | ===== Indexer ===== | + | |
- | Indexing is not an integrated part of VuFind. For indexing MARC records, [[http:// | + | |
- | + | ||
- | Writing a custom indexer for other record formats may be done in almost any programming language. Steps to be done: | + | |
- | * parse record format | + | |
- | * map format entities to Solr index fields (see solr/ | + | |
- | * create XMLish document out of these fields (see the [[http://wiki.apache.org/ | + | |
- | * POST document to Solr's update handler (FYI: it doesn' | + | |
- | + | ||
- | Note that for any metadata format available as XML, you can save yourself some steps by using the [[importing_records# | + | |
- | + | ||
- | ===== Record Display ===== | + | |
- | + | ||
- | Record display is handled by a family of " | + | |
- | + | ||
- | ==== Driver API Specification ==== | + | |
- | + | ||
- | The interface that must be implemented by all Record Driver classes can be viewed in the [[https:// | + | |
- | + | ||
- | Record Driver naming conventions: | + | |
- | + | ||
- | * Filename: web/ | + | |
- | * Class name: same as the filename -- [record type]Record (i.e. MarcRecord, IndexRecord, | + | |
- | + | ||
- | ==== Notes ==== | + | |
- | + | ||
- | * The public Record Driver interface is intentionally very abstract -- we want to be able to support records of all kinds, and we don't want to make any assumptions about the structure of the records. | + | |
- | * In spite of the generic interface, it is often useful to have very structured methods (getTitle, getAuthor, etc.). | + | |
- | * To summarize the previous two points: if your data format represents bibliographic data in a way roughly similar to MARC, you can probably extend the IndexRecord class and override a few methods to do what you need. If your data format is wildly different, you probably want to build a whole new class based on the generic interface, and you shouldn' | + | |
---- struct data ---- | ---- struct data ---- | ||
+ | properties.Page Owner : | ||
---- | ---- | ||
legacy/vufind_1.x_developer_manual/supporting_a_new_metadata_format.1449855370.txt.gz · Last modified: 2015/12/11 17:36 by demiankatz