Package com.day.cq.reporting.helpers

Enum ColumnType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ColumnType>
    public enum ColumnType
extends java.lang.Enum<ColumnType>
    This enumeration defines the column types supported by the clientside implementation.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DATE
      Value is a date (= Calendar)
      DIFF
      Value is a diff of two values
      INT
      Value is an integer number
      NUMBER
      Value is a number
      SORTABLE
      Value is labeled with a different property
      STRING
      Value is a String
      TIMESLOT
      Value is the timeslot of a date property

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static ColumnType fromTransferString​(java.lang.String transferStr)
      Gets a suitable ColumnType for the specified transfer representation.
      DisplayDataType getDisplayType()
      Gets the display type for the column type.
      java.lang.String getTransferStr()
      Gets the string representation used for data transfer.
      static ColumnType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ColumnType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • STRING

        public static final ColumnType STRING
        Value is a String

      • NUMBER

        public static final ColumnType NUMBER
        Value is a number

      • INT

        public static final ColumnType INT
        Value is an integer number

      • DATE

        public static final ColumnType DATE
        Value is a date (= Calendar)

      • DIFF

        public static final ColumnType DIFF
        Value is a diff of two values

      • TIMESLOT

        public static final ColumnType TIMESLOT
        Value is the timeslot of a date property

      • SORTABLE

        public static final ColumnType SORTABLE
        Value is labeled with a different property

    • Method Detail

      • values

        public static ColumnType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (ColumnType c : ColumnType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ColumnType valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getTransferStr

        public java.lang.String getTransferStr()
        Gets the string representation used for data transfer.
        Returns:
        The string representation used for data transfer

      • getDisplayType

        public DisplayDataType getDisplayType()
        Gets the display type for the column type.
        Returns:
        The display type

      • fromTransferString

        public static ColumnType fromTransferString​(java.lang.String transferStr)
        Gets a suitable ColumnType for the specified transfer representation.
        Parameters:
        transferStr - The transfer string
        Returns:
        the matching ColumnType for the specified transfer representation