com.simba.dsi.dataengine.utilities
Class ParameterInputValue

java.lang.Object
  extended by com.simba.dsi.dataengine.utilities.ParameterInputValue

public final class ParameterInputValue
extends java.lang.Object

ParameterInputValue is used to encapsulate an input parameter data value and associated metadata. The metadata for a ParameterInputValue may not match metadata provided in a call to IQueryExecutor.getMetadataForParameters().


Constructor Summary
ParameterInputValue(ParameterMetadata metadata, boolean isPushed, boolean isDefault, DataWrapper data)
          Constructor.
ParameterInputValue(ParameterMetadata metadata, boolean isPushed, DataWrapper data)
          Constructor.
ParameterInputValue(ParameterMetadata metadata, DataWrapper data)
          Constructor.
 
Method Summary
 DataWrapper getData()
          Returns the data to be used for the input parameter value.
 ParameterMetadata getMetadata()
          Returns metadata associated with the parameter.
 boolean isDefaultValue()
          Indicates if the input parameter value is to be considered "default".
 boolean isNull()
          Indicates if the input parameter value is considered to be "null".
 boolean isPushed()
          Indicates if the whole input parameter data value has already been pushed down using IQueryExecutor.pushParamData().
 void setIsDefaultValue(boolean isDefaultValue)
          Set if the input parameter value is to be considered "default".
 void setPushed(boolean isPushed)
          Set if the whole input parameter data value has already been pushed down using IQueryExecutor.pushParamData().
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ParameterInputValue

public ParameterInputValue(ParameterMetadata metadata,
                           boolean isPushed,
                           boolean isDefault,
                           DataWrapper data)
Constructor.

Parameters:
metadata - Input parameter metadata.
isPushed - Indicates if the input parameter value has already been pushed down.
isDefault - Indicates if the input parameter value should be considered "default".
data - Input parameter data. May be null if isPushed or isDefault is true.

ParameterInputValue

public ParameterInputValue(ParameterMetadata metadata,
                           boolean isPushed,
                           DataWrapper data)
Constructor.

Parameters:
metadata - Input parameter metadata.
isPushed - Indicates if the input parameter value has already been pushed down.
data - Input parameter data. May be null if isPushed is true.

ParameterInputValue

public ParameterInputValue(ParameterMetadata metadata,
                           DataWrapper data)
Constructor.

Parameters:
metadata - Input parameter metadata.
data - Input parameter data.
Method Detail

getData

public DataWrapper getData()
                    throws ParamAlreadyPushedException,
                           DefaultParamException
Returns the data to be used for the input parameter value. Throws an exception if isPushed() or isDefaultValue() returns true.

Returns:
Input data value.
Throws:
ParamAlreadyPushedException - If the parameter has already been pushed down.
DefaultParamException - If the parameter is a default parameter.

getMetadata

public ParameterMetadata getMetadata()
Returns metadata associated with the parameter.

Returns:
Parameter metadata.

isDefaultValue

public boolean isDefaultValue()
Indicates if the input parameter value is to be considered "default".

Returns:
Default input value indicator.

isNull

public boolean isNull()
Indicates if the input parameter value is considered to be "null". This is the same as calling getData().isNull().

Returns:
true if null; false otherwise.

isPushed

public boolean isPushed()
Indicates if the whole input parameter data value has already been pushed down using IQueryExecutor.pushParamData(). This method may only return true during a call to IQueryExecutor.execute().

Returns:
Indicator of whether the value has already been pushed down or not.

setIsDefaultValue

public void setIsDefaultValue(boolean isDefaultValue)
Set if the input parameter value is to be considered "default".

Parameters:
isDefaultValue - Default input value indicator.

setPushed

public void setPushed(boolean isPushed)
Set if the whole input parameter data value has already been pushed down using IQueryExecutor.pushParamData().

Parameters:
isPushed - Indicator of whether the value has already been pushed down or not.


Copyright © 2006-2014 Simba Technologies Incorporated. All Rights Reserved.