IntervalYM Class

IntervalYM supports the SQL92 datatype Year-Month Interval.

Leading field precision will be determined by number of decimal digits on input.

IntervalYM(
   const Environment *env,
   int year = 0,
   int month=0);

The following code example demonstrates that the default constructor creates a NULL value, and how you can assign a non NULL value to a year-month interval and then perform operations on it:

Environment *env = Environment::createEnvironment();

// Create a NULL year-month interval
IntervalYM ym
if(ym.isNull())
   cout << "\n ym is null";

// Assign a non-NULL value to ym
Interval UM anotherYM(env, "10-30");
ym=anotherYM;

// Now all operations on YM are valid
int yr = ym.getYear();

The following code example demonstrates how to get the year-month interval column from a result set, add to the year-month interval by using the += operator, multiply by using the * operator, compare 2 year-month intervals, and convert a year-month interval to a string by using the toText method:

//SELECT WARRANT_PERIOD from PRODUCT_INFORMATION
//obtain result set
resultset->next();

//get interval value from resultset
IntervalYM ym1 = resultset->getIntervalYM(1);

IntervalYM addWith(env, 10, 1);
ym1 += addWith;    //call += operator

IntervalYM mulYm1 = ym1 * Number(env, 10);    //call * operator
if(ym1<mulYm1)    //comparison
   .
   .
string strym = ym1.toText(3);    //3 is the leading field precision

IntervalYM()

IntervalYM class constructor.

IntervalYM();

IntervalDS(
   const IntervalYM &src);

scp

fromText()

This method initializes the interval to the values in inpstr. The string is interpreted using the nls parameters set in the environment.

The nls parameters are picked up from env. If env is NULL, the nls parameters are picked up from the environment associated with the instance, if any.

void fromText(
   const string &inpStr,
   const string &nlsParam = "",
   const Environment *env = NULL);

inpStr

nlsParam

env

getMonth()

This method returns the month component of the interval.

int getMonth() const;

getYear()

This method returns the year component of the interval.

int getYear() const;

isNull()

This method tests whether the interval is NULL. If the interval is NULL then TRUE is returned; otherwise, FALSE is returned.

bool isNull() const;

operator*()

This method multiplies the interval by a factor and returns the result.

const IntervalYM operator*(
   const IntervalDS &interval
   const Number &value);

interval

val

operator*=()

This method multiplies the interval by a specified value.

Syntax

IntervalYM& operator*=(
   const Number &val);

val

operator=()

This method assigns the specified value to the interval.

const IntervalYM& operator=(
   const IntervalYM &val);

val

operator==()

This method compares the intervals specified. If the intervals are equal then TRUE is returned; otherwise, FALSE is returned. If either interval is NULL then SQLException is thrown.

bool operator==(
   const IntervalYM &first,
   const IntervalYM &second);

first

second

operator!=()

This method compares the intervals specified. If the intervals are not equal then TRUE is returned; otherwise, FALSE is returned. If either interval is NULL then SQLException is thrown.

bool operator!=(
   const IntervalYM &first,
   const IntervalYM &second);

first

second

operator/()

This method returns the result of dividing the interval by a factor.

const IntervalYM operator/(
   const IntervalYM &dividend,
   const Number &factor);

dividend

factor

operator/=()

This method divides the interval by a factor.

IntervalYM& operator/=(
   const Number &val);

val

operator>()

This method compares the intervals specified. If the first interval is greater than the second interval then TRUE is returned; otherwise, FALSE is returned. If either interval is NULL then SQLException is thrown.

bool operator>(
   const IntervalYM &first,
   const IntervalYM &second);

first

second

operator>=()

This method compares the intervals specified. If the first interval is greater than or equal to the second interval then TRUE is returned; otherwise, FALSE is returned. If either interval is NULL then SQLException is thrown.

bool operator>=(
   const IntervalYM &first,
   const IntervalYM &second);

first

second

operator<()

This method compares the intervals specified. If the first interval is less than the second interval then TRUE is returned; otherwise, FALSE is returned. If either interval is NULL then SQLException is thrown.

bool operator<(
   const IntervalYM &first,
   const IntervalYM &second);

first

second

operator<=()

This method compares the intervals specified. If the first interval is less than or equal to the second interval then TRUE is returned; otherwise, FALSE is returned. If either interval is NULL then SQLException is thrown

bool operator<=(
   const IntervalYM &first,
   const IntervalYM &second);

first

second

operator-()

This method returns the difference between the intervals specified.

const IntervalYM operator-(
   const IntervalYM &first,
   const IntervalYM &second);

first

second

operator-=()

This method computes the difference between itself and another interval.

IntervalYM& operator-=(
   const IntervalYM &val);

val

operator+()

This method returns the sum of the intervals specified.

const IntervalYM operator+(
   const IntervalYM &first,
   const IntervalYM &second);

first

second

operator+=()

This method assigns the sum of IntervalYM and val to IntervalYM.

IntervalYM& operator+=(
   const IntervalYM &val);

val

set()

This method sets the interval to the values specified.

void set(
   int year,
   int month);

year

month

setNull()

This method sets the interval to NULL.

void setNull();

toText()

This method returns the string representation of the interval.

string toText(
   unsigned int lfPrec,
   const string &nlsParam = "") const;

lfPrec

nlsParam