com.day.cq.reporting
Interface CellValue

All Superinterfaces:
Comparable<CellValue>

public interface CellValue
extends Comparable<CellValue>

Interface that defines a cell value.


Method Summary
 Value getJCRValue(Session session)
          Gets a JCR compatible Value object for the represented cell value.
 String getString()
          Returns a "guaranteed" string representation of the value.
 void toJSON(JSONWriter writer, Locale locale)
          Adds the value to the specified JSONWriter.
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getJCRValue

Value getJCRValue(Session session)
                  throws 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:
RepositoryException - if no suitable Value object could be created

toJSON

void toJSON(JSONWriter writer,
            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

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


Copyright © 2011-2013 Adobe Systems Incorporated. All Rights Reserved.