index fields - AtlasOfLivingAustralia/biocache-service GitHub Wiki

index/fields provides SOLR field type information and mappings between SOLR fields, Cassandra columns, readable names, descriptions, Darwin Core terms and JSON keys returned by some services.

Output

name

• SOLR field names.
• Defined by https://github.com/AtlasOfLivingAustralia/biocache-store/blob/master/src/main/scala/au/org/ala/biocache/index/IndexDAO.scala

downloadName

• Cassandra field name.
• Mapped using column sourceField and SOLR field name in column field by https://github.com/AtlasOfLivingAustralia/biocache-store/blob/master/src/main/resources/indexFields.txt. Only mappings that have one Cassandra field are included. Mappings for concatenated fields are omitted, e.g. names_and_lsid.

description

• Readable SOLR field name.
• Defined by default https://github.com/AtlasOfLivingAustralia/biocache-service/blob/master/src/main/webapp/WEB-INF/messages.properties on ws facets/i18n.
• SOLR field name descriptions have the prefix facet. e.g. facet.rank=Identified to rank.
• Layer el* and cl* descriptions are retrieved from layers-service ws/fields ‘name’ values.
• Cassandra field name descriptions appear without a prefix. If a match using the name is unsuccessful, a match using downloadName is attempted.

info

• More verbose description of the SOLR field name.
• Defined by default https://github.com/AtlasOfLivingAustralia/biocache-service/blob/master/src/main/webapp/WEB-INF/messages.properties on ws facets/i18n with the prefix description. e.g. description.kingdom.p=The kingdom the ALA has matched this record to in the NSL.
• If a match using the name is unsuccessful, a match using downloadName is attempted.

dwcTerm

• Darwin core term for the SOLR field name.
• Defined by default https://github.com/AtlasOfLivingAustralia/biocache-service/blob/master/src/main/webapp/WEB-INF/messages.properties on ws facets/i18n with the prefix of dwc. for SOLR field names. e.g. dwc.classs.p=class.
• If a match using the name is unsuccessful, a match using downloadName is attempted.

jsonName

• JSON keys for SOLR field names found in occurrences returned by occurrences/search.
• Defined by https://github.com/AtlasOfLivingAustralia/biocache-service/blob/master/src/main/java/au/org/ala/biocache/dto/OccurrenceIndex.java

i18nValues

• This is true when the values in this SOLR field can be converted to a more readable form by a lookup using default https://github.com/AtlasOfLivingAustralia/biocache-service/blob/master/src/main/webapp/WEB-INF/messages.properties on ws facets/i18n with the prefix name.. e.g. month.1=January.
• When true it also appears in the i18n as i18nvalues.month=true

stored

• If this SOLR field is stored in the schema.

indexed

• If this SOLR field is indexed in the schema.

dataType

• The data type of this SOLR field in the schema.