Class TdbRendition

  • Direct Known Subclasses:
    TdbHighlightRendition

    public class TdbRendition
    extends TdbFieldTemplate
    Extends TdbFieldTemplate to provide rendition requests specific to STring fields. Currently supported rendition types can be found in the TdbRenditionType enum.
    • Constructor Detail

      • TdbRendition

        public TdbRendition​(java.lang.String name,
                            TdbRenditionType type)
        Constructor for a string template field with optional conversion
        Parameters:
        name - Name of field to be retrieved
        type - The type of rendition to be performed during retrieval
      • TdbRendition

        public TdbRendition​(java.lang.String stringFieldName,
                            java.lang.String filenameFieldName,
                            TdbRenditionType type)
        Constructor for a string template field with optional conversion.

        This constructor is strongly recommended for server-side HTML conversion using TRIPcof or TRIPview-C. If the file name is unknown, the rendition may not be successful.

        Parameters:
        stringFieldName - Name of the string field to be retrieved
        filenameFieldName - Name of a phrase field that contains the name of the file stored in the string field
        type - The type of the rendition to produce
    • Method Detail

      • getRenditionType

        public java.lang.String getRenditionType()
        Retrieve the type (protocol string) that reflects the rendition request
      • getFilenameFieldName

        public java.lang.String getFilenameFieldName()
        Retrieve the name of the phrase field containing the name of the file stored in the string field to which this field template applies.