Metacat

.. raw:: latex

  \newpage

===========================

Lorem ipsum

SOLR background information

---------------------------

Features:

* something

* something

* more

* even more

Something to explain the advantage of solr over the old metacat index approach

Indexed documents and fields

-----------------------------

Metacat reuses the default DataONE index which includes many common metadata formats

out-of-the-box

1. EML

2. FGDC

3. Dryad

Default indexed fields

-----------------------

Describe the existing fields like in the DataONE docs, with link to them

Index configuration overview

----------------------------

Describe the configuration files and extension points for the implementation

Adding additional document types and fields

--------------------------------------------

Step-by-step guide for adding new documents and indexed fields.

Querying the index

--------------------

Provide example SOLR queries and expected results. Show a variety of return types

and query facets.

Access Policy enforcement

-------------------------

Explain how access control is processed and honored when utilizing the index.

Regenerating the index from scratch

-----------------------------------

When the SOLR index has been drastically modified, a complete regenration of the

index may be necessary. In order to accomplish this:

Step-by-step instructions

NOTE: this may take a long time depending on the size of your Metacat store.

Class design overview

----------------------

.. figure:: images/indexing-class-diagram.png

   Figure 1. Class design overview.

..

  @startuml images/indexing-class-diagram.png

		interface IDocumentSubprocessor {

			+ boolean canProcess(Document doc)

			+ initExpression(XPath xpath)

			+ Map<String, SolrDoc> processDocument(String identifier, Map<String, SolrDoc> docs, Document doc)

			- List<SolrField> fields

		}

		class ScienceMetadataDocumentSubprocessor {

		}

		interface ISolrField {

			+ initExpression(XPath xpathObject)

			+ List<SolrElementField> getFields(Document doc, String identifier)

		}

		class SolrField {

			- String name

		}

		class MergeSolrField {

		}

		class ResolveSolrField {

		}

		class SolrFieldResourceMap {

		}

	}

	AbstractDocumentSubprocessor <|-- ResourceMapSubprocessor

	AbstractDocumentSubprocessor <|-- ScienceMetadataDocumentSubprocessor

	ISolrField <|-- SolrField

	SolrField <|-- CommonRootSolrField

	SolrField <|-- FullTextSolrField

	SolrField <|-- MergeSolrField

	SolrField <|-- ResolveSolrField

	SolrField <|-- SolrFieldResourceMap

			- List<SolrField> sysmetaFields

			- SolorFiledParser solrFieldParser

			- EmbeddedSolrServer solrServer

			+ insert(String pid, InputStream data)

			+ update(String pid, InputStream data)

			+ OutputStream query(String solrQuery)

		     - List<SolrField> solrFields

		     + SolrFieldParser(InputStream config)

		     + List<SolrField> getSolrFields()

	}

	package solr {

		abstract class SolrServer {

			+ add(SolrInputDocument doc)

			+ deleteByQuery(String id)

			+ query(SolrQuery query)

	}

	SolrServer <|-- HttpSolrServer

  @enduml