Class Parameters.InlineParam

  • All Implemented Interfaces:
    java.io.Serializable
    Enclosing class:
    Parameters

    public static class Parameters.InlineParam
    extends java.lang.Object
    implements java.io.Serializable
    Inlining parameters
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int INLINE_CONTENT
      Doc info + content (large)
      static int INLINE_ID
      Id only
      static int INLINE_INFO
      Doc info only (exclude content)
    • Constructor Summary

      Constructors 
      Constructor Description
      InlineParam()
      Default constructor
      InlineParam​(boolean docs, boolean thumbs, boolean objects)
      Constructor
      InlineParam​(int docs, boolean thumbs, boolean objects)
      Constructor
      InlineParam​(Parameters params)
      Constructor
    • Constructor Detail

      • InlineParam

        public InlineParam()
        Default constructor
      • InlineParam

        public InlineParam​(int docs,
                           boolean thumbs,
                           boolean objects)
        Constructor
        Parameters:
        docs - Document and Images?
        thumbs - Thumbnails?
        objects - Objects?
      • InlineParam

        public InlineParam​(boolean docs,
                           boolean thumbs,
                           boolean objects)
        Constructor
        Parameters:
        docs - Document and Images?
        thumbs - Thumbnails?
        objects - Objects?
      • InlineParam

        public InlineParam​(Parameters params)
        Constructor
        Parameters:
        params - Parameters
    • Method Detail

      • getObjects

        public boolean getObjects()
        Inline object fields?
      • withLocalIds

        public boolean withLocalIds()
        Inline row ids?
      • withLocalIds

        public void withLocalIds​(boolean b)
        Inline row ids
      • withLocalPath

        public boolean withLocalPath()
        Inline doc path?
      • withLocalPath

        public void withLocalPath​(boolean b)
        Inline doc id+path?
      • useBase64content

        public boolean useBase64content()
        Encode in base64 all text contents?
      • useBase64content

        public void useBase64content​(boolean b)
        Encode in base64 all text contents?
        Parameters:
        b - true to encode text in base64
      • getInlineDir

        public java.io.File getInlineDir()
        Root directory for mapped files
      • setInlineDir

        public void setInlineDir​(java.io.File dir)
        Root directory for mapped files
      • getDocs

        public int getDocs()
        Inline documents fields?
      • getImages

        public int getImages()
        Inline image fields?
      • getThumbs

        public boolean getThumbs()
        Inline thumbnails of image fields?
      • getDocFields

        public java.lang.String[] getDocFields()
        Document/Images limited fields
      • getThumbFields

        public java.lang.String[] getThumbFields()
        Thumbnails limited fields
      • withExportableOnly

        public boolean withExportableOnly()
        Only exportable fields?
      • setExportableOnly

        public void setExportableOnly​(boolean b)
        Only exportable fields?
      • containsDoc

        public int containsDoc​(java.lang.String field)
        Contains document of specified field?
        Parameters:
        field - Field name
        Returns:
        Inlining mode of document
      • containsImage

        public int containsImage​(java.lang.String field)
        Contains image of specified field?
        Parameters:
        field - Field name
        Returns:
        Inlining mode of image
      • containsThumb

        public boolean containsThumb​(java.lang.String field)
        Contains image thumbnail of specified field?
        Parameters:
        field - Field name
        Returns:
        Inlining mode of image thumbnail