The IntervalYM Class

The com.informix.lang.IntervalYM class allows you to manipulate year-month intervals.

Using IntervalYM Constructors

The default constructor is defined as follows:

public IntervalYM() throws SQLException

Use this second version of the constructor to display localized error messages if an exception is thrown:

public IntervalYM(Connection conn) throws SQLException

Use the following constructors to create year-month intervals from specific input values:

• Two time stamps, returning the IntervalYM value that equals Timestamp1 - Timestamp2:

  public IntervalYM(Timestamp t1, Timestamp t2) throws
     SQLException
  public IntervalYM (Timestamp t1, Timestamp t2, Connection
     conn) throws SQLException

  The second version allows you to support localized error messages.

• Year and month values (large month values are converted to year):

  public IntervalYM(int years, int months) throws
     SQLException
  
  public IntervalYM(int years, int months,
     Connection conn) throws SQLException

  The second version allows you to support localized error messages.

• A month value and the encoded qualifier:

  public IntervalYM(int months, short qualifier, 
     Connection conn) throws SQLException

  To specify the qualifier, you can use the getQualifier() method described in Using Interval Methods. This constructor supports localized error messages.

• A string:

  public IntervalYM(String string) throws SQLException
  public IntervalYM(String string, Connection conn) throws
     SQLException

  The second version allows you to support localized error messages.

• A string and qualifier:

  public IntervalYM(String string, short qualifier,
     Connection conn) throws SQLException

  To specify the qualifier, you can use the getQualifier() method described in Using Interval Methods. This constructor supports localized error messages.

• A string and qualifier information:

  public IntervalYM(String string, int length, 
     byte startCode, byte endCode) throws SQLException
  
  public IntervalYM(String string, int length, 
     byte startCode, byte endCode, Connection conn) throws
     SQLException

  The second version allows you to support localized error messages.

Using IntervalYM Methods

The following methods allow you to manipulate year-month intervals. (You can also use the Interval methods, described previously.) Some of the tasks you can perform using IntervalYM methods include the following:

• Comparing two intervals:

  boolean equals(Object other)
  boolean greaterThan(IntervalYM other)
  boolean lessThan(IntervalYM other)

• Setting a value for an interval from:
  • A string:

    void fromString(String other)
    void set(String string)

  • Year and month values (large month values are converted to years):

    void set(int years, int months)

  • Two time stamps:

    void set(Timestamp t1, Timestamp t2)

• Setting the qualifier for an interval:
  • From the length, start code, and end code:

    void setQualifier(int length, byte startcode, byte
          endcode)

  • Using an existing qualifier:

    void setQualifier(short qualifier)

• Obtaining the number of months in the interval:

  long getMonths()

• Creating a string representation of the interval in the format yyyy-mm:

  String toString()

  The fields present depend on the qualifier. Blanks replace leading zeros.