Project: stp

com.ibm.rational.wvcm.stp.cq
Class CqQuery.ChartOptionsClass

Object
  extended by CqQuery.ChartOptionsClass
All Implemented Interfaces:
CqQuery.ChartOptions, CqQuery.CommonOptions
Enclosing interface:
CqQuery

public static class CqQuery.ChartOptionsClass
extends Object
implements CqQuery.ChartOptions

Instances of this class provide the default values for each attribute specified by the ChartOptions interface, which is the same behavior exhibited when using null for a ChartOptions object. Clients can provide non-default attribute values by defining and instantiating a subclass of this class that overrides select methods to provide the desired non-default value.

Using a class instance creation expression, for example, one could define a ChartOptions object for requesting a row limit of 10000 as follows...

     ChartOptions TEN_THOUSAND_ROWS = new ChartOptionsClass(){
         public Long getRowNumberLimit() { return 10000; };
     };
 


Nested Class Summary
 
Nested classes/interfaces inherited from interface CqQuery.ChartOptions
CqQuery.ChartOptions.ImageFormat
 
Constructor Summary
CqQuery.ChartOptionsClass()
           
 
Method Summary
 Long getHeight()
          Returns the requested height of the chart image in pixels.
 CqQuery.ChartOptions.ImageFormat getImageFormat()
          Returns the compression format requested for the chart image.
 Boolean getIsCompressionOptimized()
          Returns whether or not the compression of the image should be optimized.
 Boolean getIsGreyScale()
          Returns whether the chart image is to be rendered in grey scale or color.
 Boolean getIsInterlaced()
          Returns whether or not a PNG image should be interlaced.
 Boolean getIsProgressive()
          Returns whether or not a JPEG image is to use progressive compression.
 Integer getQuality()
          Returns the requested quality of JPEG compression, expressed as an integer between 1 (maximum compression) and 100 (maximum fidelity).
 PropertyRequestItem.PropertyRequest getQueryPropertyRequest()
           
 Long getRowNumberLimit()
           
 Long getWidth()
          Returns the requested width of the chart image.
 
Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CqQuery.ChartOptionsClass

public CqQuery.ChartOptionsClass()
Method Detail

getHeight

public Long getHeight()
Description copied from interface: CqQuery.ChartOptions
Returns the requested height of the chart image in pixels.

Specified by:
getHeight in interface CqQuery.ChartOptions
Returns:
The height of the image in pixels.

getImageFormat

public CqQuery.ChartOptions.ImageFormat getImageFormat()
Description copied from interface: CqQuery.ChartOptions
Returns the compression format requested for the chart image.

Specified by:
getImageFormat in interface CqQuery.ChartOptions
Returns:
An ImageFormat enumerator specifying whether the generated chart image should use JPEG or PNG compression format.

getIsCompressionOptimized

public Boolean getIsCompressionOptimized()
Description copied from interface: CqQuery.ChartOptions
Returns whether or not the compression of the image should be optimized.

Specified by:
getIsCompressionOptimized in interface CqQuery.ChartOptions
Returns:
true if the compression is to be optimized.

getIsGreyScale

public Boolean getIsGreyScale()
Description copied from interface: CqQuery.ChartOptions
Returns whether the chart image is to be rendered in grey scale or color.

Specified by:
getIsGreyScale in interface CqQuery.ChartOptions
Returns:
If true, the chart image will be in grey scale, not color.

getIsInterlaced

public Boolean getIsInterlaced()
Description copied from interface: CqQuery.ChartOptions
Returns whether or not a PNG image should be interlaced.

Specified by:
getIsInterlaced in interface CqQuery.ChartOptions
Returns:
If true, a PNG image will be interlaced.

getIsProgressive

public Boolean getIsProgressive()
Description copied from interface: CqQuery.ChartOptions
Returns whether or not a JPEG image is to use progressive compression.

Specified by:
getIsProgressive in interface CqQuery.ChartOptions
Returns:
If true, progressive compression will be used in the JPEG format.

getQuality

public Integer getQuality()
Description copied from interface: CqQuery.ChartOptions
Returns the requested quality of JPEG compression, expressed as an integer between 1 (maximum compression) and 100 (maximum fidelity).

Specified by:
getQuality in interface CqQuery.ChartOptions
Returns:
An Integer between 1 and 100.

getQueryPropertyRequest

public PropertyRequestItem.PropertyRequest getQueryPropertyRequest()
Specified by:
getQueryPropertyRequest in interface CqQuery.CommonOptions
Returns:
The properties of the query being executed that should be retrieved and returned with the result set. If null, CqResultSet().getQuery will return null; otherwise it will return a CqQuery proxy populated with the properties requested.
See Also:
CqResultSet.getQuery()

getRowNumberLimit

public Long getRowNumberLimit()
Specified by:
getRowNumberLimit in interface CqQuery.CommonOptions
Returns:
The largest row number that the query may return. This is the maximum number of rows allowed in the result set only if the targetRow parameter is 1. In general, the maximum number of rows returned by an execution of the query will be the smallest of
  • the maxRows parameter,
  • the value of 1+getRowNumberLimit()-targetRow, and
  • 1+CqResultSet.getRowNumberHardLimit()-targetRows
. If null, the value of CqResultSet.getRowNumberSoftLimit() will be used.
See Also:
CqResultSet.getRowNumberHardLimit(), CqResultSet.getRowNumberSoftLimit(), CqResultSet.isRowNumberLimitExceeded()

getWidth

public Long getWidth()
Description copied from interface: CqQuery.ChartOptions
Returns the requested width of the chart image.

Specified by:
getWidth in interface CqQuery.ChartOptions
Returns:
An Long specifying the requested width of the chart image in pixels.

Generated Fri 20-Feb-2015 11:07 PM

Copyright © IBM 2015. All rights reserved.