Package com.day.cq.reporting

Interface CellValue

  • All Superinterfaces:
    java.lang.Comparable<CellValue>
    public interface CellValue
extends java.lang.Comparable<CellValue>
    Interface that defines a cell value.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      javax.jcr.Value getJCRValue​(javax.jcr.Session session)
      Gets a JCR compatible Value object for the represented cell value.
      java.lang.String getString()
      Returns a "guaranteed" string representation of the value.
      void toJSON​(JSONWriter writer, java.util.Locale locale)
      Adds the value to the specified JSONWriter.

      • Methods inherited from interface java.lang.Comparable

        compareTo

    • Method Detail

      • getJCRValue

        javax.jcr.Value getJCRValue​(javax.jcr.Session session)
                     throws javax.jcr.RepositoryException
        Gets a JCR compatible Value object for the represented cell value.
        Parameters:
        session - The repository session to create the value for
        Returns:
        The JCR Value object
        Throws:
        javax.jcr.RepositoryException - if no suitable Value object could be created

      • toJSON

        void toJSON​(JSONWriter writer,
            java.util.Locale locale)
     throws JSONException

        Adds the value to the specified JSONWriter.

        The caller must ensure that the cell value can be directly written using the corresponding JSONWriter.value(boolean) method. If the value is actually represented as a JS object, JSONWriter.object() resp. JSONWriter.array() must be able to be called.

        The specified Locale might be used for use formatting the value in a locale-specific way, for example for formatting dates and times.

        Parameters:
        writer - The JSON writer
        locale - The request's Locale
        Throws:
        JSONException - if writing the JSON representation failed

      • getString

        java.lang.String getString()
        Returns a "guaranteed" string representation of the value. This is used for creating lists, etc.
        Returns:
        The "guaranteed" string representation of the value