ESciDoc Search Index Names

From MPDLMediaWiki
Jump to navigation Jump to search


This article describes the rules for creation of search indexes of the resource properties and metadata stored as the eSciDoc content resources.
Note: the specification at present covers indexing rules of item and container resources. The automatically generated index names rules may however be used also for other resources. Should be separately specified if needed.

The rules define top-level indexing contexts derived from the XML representation of the escidoc resource. The names of these contexts should be used as prefix for index names of indexed elements. The following top-level contexts are defined:

  • property
  • metadata (name of the context may change, depending on the metadata profile name)
    • Important: only metadata records labeled "escidoc" should be indexed, unless specified additionally
  • component
  • struct-map

Automatically generated indexes[edit]

This section describes the rules for indexes that should always be created based on respective rules of the top-level contexts.

NOTE: Due to core-service set-up all indexes have additional prefix "escidoc" and all sort-keys have additional prefix "sort"

Indexing of properties[edit]

  • All properties are indexed (represented as elements or attributes in escidoc-resource.xml)
  • Index names of regular properties are
  • Index names on content-model-specific-properties (cmsprop) are

    • Exception 1: even though property.objid is not explicitly stated in the property section of the resource XML, the index name should be
    • Exception 2: property indexes that include additionally referenced data
    • Example 1: standard property indexes
    • Example 2: content-model-specific-property indexes

Indexing of metadata[edit]

  • Top-level context for index names of metadata has prefix based on the top-level enclosing metadata element. At present, MPDL solutions have the following contexts (Note: these are not fixed, and may be extended with new top-level metadata indexing contexts, it depends on application profile in use):
    • publication
    • face-item
    • virr-toc
    • virr-element
    • FacesAlbum (Note: should be renamed to faces-album)
  • Index name should be


  • Index names should not use namespace alias (e.g. dc, dcterms, escidoc)
    • Examples publication: generated indexes of the full path of all metadata
         * publication.title
         * publication.alternativeTitle
         * publication.genre
         * publication.source.title
         * publication.source.genre
         * publication.event.title
         * publication.source.source.genre
         * publication.source.source.title
    • Examples face-item: generated indexes of the full path of all metadata
         * face-item.emotion
         * face-item.picture-group
         * face-item.identifier
         * face-item.age
         * face-item.age-group
         * face-item.gender

Indexing of components[edit]

  • The top-level indexing context name is "component".
  • Same rules as for Indexing of properties and indexing of metadata apply.
    • Example 1: index names of component properties
    • Example 2: index names of component metadata for "file metadata profile"

Indexing of components content[edit]

  • Components content storage must be indexed as well to enable distingushing searches by files and locators.

Compound components index[edit]

  • as there is a need to have searches that are specific exactly to a component in case when item has several components, new compound index is introduced.

This index is derived as a concatenation of the values of following component properties and order: visibility, storage-type, content-category, mime-type, valid-status, created-by, creation-date, checksum, PID, file-name.

This index is a bit cumbersome, but it allows for more exact search results.

Full text - content index[edit]

  • escidoc.fulltext

In case when the content of the component i.e. the fulltext can not be indexed, the indexing of the metadata continues, but the following is written in the indexfield


Indexing of content-relations[edit]

This index refers to the "simple" type of content relations - i.e. those which are defined directly on the item and are delivered with the item xml representation.


This index is derived as "<predicate> <target>"

  • search for predicate search escidoc.content-relation=<predicate> (instead of <predicate> real value shall be used)
  • search for target search escidoc.content-relation=<target> (instead of <predicate> real value shall be used)
  • search for combination, search escidoc.content-relation="<predicate> <target>" (phrase)

Indexing of struct-map[edit]

  • The top-level indexing context name is "struct-map".
  • The struct-map indexin context should support the following indexes:
        *struct-map.item.title (derived index)
        *struct-map.container.title (derived index)

Compound and derived indexes[edit]

This section defines the naming rules for compound and derived indexes that have different logic for creation then the one specified in Automatically generated indexes section.

  • Compound and derived indexes are dependent on the user requirements, metadata profile and are created explicitly
  • We need to make sure that we do have correct index names when implementing a new index
  • in future we can expect to register xslt transformations for derivation on content model and/or metadata profile level

Naming rules[edit]

To clarify better the naming rules the following general structure for the index name is given:


where the number of <name-part> elements depends on the metadata structure.

  • Rules for derived indexes within single top-level-indexing metadata context name
    • index names of indexes that are based on single metadata profile (e.g. publication, virr-element, face-item) MUST start with the actual name of the metadata indexing context (e.g. must have "publication" as value for <top-level-indexing-context-name>).
    • indexes that index more than one metadata element on same level in the metadata-xml stream MUST have in the index name the string "compound"
    • indexes that index more than one metadata element starting with specific level (e.g. level 1) and using metadata at any level below in the metadata-xml stream MUST have in the index name the string "any"
    • strings "compound" or "any" must always be used in front of the <end-index-name> (e.g. as <partN> in the structure given above)
    • strings "compound" or "any" can not be used in same index name

  • Example 1: Index of all titles of the publication on publication level (it indexes metadata publication.title, and publication.alternativeTitle)
  • Example 2: Index of all titles of the publication on publication level (it indexes metadata publication.title, publication.alternativeTitle, source.title, source.source.title, source.alternativeTitle, event.title, event.alternativeTitle)
  • Example 3: Index of all titles of the publication on source level (it indexes metadata source.title, source.alternativeTitle)
  • Example 4: Index of all titles of the publication on source level and any level below (it indexes metadata source.title, source.alternativeTitle, source.source.title, source.source.alternativeTitle)

Publication metadata context[edit]

Virr metadata context[edit]

Faces metadata context[edit]

  • No need for compound indexes at present

Future development[edit]

  • Rules for derived indexes cross several top-level-indexing metadata context name
    • index names of indexes that are based on several metadata profiles (e.g. combine publication and virr-element) MUST always use string "any" as <top-level-indexing-context-name> and can have only <end-index-name> in their structure additionally. (Note: as this is future development, there is high probability that this rule is not valid at present)
  • Examples:

Would be derived from any names of the creator from all metadata contexts, or specified metadata contexts.

Possible use cases: find all resources where Mr. X was creator of, find all resources with title A