Common Solr Fields For All Knowledge Maps

THL Toolbox > Developers' Zone > Ruby on Rails Development > Common Solr Fields for All Knowledge Maps

Common Solr Fields for Knowledge Maps for Subjects, Places and Terms

Contributor(s): Andres Montano

Here you will find what is common to all knowledge maps. Remember to see documentation for subdocuments and fields specific to each dictionary:

Main Document

tree: [places|subjects|terms]
block_type: 'parent'
id: {uid of current}. The uid is in the structure of places-{id}, subjects-{id}, terms-{id}
uid_i: {id*100 + app code}. Places is 1, Subjects 2 and Terms 3. For example, if uid is places-433, uid_i is 43301.
header: prioritized name based on default view. id would be used if no name is available.
position_i: position used for sorting in relation to other siblings.
projects_ss: array of collection codes. Collections are per app basis. For the list of collections see:

time_units_ss: array of time units formatted as a string. Tag would be avaiable if array is not empty.
caption_{language code}: array of the content of all captions for that language. Languages are per app basis. For a list of languages see:

caption_{language code}_{caption id}_content_t: content for each caption
caption_{language code}_{caption id}_citation_{citation fields}: prefix of citation data for caption. See citation section for all fields.
homepage_text_{language id in mandala}_s: text id of essays application.
summary_{language code}: array of the content of all summaries for that language.
summary_{language code}_{summary id}_content_t: content for each summary
summary_{language code}_{summary id}_citation_{citation fields}: prefix of citation data for summary. See citation section for all fields.
illustration_[external|mms]_url: url of illustration
created_at: from timestamp of db record (when record was created; not when solr document was created).
updated_at: from timestamp of db record (when record was updated; not when solr document was update).
ancestor_id_{perspective code}_path: for each perspective exact path or closest to it in the form of "{id of grandparent}/{id of parent}/{id of current}" (for however many levels there are). Perspectives are per app basis. For a list of perspectives see:
or fetch through the API:

ancestor_id_closest_{perspective code}_path: available only if there is no direct path. This is the closest path that should be used for breadcrumbs for each perspective. It in the form of "{id of grandparent}/{id of parent}/{id of current}" (for however many levels there are)
level_closest_{perspective code}_i: number of levels of closest
ancestors_{perspective code}: name of ancestors for perspective. Available only if direct path was found.
ancestors_closest_{perspective code}: name of closest ancestors for perspective. Available only if direct path was not found.
ancestor_ids_{perspective code}: ids of ancestors for perspective. Available only if direct path was found.
ancestor_ids_closest_{perspective code}: ids of closest ancestors for perspective. Available only if direct path was not found.
ancestor_uids_{perspective code}: uids of ancestors for perspective. Available only if direct path was found.
ancestor_uids_closest_{perspective code}: uids of closest ancestors for perspective. Available only if direct path was not found.
name_{view code}: priorized name for view. Views are per app basis. For a list of views see:
or fetch through the API:

name_{writing system code}: array of names for writing system. Writing systems are per app basis. For a list of writing systems see:

code_{code type}_value_s: code value. Code types are per app basis and are supported in all apps, but only actually used in Places Dictionary. For a list of codes see http://places.kmaps.virginia.edu/admin/geo_code_types
code_{code type}_citation_{citation fields}: prefix of citation data for code value. See citation section for all fields.
code_{code type}_time_units_ss: array of time units for code value formatted as a string. Tag would be avaiable if array is not empty.
code_{code type}_note_{note id}_{note fields}: prefix of note data for code value. See note section for all fields

Subdocuments

Names

id: {uid of current}_names-{name id}
origin_uid_s: {uid of current}
block_child_type: ['related_names']
related_names_id_s: {uid of current}_names-{name id} (same as id)
related_names_header_s: name
related_names_path_s: path in the form of "{name id of grandparent}/{name id of parent}/{name id of current}" (for however many levels there are). This can be used to build tree for names.
related_names_level_i: size of path
related_names_language_s: language for name
related_names_relationship_s: string representing relationship of name to parent (what kind of phonetic, orthographic or alt spelling relationship).
block_type: ['child']
related_names_citation_{citation fields}: prefix of citation data for name. See citation section for all fields.
related_names_time_units_ss: array of time units for name formatted as a string. Tag would be avaiable if array is not empty.
related_names_note_{note id}_{note fields}: prefix of note data for name. See note section for all fields
related_names_relationship_{relationship id}_citation_{citation fields}: prefix of citation data for parent name relation. See citation section for all fields.
related_names_relationship_note_{note id}_{note fields}: prefix of note data for name relation. See note section for all fields
related_names_etymology_s: etymology of name if available, else tag won't be included.
related_names_writing_system_s: name of writing system.
related_names_writing_system_code_s: code of writing system.

Specific Sections

Note fields

{prefix}_note_{note id}_title_s: title note if available, else tag won't be included.
{prefix}_note_{note id}_authors_ss: array of author names. Tag would be avaiable if array is not empty.
{prefix}_note_{note id}_content_t: content of note

Citation fields

{prefix}_citation_references_ss: array of citations for caption formatted as a string. Tag would be avaiable if array is not empty.
{prefix}_citation_{citation id}_note_t: content of note for specific citation if available, else tag won't be included.
{prefix}_citation_{citation id}_reference_s: if there is a citation note this is the respective citation, else tag won't be included.