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
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int containsDoc​(java.lang.String field)
      Contains document of specified field?
      int containsImage​(java.lang.String field)
      Contains image of specified field?
      boolean containsThumb​(java.lang.String field)
      Contains image thumbnail of specified field?
      java.lang.String[] getDocFields()
      Document/Images limited fields
      int getDocs()
      Inline documents fields?
      int getImages()
      Inline image fields?
      boolean getObjects()
      Inline object fields?
      java.lang.String[] getThumbFields()
      Thumbnails limited fields
      boolean getThumbs()
      Inline thumbnails of image fields?
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • 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?
      • 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
      • 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