Class DBI::Timestamp
In: lib/dbi/utils/timestamp.rb
Parent: Object

Represents a Timestamp.

DEPRECATED: Please use a regular DateTime object.

Methods

==   fraction   new   to_date   to_s   to_time  

Included Modules

Deprecated

External Aliases

month -> mon
  Aliases
month= -> mon=
day -> mday
day= -> mday=
minute -> min
minute= -> min=
second -> sec
second= -> sec=

Attributes

day  [RW] 
fraction  [W] 
hour  [RW] 
minute  [RW] 
month  [RW] 
second  [RW] 
year  [RW] 

Public Class methods

new(year=0, month=0, day=0, hour=0, min=0, sec=0, fraction=nil)

DBI::Timestamp(year=0,month=0,day=0,hour=0,min=0,sec=0,fraction=nil) DBI::Timestamp(Time) DBI::Timestamp(Date)

Creates and returns a new DBI::Timestamp object. This is similar to a Time object in the standard library, but it also contains fractional seconds, expressed in nanoseconds. In addition, the constructor accepts either a Date or Time object.

[Source]

# File lib/dbi/utils/timestamp.rb, line 23
      def initialize(year=0, month=0, day=0, hour=0, min=0, sec=0, fraction=nil)
         case year
            when ::Time
               @year, @month, @day = year.year, year.month, year.day 
               @hour, @minute, @second, @fraction = year.hour, year.min, year.sec, nil 
               @original_time = year
            when ::Date
               @year, @month, @day = year.year, year.month, year.day 
               @hour, @minute, @second, @fraction = 0, 0, 0, nil 
               @original_date = year
            else
               @year, @month, @day = year, month, day
               @hour, @minute, @second, @fraction = hour, min, sec, fraction
         end
      end

Public Instance methods

==(timestamp)

Returns true if timestamp has a year, month, day, hour, minute, second and fraction equal to the comparing object.

Returns false if the comparison fails for any reason.

[Source]

# File lib/dbi/utils/timestamp.rb, line 47
      def ==(timestamp)
         @year == timestamp.year and @month == timestamp.month and
         @day == timestamp.day and @hour == timestamp.hour and
         @minute == timestamp.minute and @second == timestamp.second and
         (fraction() == timestamp.fraction)
      rescue
         false
      end
fraction()

Returns fractional seconds, or 0 if not set.

[Source]

# File lib/dbi/utils/timestamp.rb, line 57
      def fraction
         @fraction || 0
      end
to_date()

Returns a new Date object based on the year, month and day or, if a Date object was passed to the constructor, returns that object.

[Source]

# File lib/dbi/utils/timestamp.rb, line 94
      def to_date
         @original_date || ::Date.new(@year, @month, @day)
      end
to_s()

Returns a DBI::Timestamp object as a string in YYYY-MM-DD HH:MM:SS format. If a fraction is present, then it is appended in ".FF" format.

[Source]

# File lib/dbi/utils/timestamp.rb, line 73
      def to_s
         string = sprintf("%04d-%02d-%02d %02d:%02d:%02d",
             @year, @month, @day, @hour, @minute, @second) 

         if @fraction
            fraction = ("%.9f" % (@fraction.to_i / 1e9)).
                        to_s[1..-1].gsub(/0{1,8}$/, "")
            string += fraction
         end

         string
      end
to_time()

Returns a new Time object based on the year, month and day or, if a Time object was passed to the constructor, returns that object.

[Source]

# File lib/dbi/utils/timestamp.rb, line 88
      def to_time
         @original_time || ::Time.local(@year, @month, @day, @hour, @minute, @second)
      end

[Validate]