com.inet.viewer

Class RangePromptValue

java.lang.Object

com.inet.viewer.PromptValue

com.inet.viewer.RangePromptValue

All Implemented Interfaces:

java.io.Serializable

@JsonData
public class RangePromptValue
extends PromptValue

This class represents a range prompt value with one or two limits, each of which can be set to be included in the range or to be excluded from the range.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.inet.viewer.PromptValue

DATEFORMAT, DATETIMEFORMAT, DATETIME_FOUR_DIGIT_YEAR_NO_SECONDS, DATETIME_FOUR_DIGIT_YEAR_WITH_SECONDS, NUMBERFORMAT, TIMEFORMAT

Constructor Summary

Constructors

Constructor and Description
RangePromptValue(Range range, int type) Constructor using a Range object

Method Summary

Modifier and Type	Method and Description
com.inet.viewer.SinglePromptValue	getEndValue() Returns the upper limit to the range, or null if there is no upper limit
java.lang.Object	getSQLTypedValue() not implemented yet.
com.inet.viewer.SinglePromptValue	getStartValue() Returns the lower limit to the range, or null if there is no lower limit
java.lang.String	getStringRepresentation() Returns a string representation of the value of this prompt.
java.lang.Object	getValue() Returns the value of this prompt - its type will depend on which value type this PromptValue has: String for STRING Double for NUMBER and CURRENCY Boolean for BOOLEAN Date for DATE and DATETIME Time for TIME byte[] for BINARY
boolean	isIncludeHigh() Returns whether the upper limit is included in the range
boolean	isIncludeLow() Returns whether the lower limit is included in the range
void	setEndValue(com.inet.viewer.SinglePromptValue endValue) Sets the Upper limit to the range, or null if there is no upper limit
void	setIncludeHigh(boolean includeHigh) Sets whether the upper limit is included in the range
void	setIncludeLow(boolean includeLow) Sets whether the lower limit is included in the range
void	setStartValue(com.inet.viewer.SinglePromptValue startValue) Sets the Upper limit to the range, or null if there is no upper limit

Methods inherited from class com.inet.viewer.PromptValue

getDescription, getType, isOnlyDescription, setDescription, setOnlyDescription, toString

Constructor Detail

RangePromptValue

public RangePromptValue(Range range,
                        int type)

Constructor using a Range object

Parameters:

range - Range object to use to create a RangePromptValue based on the given range

type - value type of the range

Method Detail

isIncludeHigh

public final boolean isIncludeHigh()

Returns whether the upper limit is included in the range

Returns:

Is the upper limit included in the range?

setIncludeHigh

public final void setIncludeHigh(boolean includeHigh)

Sets whether the upper limit is included in the range

Parameters:

includeHigh - the endvalue.

isIncludeLow

public final boolean isIncludeLow()

Returns whether the lower limit is included in the range

Returns:

Is the lower limit included in the range?

setIncludeLow

public final void setIncludeLow(boolean includeLow)

Sets whether the lower limit is included in the range

Parameters:

includeLow - include the start value.

getEndValue

public com.inet.viewer.SinglePromptValue getEndValue()

Returns the upper limit to the range, or null if there is no upper limit

Returns:

Upper limit to the range, or null if there is no upper limit

setEndValue

public void setEndValue(com.inet.viewer.SinglePromptValue endValue)

Sets the Upper limit to the range, or null if there is no upper limit

Parameters:

endValue - Upper limit to the range, or null if there is no upper limit

getStartValue

public com.inet.viewer.SinglePromptValue getStartValue()

Returns the lower limit to the range, or null if there is no lower limit

Returns:

Lower limit to the range, or null if there is no lower limit

setStartValue

public void setStartValue(com.inet.viewer.SinglePromptValue startValue)

Sets the Upper limit to the range, or null if there is no upper limit

Parameters:

startValue - Upper limit to the range, or null if there is no upper limit

getValue

public java.lang.Object getValue()

Returns the value of this prompt - its type will depend on which value type this PromptValue has: String for STRING
Double for NUMBER and CURRENCY
Boolean for BOOLEAN
Date for DATE and DATETIME
Time for TIME
byte[] for BINARY

Specified by:

getValue in class PromptValue

Returns:

the value of this prompt - its type will depend on which value type this PromptValue has.

getStringRepresentation

public java.lang.String getStringRepresentation()

Returns a string representation of the value of this prompt. Returns the i-net Clear Reports formula syntax representation of this range.

Specified by:

getStringRepresentation in class PromptValue

Returns:

a string representation of the value of this prompt.

See Also:

PromptValue.getStringRepresentation()

getSQLTypedValue

public java.lang.Object getSQLTypedValue()

not implemented yet.

Specified by:

getSQLTypedValue in class PromptValue

Returns:

the value object.