jet.formula

Class fRequest

java.lang.Object

jet.connect.DbValue

jet.formula.fRequest

public class fRequest
extends DbValue

Implementing the Request data type of formula

Field Summary

Fields inherited from class jet.connect.DbValue

BIGINT_DESC, bNull, CHAR_DESC, CURRENCY_DESC, DATE_DESC, desc, DOUBLE_DESC, INTEGER_DESC, TIME_DESC

Constructor Summary

Constructors

Constructor and Description
fRequest()
fRequest(DbColDesc dbColDesc)

Method Summary

Modifier and Type	Method and Description
DbChar	addHeaderProperty(DbChar key, DbChar value) Add a property to the request header
java.lang.Object	clone() Creates a clone of this DbValue variable.
int	compareTo(DbValue v, boolean matchSQL) Compares with the DbValue object.
boolean	equals(DbValue v) Determines if another DbValue object is of equal value as this DbValue Object.
fRequest	get()
fJsonObject	getBody()
DbChar	getHeaderProperty(DbChar key) Returns the value of header property with the name specified by key.
java.util.HashMap<java.lang.String,java.lang.String>	getHeaders()
int	getIndex()
DbChar	getMethod()
DbChar	getParameter(DbChar key) Retrieve parameter value of the URL
DbChar	getUrl()
java.lang.String	mime()
void	set(DbValue v) Sets the value with DbValue.
void	set(java.sql.ResultSet rs, int col) Sets the value with the result set value specified by column index.
fJsonObject	setBody(fJsonObject body)
void	setIndex(int index)
DbChar	setMethod(DbChar method) Specify the HTTP method of the request
DbChar	setParameter(DbChar key, DbChar value) Set or add a parameter to the query string of the URL
DbChar	setUrl(DbChar url) Specifies the URL of the request
void	setValue(java.lang.String v) Set the value with a string.
java.lang.String	toString() Converts the value to string.
java.lang.String	toStringValue()

Methods inherited from class jet.connect.DbValue

compareTo, compareTo, compareTo, equals, getColDesc, getDataTimeZone, getPrecision, getScale, getSqlType, isCurrency, isNull, makeDbValue, set, setColDesc, setfoo, setNull, setValue

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

fRequest

public fRequest()

fRequest

public fRequest(DbColDesc dbColDesc)

Method Detail

getBody

public fJsonObject getBody()

setBody

public fJsonObject setBody(fJsonObject body)

addHeaderProperty

public DbChar addHeaderProperty(DbChar key,
                                DbChar value)

Add a property to the request header

Parameters:

key - String, name of the property

value - String, value of the property

Returns:

the added property value

getHeaderProperty

public DbChar getHeaderProperty(DbChar key)

Returns the value of header property with the name specified by key.

Parameters:

key - the property name

Returns:

the property value. NULL if there doesn't exist any property with the name

getMethod

public DbChar getMethod()

Returns:

the HTTP method

setMethod

public DbChar setMethod(DbChar method)

Specify the HTTP method of the request

Parameters:

method - String

Returns:

the method

getUrl

public DbChar getUrl()

Returns:

URL of the request

setUrl

public DbChar setUrl(DbChar url)

Specifies the URL of the request

Parameters:

url -

Returns:

setParameter

public DbChar setParameter(DbChar key,
                           DbChar value)

Set or add a parameter to the query string of the URL

Parameters:

key - String name of the parameter

value - String value of the parameter

Returns:

getParameter

public DbChar getParameter(DbChar key)

Retrieve parameter value of the URL

Parameters:

key - String name of the parameter

Returns:

value of the parameter, NULL if name doesn't exist in the query string

getHeaders

public java.util.HashMap<java.lang.String,java.lang.String> getHeaders()

mime

public java.lang.String mime()

setIndex

public void setIndex(int index)

getIndex

public int getIndex()

get

public fRequest get()

Returns:

set

public void set(java.sql.ResultSet rs,
                int col)
         throws java.sql.SQLException

Description copied from class: DbValue

Sets the value with the result set value specified by column index.

Specified by:

set in class DbValue

Parameters:

rs - The source value result set.

col - The source value column number in the rs.

Throws:

java.sql.SQLException

set

public void set(DbValue v)

Description copied from class: DbValue

Sets the value with DbValue.

Specified by:

set in class DbValue

clone

public java.lang.Object clone()

Description copied from class: DbValue

Creates a clone of this DbValue variable.

Specified by:

clone in class DbValue

equals

public boolean equals(DbValue v)

Description copied from class: DbValue

Determines if another DbValue object is of equal value as this DbValue Object.

Specified by:

equals in class DbValue

setValue

public void setValue(java.lang.String v)

Description copied from class: DbValue

Set the value with a string.

Specified by:

setValue in class DbValue

compareTo

public int compareTo(DbValue v,
                     boolean matchSQL)

Description copied from class: DbValue

Compares with the DbValue object.

Specified by:

compareTo in class DbValue

Returns:

LESS, EQUAL, GREAT, or NULL.

See Also:

jet.util.DbValueable

toString

public java.lang.String toString()

Description copied from class: DbValue

Converts the value to string.

Specified by:

toString in class DbValue

toStringValue

public java.lang.String toStringValue()

Specified by:

toStringValue in class DbValue

Returns:

a string which will represent the value in the DbValue(null flag and value). When compare StringValue from DbValues, we always assume that: the two DbValues have same DbColDesc. Two StringValue equals means the original DbValue equals. Does NOT transfer the compareTo(DbValue v) method. Only comparable dbValue implements this methods. String coding uses Base64.