Package com.simplicite.util

Class Bookshelf

  • All Implemented Interfaces:
    java.io.Serializable
    public class Bookshelf
extends java.lang.Object
implements java.io.Serializable
    Bookshelf definition containing documents
    Indexes are stored with LUCENE thru TIKA components to parse their contents
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      Bookshelf​(java.lang.String id, java.lang.String name, java.util.Map<java.lang.String,​java.lang.String> display, boolean granted, java.lang.String objName)
      Constructor

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addField​(Grant g, java.lang.String name)
      Add field
      void addPermittedMimeType​(java.lang.String mime, java.lang.String ext)
      Add a permitted MIME type
      java.lang.String getDisplay​(java.lang.String lang)
      Get display label
      java.util.List<ObjectField> getFields​(Grant g)
      Get all fields
      static char[] getGrants()
      Get grants
      java.lang.String getId()
      Get ID
      java.lang.String getLabel​(java.lang.String lang)
      Get display label (same as getDisplay)
      int getMax()
      Get maximum documents
      int getMin()
      Get minimum documents
      java.lang.String getName()
      Get name
      static java.lang.String getName​(java.lang.String id)
      Get name from id
      java.lang.String getObjectName()
      Get object name
      java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getPermittedMimeTypes()
      Get all permitted MIME types in the bookshelf
      java.lang.String getPermittedMimeTypes​(Grant g)
      List of accdepted documents in user's language
      boolean isGranted()
      Is granted?
      boolean isPermittedMimeType​(java.lang.String mime)
      Is a MIME type permitted in the bookshelf?
      boolean isStandalone()
      Is standalone?
      java.lang.String jsonPermittedMimeTypes()
      Get all permitted MIME types in the bookshelf
      void setMax​(int max)
      Set maximum documents field
      void setMin​(int min)
      Set mininmum documents field

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Bookshelf

        public Bookshelf​(java.lang.String id,
                 java.lang.String name,
                 java.util.Map<java.lang.String,​java.lang.String> display,
                 boolean granted,
                 java.lang.String objName)
        Constructor
        Parameters:
        id - Id
        name - Name
        display - display
        granted - is granted ?
        objName - Object Name

    • Method Detail

      • getId

        public java.lang.String getId()
        Get ID
        Returns:
        ID

      • getName

        public java.lang.String getName()
        Get name
        Returns:
        Name

      • getName

        public static java.lang.String getName​(java.lang.String id)
        Get name from id
        Parameters:
        id - Bookshelf row Id
        Returns:
        Name if exists

      • getGrants

        public static char[] getGrants()
        Get grants
        Returns:
        Grant array

      • addField

        public void addField​(Grant g,
                     java.lang.String name)
        Add field
        Parameters:
        g - Grant
        name - Field name

      • getFields

        public java.util.List<ObjectField> getFields​(Grant g)
        Get all fields
        Parameters:
        g - Grant
        Returns:
        List of fields

      • addPermittedMimeType

        public void addPermittedMimeType​(java.lang.String mime,
                                 java.lang.String ext)
        Add a permitted MIME type
        Parameters:
        mime - Mime type
        ext - File extension

      • getPermittedMimeTypes

        public java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getPermittedMimeTypes()
        Get all permitted MIME types in the bookshelf

      • jsonPermittedMimeTypes

        public java.lang.String jsonPermittedMimeTypes()
        Get all permitted MIME types in the bookshelf
        Returns:
        JSON array of mime type and file extensions, null if all types are permitted

      • isPermittedMimeType

        public boolean isPermittedMimeType​(java.lang.String mime)
        Is a MIME type permitted in the bookshelf?

      • getPermittedMimeTypes

        public java.lang.String getPermittedMimeTypes​(Grant g)
        List of accdepted documents in user's language
        Returns:
        Text for UI

      • setMin

        public void setMin​(int min)
        Set mininmum documents field
        Parameters:
        min - Mininum (default 0 = optional)

      • setMax

        public void setMax​(int max)
        Set maximum documents field
        Parameters:
        max - Maximum (default 0 = no limit)

      • getMin

        public int getMin()
        Get minimum documents
        Returns:
        Minimum documents permmited for multi-documents field (0 = optional)

      • getMax

        public int getMax()
        Get maximum documents
        Returns:
        Maximum documents permmited for multi-documents field (0 = not limited)

      • getObjectName

        public java.lang.String getObjectName()
        Get object name
        Returns:
        Object name

      • getDisplay

        public java.lang.String getDisplay​(java.lang.String lang)
        Get display label
        Parameters:
        lang - Language
        Returns:
        Display label

      • getLabel

        public java.lang.String getLabel​(java.lang.String lang)
        Get display label (same as getDisplay)
        Parameters:
        lang - Language
        Returns:
        Display label

      • isGranted

        public boolean isGranted()
        Is granted?
        Returns:
        True if granted

      • isStandalone

        public boolean isStandalone()
        Is standalone?
        Returns:
        True if standalone