SearchResultDocument

Properties

String projectKey

The key of this document's containing Project.

String itemKey

This document's item Key, unique to the project. In some cases, may be of the form key:elementId for chunked content.

String path

The path to this document within its project.

String filename

This document's filename.

String urlPath

The URL path for this file.

String title

This document's title, or its filename if the title does not exist.

String searchTitle

This document's search title, or its title if the searchTitle does not exist.

String[] keywords

The keywords of the document.

String textContents

The raw text contents of the document.

String contextKey

The key of this document's context document, or xxnullxx if it is a stand-alone document.

String contextName

The name of this document's context document.

String contextRefId

If this document is present in its parent context more than once, the contextRefId identifies which version the current document represents.

Long created

The date that this document was created in Titania Delivery.

Long lastModified

The date that this document was last modified in Titania Delivery.

boolean contextualized

true if this document is present in a parent context document. Equal to contextKey != xxnullxx .

String highlight

If this document was returned as part of a search query, this field will contain the text contents surrounding the most-relevant "hit" in the document.

Map metadata

A hash representing the metadata on this document. The keys are metadata names as assigned in the TD admin application or present in the source document. The value is an array of strings representing the values of that metadata. If a key is present it is guaranteed that there will be at least one element in the values array.

Map metadataNormalized

Similar to metadata , but with _md stripped from all the keys.

boolean virtual

Describes whether this search result represents a physical file in a Titania Delivery project, or a virtual, generated document. Examples of virtual documents include topics generated for DITA <topicref> elements that specify a title but no @href or @keyref, or a chunked section of a non-DITA document.