public class TdbHighlightRendition extends TdbRendition
For HTML and multipart MIME renditions, either TRIPcof, TRIPview-C or TRIPview 2.1-4 or later must be installed on the TRIP server machine.
For TRIPxml output with hit markup, TRIPxml 2.2-2 or later must be installed on the TRIP server machine.
Constructor and Description |
---|
TdbHighlightRendition(java.lang.String stringFieldName,
java.lang.String textFieldName,
java.lang.String filenameFieldName,
TdbRenditionType type)
Constructor, create a fully specified template field.
|
TdbHighlightRendition(java.lang.String stringFieldName,
java.lang.String textFieldName,
TdbRenditionType type)
Constructor, create a fully specified template field.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getTextFieldName()
The text field from which to get hit locations for highlighting.
|
getFilenameFieldName, getRenditionType
clear, getAfterHits, getBaseName, getBeforeHits, getFetchType, getFieldContent, getFieldFetchOption, getName, getSizeHint, isFocused, isSummarized, setAfterHits, setBaseName, setBeforeHits, setFetchType, setFieldContent, setFieldFetchOption, setFocused, setName, setSizeHint, setSummarized, setSurroundHits
public TdbHighlightRendition(java.lang.String stringFieldName, java.lang.String textFieldName, TdbRenditionType type) throws TdbException
This version of the constructor is recommended for use with TRIPxml.
For HTML renditions using TRIPview, TRIPview-C or TRIPcof, you are strongly recommended to use the alternative constructor TdbHighlightRendition(String,String,String,TdbRenditionType) instead.
stringFieldName
- The string field containing the document to render.textFieldName
- The text field from which to get hit locations.type
- The type of rendition to be performed during retrieval.TdbException
- If there is an invalid argument.public TdbHighlightRendition(java.lang.String stringFieldName, java.lang.String textFieldName, java.lang.String filenameFieldName, TdbRenditionType type) throws TdbException
This version of the constructor is recommended for use with TRIPcof and TRIPview.
For use with TRIPxml, you should use the alternative constructor TdbHighlightRendition(String,String,TdbRenditionType) instead.
stringFieldName
- The string field containing the document to render into HTML.textFieldName
- The text field from which to get hit locations.filenameFieldName
- The phrase field that contains the name of the stored file.type
- The type of rendition to be performed during retrieval; must be either BasicHTML or MimeEncodedHtml.TdbException
- If there is an invalid argument.