Class ExplorerFields


  • public final class ExplorerFields
    extends java.lang.Object
    Constants and static methods to be used to retrieve everything related to fields that can be displayed in explorer.
    Since:
    explorer-1.0
    Version:
    $Revision$
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String AUTHOR
      Publication author
      static java.lang.String CADDY
      Caddy icon
      static java.lang.String CDATE
      Publication creation date
      static com.jalios.jcms.Channel channel  
      static java.lang.String COUNTER
      Counter
      protected static java.lang.String[] defaultFields  
      protected static java.util.LinkedList<java.lang.String> defaultFieldsList  
      static java.lang.String DOWNLOAD
      FileDocument download action
      static java.lang.String EDATE
      Publication expiration date
      static java.lang.String EDIT
      Edit icon
      protected static java.lang.String[] fields  
      static java.lang.String ID
      Publication ID
      static java.lang.String IDXDATE
      Publication indexed date
      static java.lang.String MAINLANGUAGE
      Publication main language
      static java.lang.String MDATE
      Publication modification date
      static java.lang.String OPAUTHOR
      Publication opAuthor
      static java.lang.String PDATE
      Publication publication date
      static java.lang.String READERS
      Publication number of readers
      static java.lang.String RECOMMEND
      Publication recommend action
      static java.lang.String SDATE
      Publication sort date
      static java.lang.String STATUS
      Publication status (pstatus, preview icon, import icon)
      static java.lang.String TITLE
      Publication title
      static java.lang.String TYPE
      Publication type
      static java.lang.String UDATE
      Publication major modification date
      static java.lang.String UPLOADDATE
      FileDocument upload date
      static java.lang.String VERSION
      Publication version
      static java.lang.String VOTESCORE
      Publication score (number of vote)
    • Constructor Summary

      Constructors 
      Constructor Description
      ExplorerFields()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String[] getAvailableFields()
      Retrieves the available fields to be proposed in explorer view.
      static java.lang.String[] getDefaultFields()
      Retrieves the default fields to be proposed in explorer view.
      static java.util.List<java.lang.String> getDefaultFieldsList()
      Retrieves the default fields to be proposed in explorer view as a List.
      static java.lang.String getFieldLabel​(java.lang.String lang, java.lang.String fieldName)
      Return the label to use for the specified field name, in the specified language.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • channel

        public static final com.jalios.jcms.Channel channel
      • STATUS

        public static final java.lang.String STATUS
        Publication status (pstatus, preview icon, import icon)
        See Also:
        Constant Field Values
      • MAINLANGUAGE

        public static final java.lang.String MAINLANGUAGE
        Publication main language
        See Also:
        Constant Field Values
      • OPAUTHOR

        public static final java.lang.String OPAUTHOR
        Publication opAuthor
        See Also:
        Constant Field Values
      • VERSION

        public static final java.lang.String VERSION
        Publication version
        See Also:
        Constant Field Values
      • CDATE

        public static final java.lang.String CDATE
        Publication creation date
        See Also:
        Constant Field Values
      • MDATE

        public static final java.lang.String MDATE
        Publication modification date
        See Also:
        Constant Field Values
      • UDATE

        public static final java.lang.String UDATE
        Publication major modification date
        See Also:
        Constant Field Values
      • PDATE

        public static final java.lang.String PDATE
        Publication publication date
        See Also:
        Constant Field Values
      • EDATE

        public static final java.lang.String EDATE
        Publication expiration date
        See Also:
        Constant Field Values
      • SDATE

        public static final java.lang.String SDATE
        Publication sort date
        See Also:
        Constant Field Values
      • IDXDATE

        public static final java.lang.String IDXDATE
        Publication indexed date
        See Also:
        Constant Field Values
      • UPLOADDATE

        public static final java.lang.String UPLOADDATE
        FileDocument upload date
        See Also:
        Constant Field Values
      • DOWNLOAD

        public static final java.lang.String DOWNLOAD
        FileDocument download action
        See Also:
        Constant Field Values
      • RECOMMEND

        public static final java.lang.String RECOMMEND
        Publication recommend action
        See Also:
        Constant Field Values
      • VOTESCORE

        public static final java.lang.String VOTESCORE
        Publication score (number of vote)
        See Also:
        Constant Field Values
      • READERS

        public static final java.lang.String READERS
        Publication number of readers
        See Also:
        Constant Field Values
      • fields

        protected static java.lang.String[] fields
      • defaultFields

        protected static java.lang.String[] defaultFields
      • defaultFieldsList

        protected static java.util.LinkedList<java.lang.String> defaultFieldsList
    • Constructor Detail

      • ExplorerFields

        public ExplorerFields()
    • Method Detail

      • getAvailableFields

        public static java.lang.String[] getAvailableFields()
        Retrieves the available fields to be proposed in explorer view.
        Returns:
        an array of field name, e.g. ["_cnt_", "title", "cdate"], never return null.
      • getDefaultFields

        public static java.lang.String[] getDefaultFields()
        Retrieves the default fields to be proposed in explorer view.
        Returns:
        an array of field name, e.g. ["_cnt_", "title", "cdate"], never return null.
      • getDefaultFieldsList

        public static java.util.List<java.lang.String> getDefaultFieldsList()
        Retrieves the default fields to be proposed in explorer view as a List.
        Returns:
        a List of field name, e.g. ["_cnt_", "title", "cdate"], never return null.
        See Also:
        getDefaultFields()
      • getFieldLabel

        public static java.lang.String getFieldLabel​(java.lang.String lang,
                                                     java.lang.String fieldName)
        Return the label to use for the specified field name, in the specified language.
        Parameters:
        lang - the language in which to retrieve the label
        fieldName - a field name value as returned by getAvailableFields(), e.g: "title".
        Returns:
        an I18N string.