Top Description Fields Constructors Methods
org.h2.expression

public Class ParameterRemote

extends Object
implements ParameterInterface
Class Inheritance
All Implemented Interfaces
org.h2.expression.ParameterInterface
Imports
java.io.IOException, java.sql.ResultSetMetaData, org.h2.api.ErrorCode, org.h2.message.DbException, org.h2.value.Transfer, .TypeInfo, .Value, .ValueLob

A client side (remote) parameter.

Field Summary

Modifier and TypeField and Description
private final int
private int
private TypeInfo
private Value

Constructor Summary

AccessConstructor and Description
public
ParameterRemote(int index)

Method Summary

Modifier and TypeMethod and Description
public void
checkSet()

Implements org.h2.expression.ParameterInterface.checkSet.

Check if the value is set.

public int
getNullable()

Implements org.h2.expression.ParameterInterface.getNullable.

Check if this column is nullable.

public Value
getParamValue()

Implements org.h2.expression.ParameterInterface.getParamValue.

Get the value of the parameter if set.

public TypeInfo
getType()

Implements org.h2.expression.ParameterInterface.getType.

Returns the expected data type if no value is set, or the data type of the value if one is set.

public boolean
isValueSet()

Implements org.h2.expression.ParameterInterface.isValueSet.

Is the value of a parameter set.

public void
readMetaData(Transfer
the transfer object
transfer
)

Read the parameter meta data from the transfer object.

public void
setValue(Value
the new value
newValue
,
boolean
if the old value (if one is set) should be closed
closeOld
)

Implements org.h2.expression.ParameterInterface.setValue.

Set the value of the parameter.

public static void
writeMetaData(Transfer
the transfer object
transfer
,
ParameterInterface
the parameter
p
)

Write the parameter meta data to the transfer object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

indexback to summary
private final int index
nullableback to summary
private int nullable
typeback to summary
private TypeInfo type
valueback to summary
private Value value

Constructor Detail

ParameterRemoteback to summary
public ParameterRemote(int index)

Method Detail

checkSetback to summary
public void checkSet()

Implements org.h2.expression.ParameterInterface.checkSet.

Doc from org.h2.expression.ParameterInterface.checkSet.

Check if the value is set.

Annotations
@Override
getNullableback to summary
public int getNullable()

Implements org.h2.expression.ParameterInterface.getNullable.

Doc from org.h2.expression.ParameterInterface.getNullable.

Check if this column is nullable.

Returns:int

Column.NULLABLE_*

Annotations
@Override
getParamValueback to summary
public Value getParamValue()

Implements org.h2.expression.ParameterInterface.getParamValue.

Doc from org.h2.expression.ParameterInterface.getParamValue.

Get the value of the parameter if set.

Returns:Value

the value or null

Annotations
@Override
getTypeback to summary
public TypeInfo getType()

Implements org.h2.expression.ParameterInterface.getType.

Doc from org.h2.expression.ParameterInterface.getType.

Returns the expected data type if no value is set, or the data type of the value if one is set.

Returns:TypeInfo

the data type

Annotations
@Override
isValueSetback to summary
public boolean isValueSet()

Implements org.h2.expression.ParameterInterface.isValueSet.

Doc from org.h2.expression.ParameterInterface.isValueSet.

Is the value of a parameter set.

Returns:boolean

true if set

Annotations
@Override
readMetaDataback to summary
public void readMetaData(Transfer transfer) throws IOException

Read the parameter meta data from the transfer object.

Parameters
transfer:Transfer

the transfer object

Exceptions
IOException:
on failure
setValueback to summary
public void setValue(Value newValue, boolean closeOld)

Implements org.h2.expression.ParameterInterface.setValue.

Doc from org.h2.expression.ParameterInterface.setValue.

Set the value of the parameter.

Parameters
newValue:Value

the new value

closeOld:boolean

if the old value (if one is set) should be closed

Annotations
@Override
writeMetaDataback to summary
public static void writeMetaData(Transfer transfer, ParameterInterface p) throws IOException

Write the parameter meta data to the transfer object.

Parameters
transfer:Transfer

the transfer object

p:ParameterInterface

the parameter

Exceptions
IOException:
on failure