com.google.visualization.datasource.base
Class DataSourceParameters

java.lang.Object
  extended by com.google.visualization.datasource.base.DataSourceParameters

public class DataSourceParameters
extends java.lang.Object

This class contains the data source parameters of the request. The data source parameters are extracted from the "tqx" URL parameter.

Author:
Nimrod T.

Constructor Summary
DataSourceParameters(java.lang.String tqxValue)
          Constructs a new instance of this class, with the given "tqx" string and parses it.
 
Method Summary
static DataSourceParameters getDefaultDataSourceParameters()
          Returns a default DataSourceParameters object.
 java.lang.String getOutFileName()
          Returns the out file name.
 OutputType getOutputType()
          Returns the output type.
 java.lang.String getRequestId()
          Returns the request id.
 java.lang.String getResponseHandler()
          Returns the response handler.
 java.lang.String getSignature()
          Returns the signature.
 java.lang.String getTqxValue()
          Returns the "tqx" value.
 void setOutputType(OutputType outputType)
          Sets the output type.
 void setSignature(java.lang.String signature)
          Sets the signature.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DataSourceParameters

public DataSourceParameters(java.lang.String tqxValue)
                     throws DataSourceException
Constructs a new instance of this class, with the given "tqx" string and parses it. Note: the "tqx" parameter is generated internally by the client side libraries. Thus, both the user and the developer will receive only short error messages regarding it. E.g., "Internal Error (code)".

Parameters:
tqxValue - The "tqx" string to parse.
Throws:
DataSourceException - Thrown if parsing of request parameters fails.
Method Detail

getDefaultDataSourceParameters

public static DataSourceParameters getDefaultDataSourceParameters()
Returns a default DataSourceParameters object.

Returns:
A default DataSourceParameters object.

getRequestId

public java.lang.String getRequestId()
Returns the request id.

Returns:
The request id.

getSignature

public java.lang.String getSignature()
Returns the signature.

Returns:
The signature.

setSignature

public void setSignature(java.lang.String signature)
Sets the signature.

Parameters:
signature - The signature.

getOutputType

public OutputType getOutputType()
Returns the output type.

Returns:
The output type.

setOutputType

public void setOutputType(OutputType outputType)
Sets the output type.

Parameters:
outputType - The output type.

getResponseHandler

public java.lang.String getResponseHandler()
Returns the response handler.

Returns:
The response handler.

getOutFileName

public java.lang.String getOutFileName()
Returns the out file name.

Returns:
The out file name.

getTqxValue

public java.lang.String getTqxValue()
Returns the "tqx" value.

Returns:
The "tqx" value.


Copyright © 2009 Google. All Rights Reserved.